Search locations by keyword.

GEThttps://api.envoapi.com/v1/search/locations

Find locations by keyword with EnvoAPI. Retrieve matching location names and Envo IDs to use in supported search filters.

Authorization headerReturns application/json

GET/v1/search/locations

curl "https://api.envoapi.com/v1/search/locations?keywords=United+States" \--header "Authorization: Bearer $ENVO_API_KEY" \--header "Accept: application/json"

const response = await fetch("https://api.envoapi.com/v1/search/locations?keywords=United+States",{headers: {Authorization: `Bearer ${process.env.ENVO_API_KEY}`,Accept: "application/json",},},);const body = await response.json();

import osimport requestsresponse = requests.get("https://api.envoapi.com/v1/search/locations",params={"keywords": "United States"},headers={"Authorization": f"Bearer {os.environ['ENVO_API_KEY']}","Accept": "application/json",},)body = response.json()

application/json · 0.3 KB

Matching locations and their Envo IDs.

{"data": {1 field},"locations": [5 items]{2 fields},"id": "geo_6yITcz","name": "United States"},{2 fields},"id": "geo_7wDtAj","name": "Washington DC-Baltimore Area"},{2 fields},"id": "geo_4PovMp","name": "District of Columbia, United States"},{2 fields},"id": "geo_6c4TtQ","name": "Washington, DC"},{2 fields}"id": "geo_2gc1uY","name": "California, United States"}]},"meta": {1 field}"creditCost": 1}}

invalid_requestA parameter is missing or has a value we cannot use. Read error.details, fix the value and try again. Errors guide →

{"error": {4 fields},"code": "invalid_request","message": "A request parameter is missing or invalid.","retryable": false,"details": []},"meta": {1 field}"requestId": "example"}}

invalid_api_keyYour API key is missing, wrong or switched off. Check it in your dashboard. Errors guide →

{"error": {4 fields},"code": "invalid_api_key","message": "Your API key is invalid or inactive.","retryable": false,"details": []},"meta": {1 field}"requestId": "example"}}

insufficient_creditsYour account has no credits left. Top up, then send a new call. Errors guide →

{"error": {4 fields},"code": "insufficient_credits","message": "Your account does not have enough credits.","retryable": false,"details": []},"meta": {1 field}"requestId": "example"}}

resource_not_foundNothing matched what you sent. Check it for typos. Errors guide →

{"error": {4 fields},"code": "resource_not_found","message": "The requested resource was not found.","retryable": false,"details": []},"meta": {1 field}"requestId": "example"}}

rate_limit_exceededToo many calls in a short time. Honor Retry-After; use bounded retries with backoff and jitter. Errors guide →

{"error": {4 fields},"code": "rate_limit_exceeded","message": "Your account has sent too many requests.","retryable": true,"details": []},"meta": {1 field}"requestId": "example"}}

GET

/v1/search/locations

Authorizations

BearerApiKey

Parameters

Query Parameters

keywords

required

string

>= 1 characters <= 500 characters

Example

United States

Responses

200

Matching locations and their Envo IDs.

application/json

object

data

required

object

locations

required

Array<object>

<= 50 items

object

required

The location's Envo ID.

string

/^geo_(?:0|[1-9A-Za-z][0-9A-Za-z]{0,5})$/

name

required

string

meta

required

object

creditCost

required

integer

<= 9007199254740991

Headers

Date

string

/^(?:Mon|Tue|Wed|Thu|Fri|Sat|Sun), (?:0[1-9]|[12][0-9]|3[01]) (?:Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} (?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9] GMT$/

Required response header.

Cache-Control

string

Allowed value: private, no-store

Required response header.

X-Request-Id

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Required response header.

X-Credits-Remaining

integer

<= 9007199254740991

Required response header.

X-RateLimit-Limit

integer

<= 9007199254740991

Required response header.

X-RateLimit-Remaining

integer

<= 9007199254740991

Required response header.

X-RateLimit-Reset

integer

<= 9007199254740991

Required response header.

Errors

Every error returns the same body. The status and error.code tell you what went wrong. The Errors guide covers handling and retries.

Body

application/json

object

error

required

object

code

required

string

Allowed values: invalid_request invalid_api_key insufficient_credits insufficient_scope account_suspended resource_not_found method_not_allowed not_acceptable unsupported_media_type rate_limit_exceeded internal_error response_too_large upstream_error service_unavailable upstream_timeout

message

required

string

>= 1 characters <= 512 characters

retryable

required

boolean

details

required

Array<object>

<= 16 items

object

field

required

string

>= 1 characters <= 128 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

code

required

string

Allowed values: identifier_count unknown_parameter repeated_parameter invalid_format invalid_value too_long

message

required

string

>= 1 characters <= 512 characters

meta

required

object

requestId

required

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Headers

Date

string

/^(?:Mon|Tue|Wed|Thu|Fri|Sat|Sun), (?:0[1-9]|[12][0-9]|3[01]) (?:Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} (?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9] GMT$/

Required response header.

Cache-Control

string

Allowed value: private, no-store

Required response header.

X-Request-Id

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Required response header.

Status	`error.code`	Meaning
400	`invalid_request`	A parameter is missing or has a value we cannot use. Read error.details, fix the value and try again.
401	`invalid_api_key`	Your API key is missing, wrong or switched off. Check it in your dashboard.
402	`insufficient_credits`	Your account has no credits left. Top up, then send a new call. Also sends `X-Credits-Remaining`, `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset`.
403	`insufficient_scope`, `account_suspended`	Your account is suspended or cannot use this endpoint. Resolve the account or its access first.
404	`resource_not_found`	Nothing matched what you sent. Check it for typos. Also sends `X-Credits-Remaining`, `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset`.
405	`method_not_allowed`	The route exists, but the request used a method other than GET. Use the method shown at the top of this page. Also sends `Allow`.
406	`not_acceptable`	The Accept header asks for a format we do not send. Ask for JSON with a supported Accept value.
415	`unsupported_media_type`	The request declared a media type we do not accept. Remove the body or use the documented media type.
429	`rate_limit_exceeded`	Too many calls in a short time. Honor Retry-After; use bounded retries with backoff and jitter. Also sends `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset`, `Retry-After`.
500	`internal_error`, `response_too_large`	Something failed on our side. Retry only when error.retryable is true. Also sends `X-Credits-Remaining`, `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset`.
502	`upstream_error`	A data source sent back something we could not use. Retry with bounded backoff. Also sends `X-Credits-Remaining`, `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset`.
503	`service_unavailable`	Lookups are unavailable for a moment. Follow error.retryable, and Retry-After when it is present. Also sends `Retry-After`, `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset`, `X-Credits-Remaining`.
504	`upstream_timeout`	The lookup ran out of time. Retry with bounded backoff. Also sends `X-Credits-Remaining`, `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset`.