Country by IP Address API
Discover comprehensive country details through accurate geolocation of IPv4 and IPv6 addresses with our Country by IP Address API. Leveraging patented Next Generation IP Geolocation Technology, the API delivers an array of information including ISO-defined country names, official languages, currency details, and classifications such as region names and income levels, as designated by the United Nations and the World Bank. Designed for analytics, customisation, or security purposes, the API ensures precise and relevant data integration for your applications.
GET
https://api-bdc.net/data/country-by-ipParameters
| Parameter | Type | Required | Description |
|---|---|---|---|
ip | string | Optional | IPv4 IP address in a string or numeric format or IPv6 IP address in a string format. If omitted, the caller’s IP address is assumed |
localityLanguage | string | Optional | Preferred language for locality names in ISO 639-1 format, such as 'en' for English, 'es' for Spanish etc. If the requested language is unavailable for a requested location, it will default to English. If no English variant is available, will provide the native, local names. Use 'default' as the requested value to automatically adjust the language to the first administrative language in the Country. |
key | string | Optional | Your API key |
Responses
200OK
Sample Request
https://api-bdc.net/data/country-by-ip?ip=34.228.237.164&localityLanguage=en&key=[YOUR API KEY]Sample Response
JSON View
Response Schema
ipstringThe requested IP address in string format (IPv4 or IPv6).
localityLanguageRequestedstringThe locality language that was used for this response, as requested via the `localityLanguage` parameter (ISO 639-1 code, e.g. "en").
isReachableGloballybooleanIndicates whether the IP address is present on the global BGP routing table and therefore reachable from the public Internet.
If `false`, the address is not in active use and cannot be geolocated.
▶countryobjectcountry object
isoAlpha2stringISO 3166-1 Alpha-2 code
isoAlpha3stringISO 3166-1 Alpha-3 code
m49CodeintegerUnited Nations M.49 code
namestringCountry name localised to the language as defined by 'localityLanguage' request parameter
isoNamestringThe short English country name as defined by ISO 3166-1 (e.g. "Australia").
isoNameFullstringThe full official English country name as defined by ISO 3166-1 (e.g. "Commonwealth of Australia").
▶isoAdminLanguagesarrayAdministrative languages as defined by ISO 3166-1 standard
isoAlpha3stringISO 3166-1 Alpha-3 code
isoAlpha2stringISO 3166-1 Alpha-2 code
isoNamestringISO 3166-1 Language name
nativeNamestringA native name
unRegionstringRegion name as defined by the United Nations
▶currencyobjectcurrency object
numericCodeintegerISO 4217 standard numeric code
codestringISO 4217 standard code
namestringISO 4217 English name
minorUnitsintegerISO 4217 minor units as the currency exponent (e.g. 2 = 1/100)
▶wbRegionobjectwbRegion object
idstringworld bank identification number. the expected values are: 'LCN','NA','SAS','SSF','ECS','MEA','EAS','NAC'
iso2Codestringiso 2 letters code. the expected values are: 'ZJ','NA','8S','ZG','Z7','ZQ','Z4','XU'
valuestringregion name. the expected values are: 'Latin America & Caribbean','Aggregates','South Asia',
'Sub-Saharan Africa','Europe & Central Asia','Middle East & North Africa','East Asia & Pacific','North America'
▶wbIncomeLevelobjectwbIncomeLevel object
idstringworld bank identification number. the expected values are: 'HIC','NA','LIC','LMC','UMC','INX'
iso2Codestringiso 2 letters code. the expected values are: 'XD','NA','XM','XN','XT','XY'
valuestringincome level name. the expected values are: 'High income','Aggregates','Low income','Lower middle income','Upper middle income','Not classified'
callingCodestringThe international dialling (calling) code for the country, without the leading "+" (e.g. "1" for the US, "61" for Australia).
countryFlagEmojistringThe country flag as a Unicode emoji (e.g. "🇦🇺" for Australia), composed from the ISO 3166-1 Alpha-2 regional indicator symbols.
wikidataIdstringWikidata item identifier, if available
geonameIdintegerA unique identifier as is given by GeoNames.org
isIndependentbooleanDetermines if the country/territory is independent according to ISO 3166 records
lastUpdatedstringThe UTC timestamp (ISO 8601) of when the geolocation data for this IP address was last assessed and updated.
403Access denied, or your quota limit has exceeded
Sample Response
JSON View
404Found no valid entry for the request
Sample Response
JSON View
405The requested IP address is not valid
Sample Response
JSON View
500An error has occurred and did not complete your request. Please try again
Sample Response
JSON View