Skip to main content
GET
Resolve user input to ranked geo candidates
Use this endpoint to turn user-entered text into candidate geo_id values. Typical input is a partial location string such as city, ZIP, county, or jurisdiction name.
Use the returned geo_id in downstream permit and signal endpoints.

Authorizations

X-API-Key
string
header
required

Query Parameters

query
string
required

Free-form text input (aliases: q, address, text).

Required string length: 1 - 200
state
string

Optional two-letter state filter.

Pattern: ^[A-Za-z]{2}$
Example:

"WA"

geo_type
enum<string>

Optional scope filter.

Available options:
property,
jurisdiction,
city,
zip,
county,
state
limit
integer
default:5

Maximum candidates to return.

Required range: 1 <= x <= 20

Response

Candidates found.

query
string
required
count
integer
required
Required range: x >= 0
candidates
object[]
required