Public API (/v1)

Get an eSIM

GET /v1/esims/:id — get one eSIM and its purchase link by the id from search results.

On this page

Request
Parameters
Response
Errors

Request#

GET/v1/esims/:id

curl "https://api.esimoa.com/v1/esims/partner_9VKPYQ3JRYVK5797?lang=en" \
  -H "X-API-Key: esk_live_your_key_here"

const id = 'partner_9VKPYQ3JRYVK5797';
const res = await fetch(`https://api.esimoa.com/v1/esims/${encodeURIComponent(id)}?lang=en`, {
  headers: { 'X-API-Key': process.env.ESIMOA_API_KEY },
});
if (res.status === 404) {
  // the plan is no longer on sale — drop it from your listing
}
const { item } = await res.json();

res = requests.get(
    f"https://api.esimoa.com/v1/esims/{esim_id}",
    params={"lang": "en"},
    headers={"X-API-Key": os.environ["ESIMOA_API_KEY"]},
    timeout=10,
)
if res.status_code == 404:
    ...  # the plan is no longer on sale
item = res.json()["item"]

Parameters#

Parameter	Type	Description
`id`required	string	Path — the id from search results
`lang`	string	Response language: ko \| en \| ja \| zh-CN \| zh-TW (default en)

Response#

item has the same shape as the Esim object in search results.

200 OKjson

{
  "success": true,
  "item": { "id": "partner_9VKPYQ3JRYVK5797", "title": "Japan · 100 MB · 7 days", "...": "..." }
}

Errors#

An unknown or discontinued id returns 404 eSIM not found. If you stored the product, remove it from your listing.