FREE Am I Roaming API

Introduction

The main purpose of this API is to cater to the needs of iOS app developers who need to track the roaming status of their applications. It achieves this goal by cross-referencing the device's GPS location with its IP Geolocation (which is derived from the IP address). When the user's IP address indicates that they are outside the country, the API identifies them as roaming.

Get Started

This API is part of the FREE API Package and is available in free and paid plans. Please visit the FREE API Package package page for limits and pricing information.

Endpoints

IPv4 only API Endpoint

Use this endpoint to force API calls routed over the IPv4 network only

GET

https://api.bigdatacloud.net/data/am-i-roaming

Dual-Stack API Endpoint

This endpoint has native IPv6 support and backs the API calls routed over both IPv4 and IPv6 networks

GET

https://api-bdc.net/data/am-i-roaming

Request

Parameter

Type

Required

Description

latitude

number (double)

Yes

Latitude value as per WGS 84 reference system (GPS system). Expected values are in [-90, 90] range

longitude

number (double)

Yes

Longitude value as per WGS 84 reference system (GPS system). Expected values are in [-180, 180] range

Responses

200

Success

Sample Query

GET

https://api-bdc.net/data/am-i-roaming?latitude=36.93&longitude=-78.92

Schema

application/json

isRoamingboolean

Roaming estimate result

Sample Response

400

Bad request

Sample Response

401

Invalid coordinates

Sample Response

500

An error has occurred and did not complete your request. Please try again

Sample Response

Was this page helpful?