Reverse Geocoding with Timezone API
Introduction
The Reverse Geocoding with Timezone API combines the data output of Reverse Geocoding to City API and Time Zone by Location API, providing a comprehensive API solution for building location-based applications.
It replaces the need for calling these two APIs separately, making your application faster and saving your monthly API quotas. This is particularly important for applications that rely heavily on location-based data and require frequent API calls.
Get Started
This API is part of the Reverse Geocoding API Package and is available in free and paid plans. Please visit the Reverse Geocoding API Package package page for limits and pricing information.
Endpoint
GET
https://api-bdc.net/data/reverse-geocode-with-timezone
Request
Parameter
Type
Required
Description
Parameter
latitudeType
number (double)Required
YesDescription
Latitude value as per WGS 84 reference system (GPS system). Expected values are in [-90, 90] rangeParameter
longitudeType
number (double)Required
YesDescription
Longitude value as per WGS 84 reference system (GPS system). Expected values are in [-180, 180] rangeParameter
localityLanguageType
stringRequired
Optional, default value: enDescription
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
keyType
stringRequired
YesDescription
Your API keyResponses
200OK
200
OK
Sample Query
GET
https://api-bdc.net/data/reverse-geocode-with-timezone?latitude=-34.93126&longitude=138.5967&localityLanguage=en&key=[YOUR API KEY]
Schema
application/json
latitudenumberRequested Latitude
latitudenumber
Requested Latitude
longitudenumberRequested Longitude
longitudenumber
Requested Longitude
localityLanguageRequestedstringlocalityLanguage input parameter received
localityLanguageRequestedstring
localityLanguage input parameter received
continentstringLocalised Continent name in the requested language, if available
continentstring
Localised Continent name in the requested language, if available
continentCodestringContinent code
continentCodestring
Continent code
countryNamestringLocalised Country name in the requested language, if available
countryNamestring
Localised Country name in the requested language, if available
countryCodestringCountry code as defined by ISO 3166-1 standard
countryCodestring
Country code as defined by ISO 3166-1 standard
principalSubdivisionstringLocalised principal subdivision name in the requested language, if available
principalSubdivisionstring
Localised principal subdivision name in the requested language, if available
principalSubdivisionCodestringPrincipal subdivision code as defined by ISO 3166-2 standard
principalSubdivisionCodestring
Principal subdivision code as defined by ISO 3166-2 standard
citystringThe 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
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
localitystringRepresents the smallest geographic area recognised to which the target belongs. The language, if available, is as defined by 'localityLanguage' request parameter
localitystring
Represents the smallest geographic area recognised to which the target belongs. The language, if available, is as defined by 'localityLanguage' request parameter
postcodestringPostcode, if available
postcodestring
Postcode, if available
plusCodestringOpen Location Code
plusCodestring
Open Location Code
fipsFIPS 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.
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.
statestringState-level FIPS codes have two digits
statestring
State-level FIPS codes have two digits
countystringA three digits County-level FIPS code.
countystring
A three digits County-level FIPS code.
countySubdivisionstringFIPS five digits County Subdivision Code
countySubdivisionstring
FIPS five digits County Subdivision Code
placestringFIPS five digits place code, omitted if unavailable
placestring
FIPS five digits place code, omitted if unavailable
csdCodestringCSD (Census Subdivision) code, omitted if unavailable. Canadian Geographic Codes. Visit CSD FAQ page for more information.
csdCodestring
CSD (Census Subdivision) code, omitted if unavailable. Canadian Geographic Codes. Visit CSD FAQ page for more information.
localityInfolocalityInfo object
localityInfo
localityInfo object
administrativearrayAdministrative authorities as ordered by area (most significant first). Omitted if no administrative boundaries are available
administrativearray
Administrative authorities as ordered by area (most significant first). Omitted if no administrative boundaries are available
namestringLocalised name of the place in the requested language, if available. The language is as defined by the 'localityLanguage' request parameter
namestring
Localised name of the place in the requested language, if available. The language is as defined by the 'localityLanguage' request parameter
descriptionstringLocalised description 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
isoNamestringISO 3166-2 standard name, if available
isoNamestring
ISO 3166-2 standard name, if available
orderintegerOrder value consistent across all entities in the Locality Info parent object. Ordered by geographic area (most significant first)
orderinteger
Order value consistent across all entities in the Locality Info parent object. Ordered by geographic area (most significant first)
adminLevelintegerAn administrative level as defined by OpenStreetMaps project
adminLevelinteger
An administrative level as defined by OpenStreetMaps project
isoCodestringISO 3166-2 standard code, if available
isoCodestring
ISO 3166-2 standard code, if available
wikidataIdstringWikidata item identifier, if available
wikidataIdstring
Wikidata item identifier, if available
geonameIdintegerUnique identifier given by GeoNames.org, if available
geonameIdinteger
Unique identifier given by GeoNames.org, if available
chinaAdminCodestringChina Administrative division code. Only available for locations based in China and omitted for others
chinaAdminCodestring
China Administrative division code. Only available for locations based in China and omitted for others
informativearrayNon-administrative boundaries as ordered by area (most significant first). Omitted if unavailable
informativearray
Non-administrative boundaries as ordered by area (most significant first). Omitted if unavailable
namestringLocalised name of the place in the requested language, if available. The language is as defined by the 'localityLanguage' request parameter
namestring
Localised name of the place in the requested language, if available. The language is as defined by the 'localityLanguage' request parameter
descriptionstringLocalised description 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
isoNamestringISO 3166-2 standard name, if available
isoNamestring
ISO 3166-2 standard name, if available
orderintegerOrder value consistent across all entities in the Locality Info parent object. Ordered by geographic area (most significant first)
orderinteger
Order value consistent across all entities in the Locality Info parent object. Ordered by geographic area (most significant first)
adminLevelintegerAn administrative level as defined by OpenStreetMaps project
adminLevelinteger
An administrative level as defined by OpenStreetMaps project
isoCodestringISO 3166-2 standard code, if available
isoCodestring
ISO 3166-2 standard code, if available
wikidataIdstringWikidata item identifier, if available
wikidataIdstring
Wikidata item identifier, if available
geonameIdintegerUnique identifier given by GeoNames.org, if available
geonameIdinteger
Unique identifier given by GeoNames.org, if available
chinaAdminCodestringChina Administrative division code. Only available for locations based in China and omitted for others
chinaAdminCodestring
China Administrative division code. Only available for locations based in China and omitted for others
timeZonetimeZone object
timeZone
timeZone object
ianaTimeIdstringThe unique identifier of the time zone from the IANA Time Zone Database (e.g., "America/New_York").
ianaTimeIdstring
The unique identifier of the time zone from the IANA Time Zone Database (e.g., "America/New_York").
displayNamestringdisplayName object
displayNamestring
displayName object
effectiveTimeZoneFullstringThe full name of the effective time zone, adjusted for daylight saving (e.g., "Eastern Daylight Time").
effectiveTimeZoneFullstring
The full name of the effective time zone, adjusted for daylight saving (e.g., "Eastern Daylight Time").
effectiveTimeZoneShortstringThe abbreviated name of the effective time zone, adjusted for daylight saving (e.g., "EDT").
effectiveTimeZoneShortstring
The abbreviated name of the effective time zone, adjusted for daylight saving (e.g., "EDT").
utcOffsetSecondsintegerThe effective offset from UTC in seconds, adjusted for daylight saving time.
utcOffsetSecondsinteger
The effective offset from UTC in seconds, adjusted for daylight saving time.
utcOffsetstringThe effective offset from UTC, formatted as a string and adjusted for daylight saving time.
utcOffsetstring
The effective offset from UTC, formatted as a string and adjusted for daylight saving time.
isDaylightSavingTimebooleanA boolean value indicating whether daylight saving time is currently in effect.
isDaylightSavingTimeboolean
A boolean value indicating whether daylight saving time is currently in effect.
localTimestringThe current local time in the specified time zone, formatted in ISO 8601 "O" format.
localTimestring
The current local time in the specified time zone, formatted in ISO 8601 "O" format.
utcTimestringThe corresponding UTC time, formatted in ISO 8601 "O" format. This value is omitted if the 'utcReference' parameter was not supplied or was invalid.
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.
Sample Response
JSON View
400Bad request
400
Bad request
Sample Response
JSON View
401Invalid coordinates
401
Invalid coordinates
Sample Response
JSON View
403Access denied, or your quota limit has exceeded
403
Access denied, or your quota limit has exceeded
Sample Response
JSON View
500An error has occurred and did not complete your request. Please try again
500
An error has occurred and did not complete your request. Please try again
Sample Response
JSON View
Was this page helpful?