eSIM API - Package(s)
Table of Contents
Ways to get eSIM packages
To get a list of eSIM packages, you need to send a GET request to the /api/esim/packages endpoint.
⚠️
Watch out property “withUsageCheck”, if it is set to false, usage check won’t be supported, find instructions in the notes property
⚠️
Watch out property “withThrottle”, if it is set to true, throttling will in-effect, find more info in the throttle property
The request body should contain the following parameters:
country: The country code of the eSIM packages. This is an optional field of typestring. If you do not provide a country code, the API will return a list of all available eSIM packages. It follows the ISO 3166-1 alpha-2  format.geography: The geography of the eSIM packages. This is an optional field of typestring. It can be any of the following values:local: Local packagesregional: Regional packagesglobal: Global packages
Usage examples
Here is an example of how you can get a list of eSIM packages using Roamify eSIM API.
Example Request 1: Get all eSIM packages
curl
curl --request GET \
--url 'https://api-dev.getroamify.com/api/esim/packages' \
--header 'Authorization: Bearer Access Token' \
--header 'Content-Type: application/json'Example Request 2: Get eSIM packages for a specific country
curl
curl --request GET \
--url 'https://api-dev.getroamify.com/api/esim/packages?country=US' \
--header 'Authorization: Bearer Access Token' \
--header 'Content-Type: application/json'Example Request 3: Get eSIM packages for a specific geography
curl
curl --request GET \
--url 'https://api-dev.getroamify.com/api/esim/packages?geography=global' \
--header 'Authorization: Bearer Access Token' \
--header 'Content-Type: application/json'Sample Response
{
"status": "success",
"data": {
"packages": [
{
"id": "afghanistan-esims",
"countryName": "Afghanistan",
"countryCode": "AF",
"countrySlug": "afghanistan",
"region": "Asia",
"geography": "local",
"minPrice": 5,
"maxPrice": 5,
"image": "https://imagedelivery.net/uUE6LNs_ci8SFBH4_n66dQ/countries/flags/afghanistan/public",
"signals": [
{
"code": "AF",
"name": "Afghanistan",
"networks": [
"3G",
"4G"
],
"carriers": [
"MTN"
]
}
],
"packages": [
{
"packageId": "esim-canada-15days-un2gb-all",
"package": "Unlimited Data - 15 Days (2 GB / 128 KBPS)",
"plan": "data-only",
"activation": "first-use",
"day": 15,
"price": 1.32,
"isUnlimited": true,
"isAPNAutomatic": true,
"apn": "drei.at",
"dataAmount": 9007199254740991,
"dataUnit": "MB",
"callType": "all",
"callAmount": -1,
"callUnit": "",
"smsType": "all",
"smsAmount": -1,
"smsUnit": "",
"withSMS": false,
"withCall": false,
"withHotspot": true,
"withDataRoaming": true,
"withDestinationInstall": false,
"withUsageCheck": true,
"withThrottle": true,
"throttle": {
"throttleSpeed": 128,
"throttleSpeedUnit": "kbps",
"throttleThreshold": 2,
"throttleThresholdUnit": "gb"
},
"notes": []
}
]
}
]
}
}Last updated on