Skip to main content
GET
/
esim
/
devices
Get Compatible Devices
curl --request GET \
  --url https://api.fyatu.com/api/v3/esim/devices \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "status": 200,
  "message": "<string>",
  "data": {
    "brands": [
      "<string>"
    ],
    "devices": {},
    "total": 123
  },
  "meta": {
    "requestId": "req_abc123def456",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

​
Overview

Retrieve a list of devices that support eSIM technology. Use this to help users verify their device is compatible before purchasing.

​
Query Parameters

ParameterTypeDescription
brandstringFilter by brand (e.g., “Apple”, “Samsung”)
typestringFilter by device type: PHONE, TABLET, WATCH, LAPTOP
searchstringSearch by device name or model

​
Response Fields

FieldTypeDescription
brandsarrayList of brand names
devicesobjectDevices grouped by brand
totalintegerTotal number of devices

​
Device Object

FieldTypeDescription
modelstringModel identifier
deviceNamestringHuman-readable device name
deviceTypestringPHONE, TABLET, WATCH, or LAPTOP
osTypestringOperating system (iOS, Android, etc.)

​
Example Usage

// Get all compatible devices
const response = await fetch('https://api.fyatu.com/api/v3/esim/devices', {
  headers: {
    'Authorization': `Bearer ${accessToken}`
  }
});

const { data } = await response.json();

console.log(`Total compatible devices: ${data.total}`);
console.log(`Brands: ${data.brands.join(', ')}`);

// List Apple devices
data.devices['Apple'].forEach(device => {
  console.log(`${device.deviceName} (${device.deviceType})`);
});

​
Filter by Brand

// Get only Samsung devices
const response = await fetch('https://api.fyatu.com/api/v3/esim/devices?brand=Samsung', {
  headers: {
    'Authorization': `Bearer ${accessToken}`
  }
});

​
Search Devices

// Search for iPhone models
const response = await fetch('https://api.fyatu.com/api/v3/esim/devices?search=iPhone', {
  headers: {
    'Authorization': `Bearer ${accessToken}`
  }
});

​
Example Response

{
  "success": true,
  "status": 200,
  "message": "Compatible devices retrieved successfully",
  "data": {
    "brands": ["Apple", "Samsung", "Google", "Motorola", "Huawei"],
    "devices": {
      "Apple": [
        {
          "model": "iphone-15-pro-max",
          "deviceName": "iPhone 15 Pro Max",
          "deviceType": "PHONE",
          "osType": "iOS"
        },
        {
          "model": "iphone-15-pro",
          "deviceName": "iPhone 15 Pro",
          "deviceType": "PHONE",
          "osType": "iOS"
        },
        {
          "model": "iphone-15",
          "deviceName": "iPhone 15",
          "deviceType": "PHONE",
          "osType": "iOS"
        },
        {
          "model": "ipad-pro-m2",
          "deviceName": "iPad Pro (M2)",
          "deviceType": "TABLET",
          "osType": "iOS"
        },
        {
          "model": "apple-watch-ultra-2",
          "deviceName": "Apple Watch Ultra 2",
          "deviceType": "WATCH",
          "osType": "watchOS"
        }
      ],
      "Samsung": [
        {
          "model": "galaxy-s24-ultra",
          "deviceName": "Galaxy S24 Ultra",
          "deviceType": "PHONE",
          "osType": "Android"
        },
        {
          "model": "galaxy-z-fold-5",
          "deviceName": "Galaxy Z Fold 5",
          "deviceType": "PHONE",
          "osType": "Android"
        },
        {
          "model": "galaxy-tab-s9",
          "deviceName": "Galaxy Tab S9",
          "deviceType": "TABLET",
          "osType": "Android"
        }
      ],
      "Google": [
        {
          "model": "pixel-8-pro",
          "deviceName": "Pixel 8 Pro",
          "deviceType": "PHONE",
          "osType": "Android"
        },
        {
          "model": "pixel-8",
          "deviceName": "Pixel 8",
          "deviceType": "PHONE",
          "osType": "Android"
        }
      ]
    },
    "total": 156
  }
}

​
Common Brands

BrandNotable Models
AppleiPhone XS and newer, iPad Pro (3rd gen+), Apple Watch (cellular)
SamsungGalaxy S20 and newer, Galaxy Z Fold/Flip series, Galaxy Tab S
GooglePixel 3 and newer
MotorolaRazr series, Edge+
HuaweiP40 series, Mate 40 series

​
Best Practices

The device list doesn’t change frequently. Cache it for 24 hours to reduce API calls.
Let users search for their specific device model to confirm compatibility before purchase.
Use fuzzy search to help users find their device even with slight spelling variations.

​
Device Support Notes

eSIM support depends on both hardware and carrier. A device may support eSIM but be carrier-locked. Users should verify their device is unlocked for eSIM use.
Some devices (particularly those from China or carrier-locked devices) may have eSIM functionality disabled. The device appearing in this list confirms hardware support but not guaranteed functionality.

Authorizations

​
Authorization
string
header
required

JWT access token obtained from /auth/token

Query Parameters

​
brand
string

Filter by brand (e.g., 'Apple', 'Samsung')

​
type
enum<string>

Filter by device type

Available options:
PHONE,
TABLET,
WATCH,
LAPTOP
​
search
string

Search by device name or model

Response

Compatible devices retrieved successfully

​
success
boolean
Example:

true

​
status
integer
Example:

200

​
message
string
​
data
object
​
meta
object