Skip to main content
GET
Search locations by name and optionally filter by type

Authorizations

Authorization
string
header
required

API key provided as a Bearer token

Query Parameters

name
string
required

Location name to search for

Example:

"san francisco"

type
enum<string>

Filter by specific location type

Available options:
CITY,
STATE,
REGION,
COUNTRY
Example:

"CITY"

location_type
enum<string>

Alias for 'type' parameter

Available options:
CITY,
STATE,
REGION,
COUNTRY
Example:

"CITY"

Response

Successful search results

success
boolean
required
Example:

true

data
object
required
meta
object
required