Skip to content
FX-Port/Docs
GuidesAPI referenceChangelog
Get API keys
  • Overview
  • Error object

Catalog

  • PackagesGET
  • Compatible devicesGET

Orders and top-ups

  • Create an orderPOST
  • Top-up packagesGET
  • Top upPOST

After the order

  • UsageGET
  • Usage of several eSIMsGET
  • BookingsGET
  • Top-up historyGET
  • Check ownershipGET
  • Setup dataGET
  • Installation instructionsGET

Objects

  • eSIM package
  • eSIM booking

eSIMs · Catalog

List eSIM compatible devices

List the devices known to support eSIM, to check a traveler's phone before the sale.

GET/api/v1/esims/compatible-devices

Requires an API key with Read permission; a Read+Write key works too.

The list has about 630 entries and is not paginated. It is cached and refreshed about once a week; meta.cached_at tells when. Match on model (the manufacturer's identifier) or name; the case of brand differs between entries.

A 202 means the list is still loading after a restart and a 503 that the device fetcher is not running yet: wait a few seconds and retry.

curl https://api.fx-port.com/api/v1/esims/compatible-devices \
  -H "Authorization: Bearer fxp_test_YOUR_KEY"
Response200
{
  "environment": "sandbox",
  "success": true,
  "data": [
    {
      "model": "T803D",
      "os": "android",
      "brand": "Alcatel",
      "name": "V3 Ultra"
    },
    {
      "model": "iPhone15,2",
      "os": "ios",
      "brand": "Apple",
      "name": "iPhone 14 Pro"
    }
  ],
  "meta": {
    "total_devices": 631,
    "cached_at": "2026-11-01T15:07:43.957236",
    "cache_age_days": 0.01
  }
}
Response202
{
  "environment": "sandbox",
  "success": false,
  "message": "No cached devices available. Device fetcher may still be loading initial data.",
  "data": []
}

Request

This endpoint takes no parameters.

Response

200The devices.

successboolean

true when the list was returned.

dataarray of object

The devices. About 630 entries, not paginated.

ShowHide 4 attributes
modelstring

The manufacturer's model identifier.

osstring

Operating system family.

One of android, ios.

brandstring

Manufacturer, as the supplier spells it (the case differs between entries).

namestring

Marketing name of the device.

metaobject

Facts about the list.

ShowHide 3 attributes
total_devicesinteger

Number of devices in data.

cached_atstring

When the list was fetched from the supplier: the server's clock without a zone, for example 2026-11-01T15:07:43.957236. The list is refreshed about once a week.

cache_age_daysnumber

Age of the list in days.

202The list is still loading. success is false and data is empty: retry in a few seconds.

successboolean

Always false: the data is not available yet.

messagestring

What is missing and that it is still loading.

dataarray of object

Always empty.

metaobject

Empty for a catalog that is loading.

Related guides

  • Package catalog
PreviousList eSIM packagesNext Create an eSIM order

© 2026 FX-Port

TermsPrivacy[email protected]