Retrieves a list of geographical localities (such as countries, states, cities, sectors, or pincodes) based on the provided filters.
Supports hierarchical queries, making it suitable for address workflows and system integrations. These hierarchies can be obtained using the country query.
Example use cases:
- To retrieve all states in India: set `locality = state`, `country = "IN"`
- To retrieve all cities in Andhra Pradesh: set `locality = city`, `country = "IN"`, `state = "ANDHRA_PRADESH"` (use the display_name or name of the state)
- To retrieve all pincodes in Hyderabad: set `locality = pincode`, `country = "IN"`, `city = "Hyderabad"` (use the display_name or name of the city)
Workflow:
1. Fetch all states for a country.
2. Use the state’s display_name or name from the previous response to fetch its cities.
3. Use the city’s display_name or name from the previous response to fetch its pincodes.
Arguments
locality
LocalityType!Required
Type of locality to retrieve (e.g., "state", "city", "pincode", "sector").
city
StringName of the city (e.g., "Hyderabad").
country
StringTwo-letter ISO code representing the country (e.g., "IN" for India, "US" for the United States).
pageNo
IntThe page number to navigate through the given set of results. Default value is 1.
pageSize
IntThe number of items to retrieve in each page. Default value is 12.
search
StringThis parameter is used to filter or search the records by locality display_name.
state
StringState or the province.
sector
StringSector name of mentioned address.
Response
Query
Try it
Input Variables
Response
Was this section helpful?