API Response Details

Learn more about response structure and availability.

Depending on your subscription plan and the options you choose for your API request, the Geolocated.io API will respond using a series of different modules and objects. The response is comprehensive, ensuring that you receive an array of geographical and network-related information that's both relevant and precise.

Availability Indicators

When browsing the API response objects, you'll notice an availability column. This is to help you understand which subscription plan offers which fields and associated nested details. Here's a breakdown of what each indicator means:

All: When a field is marked with All, it means that this field, including its nested fields (unless specified otherwise), is available across all subscription plans.
Specific Name: If a field is labeled with a specific plan name, e.g. Starter, it signifies that this field and its associated nested fields (unless specified differently) are accessible to all subscribers with plans starting from Starter and above. However, it won't be available for the plans below Starter.

By consulting the availability column, you can easily determine which data fields are included in your chosen subscription plan. Make sure to upgrade or adjust your plan accordingly if you require additional data fields that are not available in your current plan.

Response Object

The following table contains the complete list of all available fields in the API response object.

Field Name	Data Type	Description	Availability
`ip`	String	The IP address being queried.	All
`version`	String	Version of IP address: either IPv4 or IPv6.	All
`addressType`	String	Indicates the classification of the IP address as defined in RFC 6890, such as "Private-Use", "Reserved" and others. Please note that geolocation information is only available for IP addresses classified as "Public". For addresses within the Special-Purpose IP ranges specified by RFC 6890, geolocation data cannot be provided.	All
`continentCode`	String	Two-letter code representing the continent of the IP address.	All
`continentName`	String	Name of the continent corresponding to the IP address.	All
`countryCode`	String	Two-letter ISO code of the country where the IP address is located.	All
`countryName`	String	Name of the country corresponding to the IP address.	All
`regionName`	String	Name of the region or state within the country of the IP.	All
`regionCode`	String	Abbreviated code of the region or state.	All
`cityName`	String	Name of the city where the IP address is located.	All
`district`	String	Name of the district or sub-region within the city.	All
`latitude`	Number (Float)	Geographical latitude coordinate of the IP address.	All
`longitude`	Number (Float)	Geographical longitude coordinate of the IP address.	All
`zipCode`	String	Postal or ZIP code for the location of the IP address.	All
`timeZone`	String	Time zone in which the IP address's location falls.	All
`iddCode`	String	International direct dialing code for the country of the IP.	All
`weatherStation`	JSON Object	Details of the nearest international weather observation station, as used by The Weather Channel (weather.com), Yahoo! Weather and many more.	Starter
`weatherStation.code`	String	The weather observation station code.
`weatherStation.name`	String	The name of the weather observation station.
`airport`	JSON Object	Details of the nearest airport to the IP address's location.	Starter
`airport.name`	String	Name of the nearest airport to the IP address.
`airport.region`	String	Region or state where the airport is located.
`airport.iata`	String	International Air Transport Association code for the airport.
`airport.icao`	String	International Civil Aviation Organization code for the airport.
`country`	JSON Object	Comprehensive details about the country related to the IP address.	Starter
`country.commonName`	String	Commonly recognized name of the country.
`country.officialName`	String	Official, formal name of the country.
`country.capital`	String	Capital city of the country.
`country.flag`	String	URL to the flag image of the country.
`country.flag_emoji`	String	Emoji representation of the country's flag.
`country.isoCode`	JSON Object	Set of international standard codes representing the country.
`country.isoCode.numeric`	Number	ISO 3166-1 numeric code for the country.
`country.isoCode.alpha2`	String	ISO 3166-1 alpha-2 (two-letter) code for the country.
`country.isoCode.alpha3`	String	ISO 3166-1 alpha-3 (three-letter) code for the country.
`country.demonym`	String	Nationality or the term used to describe the people of the country.
`country.iddCode`	String	International direct dialing code of the country.
`country.population`	Number	Population of the country.
`country.totalArea`	Number	Total land area of the country in square kilometers.
`country.tld`	String	Top-level domain associated with the country (e.g., .us, .uk).
`country.isInEuropeanUnion`	Boolean	Indicates if the country is a member of the European Union.
`country.geoNameId`	Number	ID of the record in GeoNames database associated with the country's name.
`country.timezones`	Array of Strings	Names of timezones, in the IANA Time Zone Database, in which the country falls.
`country.languages`	Array of JSON Objects	List of languages spoken in the country.
`country.languages.name`	String	English name of language.
`country.languages.alpha2`	String	Two-letter (ISO 639-1) code for the language.
`country.languages.alpha3`	String	Three-letter (ISO 639-2) bibliographic code.
`country.continent`	JSON Object	Details about the continent where the country is located.
`country.continent.name`	String	Name of the continent where the country is located.
`country.continent.code`	String	Two-letter code representation of the continent.
`country.continent.region`	String	Specific region of the continent where the country resides.
`country.neighbours`	JSON Array of Strings	List of two-letter country codes representing the neighbouring countries.	Growth
`currency`	JSON Object	Information related to the country's official currency.	Starter
`currency.name`	String	Name of the country's official currency.
`currency.code`	String	ISO code representation of the country's currency.
`currency.symbol`	String	Symbolic representation of the country's currency.
`timeZoneInfo`	JSON Object	Comprehensive details about the time zone associated with the given IP address.	Growth
`timeZoneInfo.zoneName`	String	The name of the time zone.
`timeZoneInfo.abbreviation`	String	An abbreviation representing the time zone, like "MST" for Mountain Standard Time.
`timeZoneInfo.currentTime`	String	The current time in the specified time zone, formatted as an ISO date-time string.
`timeZoneInfo.unixTime`	Number	The current time in the specified time zone, as UNIX epoch.
`timeZoneInfo.utcOffset`	Number	The offset in seconds from Coordinated Universal Time (UTC).
`timeZoneInfo.isDaylightSaving`	Boolean	Indicates whether Daylight Saving Time (DST) is in effect or not.
`timeZoneInfo.sunrise`	String	The local time of sunrise in 24-hour format.
`timeZoneInfo.sunset`	String	The local time of sunset in 24-hour format.
`connection`	JSON Object	Details regarding the connection associated with the IP address.	Scale
`connection.isp`	String	Internet Service Provider handling the IP address.
`connection.organization`	String	Name of the organization associated with the IP, if applicable.
`connection.asn`	Number	Autonomous System Number representing the ISP.
`connection.as`	String	Name of the Autonomous System (typically, the ISP).
`connection.connectionType`	String	Type of connection, e.g., "Corporate", "Residential", etc.
`connection.userType`	String	Type of user, indicating the nature of IP usage, such as "hosting", "ISP", etc.