API pública (/v1)

Listar eSIM

GET /v1/esims — search eSIMs by country, duration and data, and get purchase URLs that carry your partner code.

On this page

Request
Query parameters
Filter rules
Respuesta
The Esim object

Request#

GET/v1/esims

curl "https://api.esimoa.com/v1/esims?country=JP&days=7&sort=price&limit=3&lang=en" \
  -H "X-API-Key: esk_live_your_key_here"

const res = await fetch(
  'https://api.esimoa.com/v1/esims?country=JP&days=7&sort=price&limit=3&lang=en',
  { headers: { 'X-API-Key': process.env.ESIMOA_API_KEY } },
);
if (!res.ok) throw new Error(`esimoa API ${res.status}`);

const { items, total } = await res.json();
for (const esim of items) {
  console.log(esim.title, esim.priceKrw, esim.url);
}

import os
import requests

res = requests.get(
    "https://api.esimoa.com/v1/esims",
    params={"country": "JP", "days": 7, "sort": "price", "limit": 3, "lang": "en"},
    headers={"X-API-Key": os.environ["ESIMOA_API_KEY"]},
    timeout=10,
)
res.raise_for_status()

for esim in res.json()["items"]:
    print(esim["title"], esim["priceKrw"], esim["url"])

Query parameters#

Todos los parámetros son opcionales.

Parámetro	Tipo	Descripción
`country`	string	Código de país (ISO 3166-1 alpha-2, p. ej., JP)
`days`	integer	Validez exacta en días
`minDays`	integer	Validez mínima (días)
`maxDays`	integer	Validez máxima (días)
`dataGb`	number	Datos mínimos (GB)
`unlimited`	boolean	true = solo planes ilimitados
`sort`	string	recommended (predeterminado) \| price (más barato primero) \| data (más datos primero)
`limit`	integer	1–50, por defecto 10
`offset`	integer	Elementos que se omiten: se redondea a la baja a un múltiplo de limit
`lang`	string	Idioma de la respuesta: ko \| en \| ja \| zh-CN \| zh-TW (en por defecto)

Filter rules#

days anula minDays y maxDays.
unlimited=true ignora dataGb.
Los resultados solo incluyen productos vendidos directamente por esimoa; se excluyen los productos descatalogados.

Respuesta#

200 OKjson

{
  "success": true,
  "items": [
    {
      "id": "partner_9VKPYQ3JRYVK5797",
      "title": "Japan · 100 MB · 7 days",
      "countryCode": "JP",
      "countryName": "Japan",
      "coverageCountries": ["JP"],
      "isMultiCountry": false,
      "dataAmount": "100 MB",
      "dataAmountGB": 0.1,
      "isUnlimited": false,
      "dataType": "total",
      "validityDays": 7,
      "priceKrw": 1000,
      "currency": "KRW",
      "provider": "TSIM",
      "networkType": "5G",
      "hotspot": true,
      "hasLocalNumber": false,
      "isLocalNetwork": true,
      "url": "https://www.esimoa.com/en/plans/jp/partner_9VKPYQ3JRYVK5797?ref=p_yourcode&utm_source=esimoa_partner"
    }
  ],
  "total": 42,
  "limit": 10,
  "offset": 0,
  "sort": "price"
}

The Esim object#

Campo	Tipo	Descripción
`id`	string	ID del producto: úsalo con el endpoint de detalle
`title`	string	Nombre visible (en lang)
`countryCode / countryName`	string \| null	País principal (null en planes multipaís)
`coverageCountries`	string[]	Códigos de los países donde funciona la eSIM
`isMultiCountry`	boolean	Plan multipaís
`dataAmount / dataAmountGB`	string / number	Datos incluidos (etiqueta / número en GB)
`isUnlimited`	boolean	Plan ilimitado
`dataType`	'total' \| 'daily' \| null	Cantidad total o cantidad diaria
`validityDays`	integer	Validez en días
`priceKrw / currency`	integer / 'KRW'	Precio en KRW
`provider / networkType`	string	Proveedor / red (p. ej., 5G)
`hotspot / hasLocalNumber / isLocalNetwork`	boolean	Tethering / número local / red local
`url`	string	Enlace de compra con tu código de socio (?ref=). Muéstralo tal cual.

Nota

Los campos solo se añaden: sus nombres y significados nunca cambian. Analiza las respuestas de forma que se ignoren los campos desconocidos.