eSimsData / Developer documentation
One catalog.
Ready to integrate.
Read-only access to eSimsData plan information, pricing and destination coverage for approved integrations.
Technical reference · Updated 28 September 2026
Supported integration flow
Use the catalog API to display eSimsData plans on your website or in your application. Customers follow the offer link to the eSimsData website to complete their purchase and receive their eSIM.
Scope of this guide
This guide covers catalog access and links to purchase on the eSimsData website. It does not cover accepting payments, creating orders or delivering eSIMs directly within your own website or application.
Request the catalog
Your endpoint, authentication header name and key are supplied privately. Send an HTTPS GET request using those assigned values.
Connection details: supplied in your integration emailcurl --request GET \
"${CATALOG_ENDPOINT}" \
--header "${API_HEADER_NAME}: ${API_KEY}" \
--header 'Accept: application/json'This is a template, not a working request. Set CATALOG_ENDPOINT, API_HEADER_NAME and API_KEY securely on your server using the values supplied in your integration email. Never expose credentials in public source code, URLs or browser JavaScript.
| Status | Meaning |
|---|---|
200 | Catalog returned successfully. |
401 | Key is missing or incorrect. |
503 | Catalog or access configuration is temporarily unavailable. |
A single JSON array
The response is an array of plan objects, without an outer wrapper or pagination. The example below is fictional and is not a purchasable offer.
[
{
"planName": "Example 1GB 7 Days",
"validity": 7,
"dataCap": 1000,
"dataUnit": "MB",
"prices": { "USD": 9.99 },
"coverages": [{ "code": "DE" }],
"link": "https://example.invalid/illustrative-plan/",
"telephony": null,
"subscription": false
}
]Plan fields
| Field | Interpretation |
|---|---|
planName | Customer-facing plan name; maximum 100 characters. |
validity | Validity in days. |
dataCap, dataUnit | High-speed allowance as a number; read its unit from dataUnit (MB, GB or TB). |
dataCapPer | day for a daily allowance; absent for a fixed allowance. |
reducedSpeed | Speed in kbps after the high-speed allowance is exhausted, where provided. |
capacityInfo | Explanation of the total or daily allowance and reduced-speed service. |
prices | Currency-to-price object. Tax-inclusive retail prices, currently USD. |
coverages | Array of destination objects. Read each code as a string; see coverage rules below. |
additionalInfo | Additional restrictions, including territory limits where applicable. |
link | Offer-specific details and purchase URL. Preserve the supplied query parameters. |
telephony | null for data-only plans. Otherwise an object with dialingCode and separate voice/sms inbound and outbound booleans. Capabilities do not imply free or unlimited calls or SMS; read any stated allowances in additionalInfo. |
canTopUp | Optional top-up capability. Do not infer support from an absent field; read any service-specific restrictions in additionalInfo. |
subscription | false: non-recurring packages. |
Phone numbers, calls, SMS & top-ups
For plans with a phone number, telephony.dialingCode identifies the number's country calling code, not the plan's coverage. The catalog does not return the subscriber's actual phone number. Read voice.inbound, voice.outbound, sms.inbound and sms.outbound separately to determine supported services.
Support for calls or SMS does not specify included minutes, message quantities or charges. Use only allowances explicitly stated in additionalInfo. A reloadable SIM does not necessarily support top-ups through eSimsData: check canTopUp together with any restrictions in additionalInfo. If the field is absent, top-up availability is unspecified.
A daily high-speed allowance is not unlimited high-speed data. Display the daily cap and subsequent reduced speed together. Do not infer activation timing, reset timing, hotspot support, network availability, top-ups or identity-check requirements from absent fields.
Keep coverage precise
The feed includes destination identifiers beyond a strict two-letter country-code format. Your importer must preserve their exact meaning.
| Identifier | Destination | Handling |
|---|---|---|
US-HI | Hawaii | Hawaii only, not the entire United States. |
X-NCY | Northern Cyprus | Northern Cyprus only, not the entire island. |
IC | Canary Islands | Preserved as a named destination. |
AN | Netherlands Antilles | Preserved destination label, not asserted to be a current ISO code. |
Do not truncate, broaden or silently replace identifiers. A regional offer may contain both CY and X-NCY; do not merge them. Flag unsupported destinations for review before displaying an offer.
Use the feed safely
Snapshots & refresh
Requests read a cached catalog. If a refresh fails, the preceding valid snapshot is retained.
Agree a polling cadence before integration. No fixed refresh interval is guaranteed. Do not interpret a failed request as an empty catalog.
Offer links & attribution
Use each plan’s link without stripping or replacing its query parameters.
There is no separate offer-ID field in this response. Offer-specific URLs distinguish plans. Integration-specific link settings are supplied privately.
eSimsData logo
Download our official logo for displaying eSimsData in your integration.
Ready-to-use files
Download SVG — vector
Download PNG — 2000 × 800 px
Both files have a transparent background. SVG scales without loss of quality; PNG is ready for use where vector files are not supported.
Use on a light background. Keep the original proportions and colors; do not stretch or crop the logo.
Catalog API FAQ
What information can I retrieve?
The API provides plan names, prices, data allowances, validity periods, destination coverage and offer links. See the field reference above for optional information and its interpretation.
Can I view current plans here?
This page is a technical guide, not a live tariff listing. Its example is fictional. Approved integrations can retrieve the available catalog using the endpoint and credentials supplied privately.
Can this API process a purchase?
No. This is a read-only catalog API. It does not create orders, accept payments, issue eSIMs or return installation credentials. The link field points to the corresponding offer page; it is not an order-creation endpoint.
How do I request access?
Email [email protected] with a brief description of your service and intended use. Access is subject to approval. Connection details and integration terms are agreed privately; reading this guide does not grant API access.