Skip to main content
GET
Autocomplete

Authorizations

X-API-Key
string
header
required

Query Parameters

entity_type
enum<string>
required

The type of entity to suggest. Only business is currently supported.

Available options:
business
business.name
string
required

Partial business name to complete.

Minimum string length: 1
Examples:

"apple"

"acme plumb"

state
enum<string> | null

Restrict suggestions to businesses registered in this state.

Available options:
AL,
AK,
AZ,
AR,
CA,
CO,
CT,
DE,
DC,
FL,
GA,
HI,
ID,
IL,
IN,
IA,
KS,
KY,
LA,
ME,
MD,
MA,
MI,
MN,
MS,
MO,
MT,
NE,
NV,
NH,
NJ,
NM,
NY,
NC,
ND,
OH,
OK,
OR,
PA,
RI,
SC,
SD,
TN,
TX,
UT,
VT,
VA,
WA,
WV,
WI,
WY,
PR,
VI,
AE,
AA,
AP,
GU,
AS
limit
integer
default:10

Maximum suggestions to return.

Required range: 1 <= x <= 20

Response

Successful Response

Response for GET /autocomplete.

query
string
required

The query the suggestions were generated for.

Example:

"apple"

suggestions
AutocompleteSuggestion (v1) · object[]

Suggestions ordered by relevance, best first.