Public API (/v1)

List eSIMs

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
Response
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#

All parameters are optional.

Parameter	Type	Description
`country`	string	Country code (ISO 3166-1 alpha-2, e.g. JP)
`days`	integer	Exact validity in days
`minDays`	integer	Minimum validity (days)
`maxDays`	integer	Maximum validity (days)
`dataGb`	number	Minimum data (GB)
`unlimited`	boolean	true = unlimited plans only
`sort`	string	recommended (default) \| price (lowest first) \| data (most data first)
`limit`	integer	1–50, default 10
`offset`	integer	Items to skip — rounded down to a multiple of limit
`lang`	string	Response language: ko \| en \| ja \| zh-CN \| zh-TW (default en)

Filter rules#

days overrides minDays and maxDays.
unlimited=true ignores dataGb.
Results include only products sold directly by esimoa; discontinued products are excluded.

Response#

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#

Field	Type	Description
`id`	string	Product ID — use with the detail endpoint
`title`	string	Display name (in lang)
`countryCode / countryName`	string \| null	Primary country (null for multi-country plans)
`coverageCountries`	string[]	Country codes the eSIM works in
`isMultiCountry`	boolean	Multi-country plan
`dataAmount / dataAmountGB`	string / number	Data allowance (label / GB number)
`isUnlimited`	boolean	Unlimited plan
`dataType`	'total' \| 'daily' \| null	Total allowance or daily allowance
`validityDays`	integer	Validity in days
`priceKrw / currency`	integer / 'KRW'	Price in KRW
`provider / networkType`	string	Provider / network (e.g. 5G)
`hotspot / hasLocalNumber / isLocalNetwork`	boolean	Tethering / local phone number / local network
`url`	string	Purchase link carrying your partner code (?ref=). Show it as-is.

Note

Fields are only ever added — names and meanings never change. Parse responses so that unknown fields are ignored.