Skip to main content
GET
SDK

Authorizations

Authorization
string
header
required

Voyant Data API token, scoped per sub-product (data:{product}:read). Sent as Authorization: Bearer <token>.

Query Parameters

q
string
required

Search text, at least 2 characters. Matched as a case-insensitive prefix of the primary name and every alias.

Minimum string length: 2
type
enum<string>

Restrict to a single place type. Combined with types when both are given. Place type. island is a curated island that is not itself a subdivision (Santorini, Capri); area is a curated travel area (Cinque Terre, Cappadocia, Serengeti).

Available options:
region,
country,
subdivision,
island,
area,
city,
port,
river,
sea,
ocean,
canal,
lake
types
string

Comma-separated list of place types to restrict to. Unknown values are ignored.

country
string

ISO 3166-1 alpha-2 country code to restrict to (case-insensitive).

Pattern: ^[A-Za-z]{2}$
limit
integer
default:20

Maximum number of results.

Required range: 1 <= x <= 50
lang
string
names
boolean

Response

Ranked search results as { data, totalCount }, where totalCount is the number of places returned.

data
object[]
required
totalCount
integer
required
nextCursor
string