Home

eSIM Exchange Business Integration API Specification

Search by country name or country code (Recommend)

URL:https://api.iroamly.com/common/getPlanListFromCountry
Request Method:GET

Optional parameter: country, country name or country code. If left blank, all international packages are retrieved by default.

Request Examples:

  1. 1. Retrieve packages for all countries: https://api.iroamly.com/common/getPlanListFromCountry
  2. 2. Retrieve packages for one region: https://api.iroamly.com/common/getPlanListFromCountry?country=Indonesia

country eg: Afghanistan、Austria、United States、US、CN……

Return Field Descriptions:

NameDescription
region: Region/Country Name
url: Package URL
is_regional: Yes|No
Country_list: list the country and operators
planList: Package List
Name: Package Name
Price: Total Price
Capacity: Package Capacity
package_type: Data Only ,Data & Call,Data & Call & SMS
Type: Capacity Calculation Type, Daily- per day measurement, Total- total measurement
Validity: Package usage time, in days
Price/GB: Cost per GB
Currency: Currency standard (currently all in USD)
Example Return
{
  "code": 0,
  "data": [
    {
      "region": " Asia: 11 Countries",
      "is_regional": "Yes",
      "url":"https://www.iroamly.com/asia-11-countries-esim/",
      "country_list": [
        {
          "name": "Mainland China",
          "index": "china",
          "code": "CN",
          "operator": "China Unicom / China Telecom"
        },
        ...
      ],
      "planList": [
        {
          "Name": "Asia ( 11 Countries)-5GB-3 Days-Total",
          "ProductCode": "iRoamly-eSIM-AAT5G-03-903365",
          "Price": 10,
          "Capacity": "5GB",
          "package_type": "Data Only",
          "type": "Total",
          "Validity": "3",
          "operator": "Coverage area and list of operators",
          "remark": "Unlimited data in coverage area for 3 days, total 5GB high-speed, then reduced to 128kbps.Covered countries: China, Hong Kong, Macau, Singapore, Malaysia, Thailand, Indonesia, Vietnam, Philippines, Japan, Korea.",
          "Price/GB": 2,
          "Currency": "USD"
        },
        ...
      ]
    }
  ],
  "msg": "Success"
}

Search by region or country name

URL:https://api.iroamly.com/common/getPlanListFromRegion
Request Method:GET

Optional Parameters: region, value is a region or country, if left empty it defaults to retrieving packages for all regions

Request Examples:

  1. 1. Retrieve packages for all regions: https://api.iroamly.com/common/getPlanListFromRegion
  2. 2. Retrieve packages for one region: https://api.iroamly.com/common/getPlanListFromRegion?region=Indonesia

region eg: Afghanistan、Austria、United States、Asia、Europe……

Return Field Descriptions:

NameDescription
region: Region/Country Name
url: Package URL
is_regional: Yes|No
Country_list: list the country and operators
planList: Package List
Name: Package Name
Price: Total Price
Capacity: Package Capacity
package_type: Data Only ,Data & Call,Data & Call & SMS
Type: Capacity Calculation Type, Daily- per day measurement, Total- total measurement
Validity: Package usage time, in days
Price/GB: Cost per GB
Currency: Currency standard (currently all in USD)
Example Return
{
  "code": 0,
  "data": [
    {
      "region": "Indonesia",
      "is_regional": "No",
      "url":"https://www.iroamly.com/indonesia-esim/",
      "country_list": [
        {
          "name": "Indonesia",
          "index": "indonesia",
          "code": "ID",
          "operator": ""
        },
        ...
      ],
      "planList": [
        {
          "Name": "Indonesia-500MB-1 Day-Daily",
          "ProductCode": "iRoamly-eSIM-XMTY500M-01-588540",
          "Price": 1,
          "Capacity": "500MB",
          "package_type": "Data Only",
          "type": "Daily",
          "Validity": "1",
          "operator": "Telkomsel",
          "remark": "Unlimited data in the coverage area, 500MB high-speed per day, then reduced to 128kbps",
          "Price/GB": 2,
          "Currency": "USD"
        },
        ...
      ]
    }
  ],
  "msg": "Success"
}