公开 API（/v1）

搜索 eSIM

GET /v1/esims — 按国家、天数与流量搜索 eSIM，并获取带有合作伙伴代码的购买链接。

本页内容

请求
查询参数
筛选规则
响应
Esim 对象

请求#

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"])

查询参数#

所有参数均为可选。

参数	类型	说明
`country`	string	国家代码（ISO 3166-1 alpha-2，如 JP）
`days`	integer	有效天数完全等于该值
`minDays`	integer	最短有效天数
`maxDays`	integer	最长有效天数
`dataGb`	number	最少流量（GB）
`unlimited`	boolean	true 时仅返回无限流量套餐
`sort`	string	recommended（推荐，默认）\| price（最低价）\| data（流量最多）
`limit`	integer	1–50，默认 10
`offset`	integer	跳过的数量 — 向下取整为 limit 的倍数
`lang`	string	响应语言 ko \| en \| ja \| zh-CN \| zh-TW（默认 en）

筛选规则#

days 会覆盖 minDays 与 maxDays。
unlimited=true 时会忽略 dataGb。
结果仅包含 esimoa 直接销售的商品，已停售的商品会被排除。

响应#

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"
}

Esim 对象#

字段	类型	说明
`id`	string	商品 ID — 用于查询详情
`title`	string	展示名称（按 lang）
`countryCode / countryName`	string \| null	主要国家（多国套餐为 null）
`coverageCountries`	string[]	可用国家代码列表
`isMultiCountry`	boolean	是否多国套餐
`dataAmount / dataAmountGB`	string / number	流量（显示文本 / GB 数值）
`isUnlimited`	boolean	是否无限流量
`dataType`	'total' \| 'daily' \| null	总量型 / 每日型
`validityDays`	integer	有效天数
`priceKrw / currency`	integer / 'KRW'	售价（韩元）
`provider / networkType`	string	供应商 / 网络（如 5G）
`hotspot / hasLocalNumber / isLocalNetwork`	boolean	热点共享 / 提供当地号码 / 当地网络
`url`	string	购买链接，已带有您的合作伙伴代码（?ref=），请原样展示。

注意

字段只会新增，名称与含义不会改变。解析时请忽略未知字段。

公开 API（/v1）

搜索 eSIM

GET /v1/esims — 按国家、天数与流量搜索 eSIM，并获取带有合作伙伴代码的购买链接。

本页内容

请求
查询参数
筛选规则
响应
Esim 对象

请求#

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"])

查询参数#

所有参数均为可选。

参数	类型	说明
`country`	string	国家代码（ISO 3166-1 alpha-2，如 JP）
`days`	integer	有效天数完全等于该值
`minDays`	integer	最短有效天数
`maxDays`	integer	最长有效天数
`dataGb`	number	最少流量（GB）
`unlimited`	boolean	true 时仅返回无限流量套餐
`sort`	string	recommended（推荐，默认）\| price（最低价）\| data（流量最多）
`limit`	integer	1–50，默认 10
`offset`	integer	跳过的数量 — 向下取整为 limit 的倍数
`lang`	string	响应语言 ko \| en \| ja \| zh-CN \| zh-TW（默认 en）

筛选规则#

days 会覆盖 minDays 与 maxDays。
unlimited=true 时会忽略 dataGb。
结果仅包含 esimoa 直接销售的商品，已停售的商品会被排除。

响应#

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"
}

Esim 对象#

字段	类型	说明
`id`	string	商品 ID — 用于查询详情
`title`	string	展示名称（按 lang）
`countryCode / countryName`	string \| null	主要国家（多国套餐为 null）
`coverageCountries`	string[]	可用国家代码列表
`isMultiCountry`	boolean	是否多国套餐
`dataAmount / dataAmountGB`	string / number	流量（显示文本 / GB 数值）
`isUnlimited`	boolean	是否无限流量
`dataType`	'total' \| 'daily' \| null	总量型 / 每日型
`validityDays`	integer	有效天数
`priceKrw / currency`	integer / 'KRW'	售价（韩元）
`provider / networkType`	string	供应商 / 网络（如 5G）
`hotspot / hasLocalNumber / isLocalNetwork`	boolean	热点共享 / 提供当地号码 / 当地网络
`url`	string	购买链接，已带有您的合作伙伴代码（?ref=），请原样展示。

注意

字段只会新增，名称与含义不会改变。解析时请忽略未知字段。