Place Search API
AvailableSearches the built-in city list by name and returns coordinates, IANA zone and the UTC offset in force on a given date/time.
Call it with POST /v1/utilities/geo-search. Input: name. Output: JSON, as a direct response. Each successful call costs 1 credit.
- Endpoint
- POST /v1/utilities/geo-search
- Input
- Name
- Output
- JSON
- Delivery
- Direct response
- Cost
- 1 credit
- Compute class
- Light
Example response
Fields in data (inferred from the example)
query· stringplaces· array of objectcatalogue· object
Example response
Captured from the live engine with a sandbox key (so credits_used is 0) and trimmed: long arrays keep their first items and images are replaced by a placeholder.
Loading the example…
Request schema and every field: the Utilities reference.
Place Search API: common questions
What does the Place Search API return?
Searches the built-in city list by name and returns coordinates, IANA zone and the UTC offset in force on a given date/time. The response's data object includes query, places and catalogue. See the reference for an example response.
What input does Place Search need?
Name.
How much does a Place Search call cost?
1 credit per successful call; a failed call is not charged. Plans and top-ups are on the pricing page.
Can I try it before paying?
Yes. Every account gets sandbox keys and trial credits, so you can call it from your own code before choosing a plan.