query
locality
Get detailed geographical data for a specific locality, such as a pincode. For example, for a pincode value of 400603, the service returns its parent locations, including city, state, and country details.
Arguments
locality
LocalityEnum!Required
Enter if locality is 'pincode' or 'sector'.
localityValue
String!Required
Name of the locality.
city
StringName of the city.
country
StringName of the country.
state
StringState or the province.
Response
display_name
StringUser-friendly version of the geographical data, which may be more descriptive or formatted differently.
id
StringA unique identifier for the locality.
name
StringThe actual geographical data, such as country names (India), state names (Maharashtra), pin codes (400603), city names (Dubai), or local sectors (Deira).
parent_ids
[String]Identifiers for the parent of the current locality.
type
StringSpecifies the category of the address component, such as pincode, state, city, country, or sector.
localities
[LocalityParent]Representing the localities that are associated with or contained within the current locality.It provides detailed information about the parent localities, including their names, identifiers, and hierarchical relationships.
parent_uid
StringUnique Identifiers for the parent of the current locality.
meta
JSONSpecifies the meta information for the current locality
serviceability
JSONSpecifies the serviceability information for the current locality
Query
Loading...
Try it
Input Variables
Loading...
Response
Loading...
Was this section helpful?