Skip to main content
POST
Find by details

Authorizations

X-API-KEY
string
header
required

Body

application/json

Request body for finding places. Each field is optional. However, you must provide at least one field to perform a valid search. The values a filter accepts can be listed with GET /v1/knowledge-graph/places/values/{filter}.

query
string

Text query to search for places by name or description. Examples: 'Paris', 'Silicon Valley'

Example:

"Paris"

categories
string[]

Place categories, as published in the category field of results (e.g., 'Location', 'Facility')

Example:
types
string[]

Place types, as published in the type field of results (e.g., 'City', 'Region', 'Facility')

Example:
continents
string[]

Continents, as published in the continent field of results (e.g., 'Europe')

Example:
countries
string[]

Country codes using the ISO 3166-1 A-2 format (e.g., 'US' for United States, 'FR' for France, 'GB' for Great Britain)

Pattern: ^[A-Z]{2}$
Example:
regions
string[]

Regions, as published in the region field of results (e.g., 'Ile-de-France Region'). Region names are long and vary by country, so list them with GET /v1/knowledge-graph/places/values/regions rather than constructing them

Example:

Response

200 - application/json

Successful response with places data

Response containing places results and metadata

results
object[]
required

Array of places results

metadata
object
required
usage
object

Optional. Present for token-billing accounts only. Reports the number of tokens consumed by this request.