BigDataCloud Logo

IP Address Geolocation with Confidence Area API

Introduction

The IP Address Geolocation with Confidence Area API is based on the same data and accuracy as the IP Geolocation API, but with an additional layer of information on top - the Confidence Area.

The Confidence Area is an essential feature of the IP Address Geolocation, providing a list of coordinates that define a closed polygon representing the maximum possible service area where an IP address could be located. This information is based on the historical allocation of IP addresses by Internet Service Providers (ISPs) and the network topology.

The Confidence Area feature can be useful for various applications that require a higher level of precision in geolocation, such as fraud detection, risk analysis, and targeted advertising. For more detailed information on Confidence Area, you can refer to the What is Confidence Area? FAQ on our website.

Get Started

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

Endpoint

GET
https://api-bdc.net/data/ip-geolocation-with-confidence

Request

Parameter
ip
Type
string
Required
Optional, default value: [Caller's IP]
Description
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
Parameter
localityLanguage
Type
string
Required
Optional, default value: en
Description
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.
Parameter
key
Type
string
Required
Yes
Description
Your API key

Responses

200
OK

Sample Query

GET
https://api-bdc.net/data/ip-geolocation-with-confidence?ip=216.73.216.188&localityLanguage=en&key=[YOUR API KEY]

Schema

application/json
ipstring
Requested IP address in a string format.
localityLanguageRequestedstring
localityLanguage input parameter received
isReachableGloballyboolean
Indicated whether the IP address is present on the global routing table, hence reachable. If not reachable, the IP address is not in use and therefore cannot be geolocated
country
country object
isoAlpha2string
ISO 3166-1 Alpha-2 code
isoAlpha3string
ISO 3166-1 Alpha-3 code
m49Codeinteger
United Nations M.49 code
namestring
Country name localised to the language as defined by 'localityLanguage' request parameter
isoNamestring
ISO 3166-1 Country name short
isoNameFullstring
ISO 3166-1 Country name full
isoAdminLanguagesarray
Administrative languages as defined by ISO 3166-1 standard
isoAlpha3string
ISO 3166-1 Alpha-3 code
isoAlpha2string
ISO 3166-1 Alpha-2 code
isoNamestring
ISO 3166-1 Language name
nativeNamestring
A native name
unRegionstring
Region name as defined by the United Nations
currency
currency object
numericCodeinteger
ISO 4217 standard numeric code
codestring
ISO 4217 standard code
namestring
ISO 4217 English name
minorUnitsinteger
ISO 4217 minor units as the currency exponent (e.g. 2 = 1/100)
wbRegion
wbRegion object
idstring
world bank identification number. the expected values are: 'LCN','NA','SAS','SSF','ECS','MEA','EAS','NAC'
iso2Codestring
iso 2 letters code. the expected values are: 'ZJ','NA','8S','ZG','Z7','ZQ','Z4','XU'
valuestring
region 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'
wbIncomeLevel
wbIncomeLevel object
idstring
world bank identification number. the expected values are: 'HIC','NA','LIC','LMC','UMC','INX'
iso2Codestring
iso 2 letters code. the expected values are: 'XD','NA','XM','XN','XT','XY'
valuestring
income level name. the expected values are: 'High income','Aggregates','Low income','Lower middle income','Upper middle income','Not classified'
callingCodestring
Calling code
countryFlagEmojistring
Country emoji
wikidataIdstring
Wikidata item identifier, if available
geonameIdinteger
A unique identifier as is given by GeoNames.org
isIndependentboolean
Determines if the country/territory is independent according to ISO 3166 records
location
location object
principalSubdivisionstring
Localised principal subdivision name in the requested language, if available
isoPrincipalSubdivisionstring
Principal subdivision name as defined by ISO 3166-2 standard
isoPrincipalSubdivisionCodestring
Principal subdivision code as defined by ISO 3166-2 standard
continentstring
Localised Continent name in the requested language, if available
continentCodestring
Continent code
citystring
The most significant populated place this location belongs. It will likely be the City name in the language requested. If unavailable, use the locality name field as a failover
localityNamestring
Represents the smallest geographic area recognised to which the target belongs. The language, if available, is as defined by the 'localityLanguage' request parameter
postcodestring
Postcode, if available
latitudenumber
Estimated Latitude
longitudenumber
Estimated Longitude
plusCodestring
Open Location Code
fips
FIPS code object, omitted if unavailable. FIPS (Federal Information Processing Standards) Codes are codes used by the Census Bureau to uniquely identify places in the US. Visit FIPS FAQ page for more information.
statestring
State-level FIPS codes have two digits
countystring
A three digits County-level FIPS code.
countySubdivisionstring
FIPS five digits County Subdivision Code
placestring
FIPS five digits place code, omitted if unavailable
csdCodestring
CSD (Census Subdivision) code, omitted if unavailable. Canadian Geographic Codes. Visit CSD FAQ page for more information.
timeZone
timeZone object
ianaTimeIdstring
The unique identifier of the time zone from the IANA Time Zone Database (e.g., "America/New_York").
displayNamestring
displayName object
effectiveTimeZoneFullstring
The full name of the effective time zone, adjusted for daylight saving (e.g., "Eastern Daylight Time").
effectiveTimeZoneShortstring
The abbreviated name of the effective time zone, adjusted for daylight saving (e.g., "EDT").
utcOffsetSecondsinteger
The effective offset from UTC in seconds, adjusted for daylight saving time.
utcOffsetstring
The effective offset from UTC, formatted as a string and adjusted for daylight saving time.
isDaylightSavingTimeboolean
A boolean value indicating whether daylight saving time is currently in effect.
localTimestring
The current local time in the specified time zone, formatted in ISO 8601 "O" format.
utcTimestring
The corresponding UTC time, formatted in ISO 8601 "O" format. This value is omitted if the 'utcReference' parameter was not supplied or was invalid.
localityInfo
localityInfo object
administrativearray
Administrative authorities as ordered by area (most significant first). Omitted if no administrative boundaries are available
namestring
Localised name of the place in the requested language, if available. The language is as defined by the 'localityLanguage' request parameter
descriptionstring
Localised description of the place in the requested language, if available. The language is as defined by the 'localityLanguage' request parameter
isoNamestring
ISO 3166-2 standard name, if available
orderinteger
Order value consistent across all entities in the Locality Info parent object. Ordered by geographic area (most significant first)
adminLevelinteger
An administrative level as defined by OpenStreetMaps project
isoCodestring
ISO 3166-2 standard code, if available
wikidataIdstring
Wikidata item identifier, if available
geonameIdinteger
Unique identifier given by GeoNames.org, if available
chinaAdminCodestring
China Administrative division code. Only available for locations based in China and omitted for others
informativearray
Non-administrative boundaries as ordered by area (most significant first). Omitted if unavailable
namestring
Localised name of the place in the requested language, if available. The language is as defined by the 'localityLanguage' request parameter
descriptionstring
Localised description of the place in the requested language, if available. The language is as defined by the 'localityLanguage' request parameter
isoNamestring
ISO 3166-2 standard name, if available
orderinteger
Order value consistent across all entities in the Locality Info parent object. Ordered by geographic area (most significant first)
adminLevelinteger
An administrative level as defined by OpenStreetMaps project
isoCodestring
ISO 3166-2 standard code, if available
wikidataIdstring
Wikidata item identifier, if available
geonameIdinteger
Unique identifier given by GeoNames.org, if available
chinaAdminCodestring
China Administrative division code. Only available for locations based in China and omitted for others
lastUpdatedstring
Indicates the time of when that particular IP address’s geolocation was assessed the last
network
network object
registrystring
The Regional Internet Registry (RIR), the network registered with
registryStatusstring
Registration status
registeredCountrystring
Registered Country ISO 3166-1 Alpha-2 code
registeredCountryNamestring
Registered Country name localised to the language is as defined by 'localityLanguage' request parameter
organisationstring
organisation or a segment the network is registered for
isReachableGloballyboolean
Indicates whether the network was announced on BGP and reachable globally or not
isBogonboolean
Indicates whether the IP address is excluded from public Internet use by the authorities but announced into the global routing table via BGP
bgpPrefixstring
The BGP prefix detected on the global network, announcing the network
bgpPrefixNetworkAddressstring
BGP prefix network (the first) address
bgpPrefixLastAddressstring
BGP prefix last address
totalAddressesinteger
Number of IP addresses in the Network. For IPv6 networks, the value can range up to a 128-bit unsigned integer
carriersarray
List of Autonomous Systems (AS) announcing this network on BGP
asnstring
Autonomous System Number string
asnNumericinteger
Autonomous System Number
organisationstring
Registered Organisation
namestring
Registered name
registrystring
The Regional Internet Registry (RIR) the AS is registered with
registeredCountrystring
Registered Country ISO 3166-1 Alpha-2 code
registeredCountryNamestring
Registered Country localised name. The language is as defined by the 'localityLanguage' request parameter
registrationDatestring
Registration date in 'yyyy-mm-dd' format
registrationLastChangestring
Registration modification date in 'yyyy-mm-dd' format
totalIpv4Addressesinteger
Total number of IP addresses announced by the AS
totalIpv4Prefixesinteger
Total number of ipV4 BGP prefixes announced by the AS
totalIpv4BogonPrefixesinteger
Total number of ipV4 bogon prefixes announced by the AS
totalIpv6Prefixesinteger
Total number of ipV6 BGP prefixes announced by the AS
totalIpv6BogonPrefixesinteger
Total number of ipV6 bogon prefixes announced by the AS
rankinteger
Global rank by total number of IP addresses announced
rankTextstring
Global rank by total number of IP addresses announced including total
viaCarriersarray
List of Autonomous Systems (AS) detected at the last hop before the announced parties. Capped to the most significant 5.
asnstring
Autonomous System Number string
asnNumericinteger
Autonomous System Number
organisationstring
Registered Organisation
namestring
Registered name
registrystring
The Regional Internet Registry (RIR) the AS is registered with
registeredCountrystring
Registered Country ISO 3166-1 Alpha-2 code
registeredCountryNamestring
Registered Country localised name. The language is as defined by the 'localityLanguage' request parameter
totalIpv4Addressesinteger
Total number of IP addresses announced by the AS
rankinteger
Global rank by total number of IP addresses announced
rankTextstring
Global rank by total number of IP addresses announced including total
confidencestring
Geolocation confidence. Possible values: 'low', 'moderate', 'high'
confidenceAreaarray
Closed polygon representing estimated geolocation confidence area
latitudenumber
Latitude in in EPSG:4326 projection, as used in GPS
longitudenumber
Longitude in EPSG:4326 projection, as used in GPS

Sample Response

JSON View
403
Access denied, or your quota limit has exceeded

Sample Response

JSON View
404
Found no valid entry for the request

Sample Response

JSON View
405
The requested IP address is not valid

Sample Response

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

Sample Response

JSON View
Was this page helpful?