Skip to main content
GET
List products
Every product you can order, with what it covers and your wholesale price: the price you are invoiced for it. The option_id values here are what Create an order takes. It lists what is on sale. A destination we are preparing, or have paused, is left out until it is on sale. Fetch it once a day and cache it, rather than per order or per page view. It returns the whole catalogue, about 11,000 rows, gzipped when your client accepts it.

Filters

All optional. Without them you get the whole catalogue.
  • country: an ISO code such as JP. Returns Japan’s own plans and every regional plan that covers Japan.
  • location_type: country or region.
  • location: a name exactly as the response spells it, such as Japan. Case does not matter.
An unknown value returns an empty list, not the whole catalogue, so a typo shows up as no results rather than as everything.

Reading a row

  • data is the daily allowance as a person reads it. Unlimited plans read Unlimited; their data_mb is the full-speed part each day.
  • countries lists where the plan works: the country itself, or each country a region covers, with its ISO code.
  • wholesale_price_usd is a string with two decimals, so it never arrives as a float.

Keeping your catalogue in sync

If you keep your own copy of the catalogue, for example to show plans or prices in your storefront, sync it once a day:
  1. Fetch the whole list without filters, with Accept-Encoding: gzip.
  2. Key every row on option_id. It is stable for a product and is what you order with.
  3. Upsert. Add the option_id values you have not seen, and update the ones you have. wholesale_price_usd is what you will be invoiced from then on, so compare it with what you stored and act on changes, such as repricing your own plan or flagging it for review.
  4. Stop selling what is gone. An option_id that is no longer in the list is no longer on sale. Stop offering it to your customers.
A failed fetch should leave your last good copy in place rather than empty it.

Rate limit

10 requests per minute per access key. Going over returns 429 Too Many Requests with a Retry-After header in seconds.

Authorizations

X-Esimmu-Access-Key
string
header
required

Your partner access key. Identifies you on every request.

X-Esimmu-Signature
string
header
required

Lowercase hex HMAC-SHA256 over the five-line string {METHOD}\n{REQUEST_PATH}\n{TIMESTAMP}\n{ACCESS_KEY}\n{BODY_SHA256}, keyed with your Base64-decoded secret key.

REQUEST_PATH includes the /api prefix and excludes the domain and any query string. BODY_SHA256 is the lowercase hex SHA-256 of the exact body bytes you send; for a request with no body, hash the empty string. The string always has five lines.

X-Esimmu-Timestamp
string
header
required

Unix seconds (UTC), within 5 minutes of our clock.

Query Parameters

country
string

An ISO 3166-1 alpha-2 code, such as JP. Returns the country's own plans and every regional plan that covers it.

location_type
enum<string>

country or region.

Available options:
country,
region
location
string

A country or region name exactly as the response spells it, such as Japan. Case does not matter.

Response

The catalogue, or the part the filters select.

products
object[]
Last modified on November 17, 2026