suggestion

Suggest matches for typed text

Suggests jurisdictions, addresses and parcel numbers as the user types.

Each match includes the query parameters that fetch it and, where one exists, its href.

get/v1/suggestion

Request

Base URL: http://localhost:3030
URL: http://localhost:3030/v1/suggestion
Auth: HTTP bearer

Query parameters

qstring required

The text typed so far. At least 2 characters.

kindstring[] nullable

Kinds of match to include. One of address, parcel or jurisdiction. Repeatable. Defaults to all kinds.

jurisdictionstring[] nullable

A jurisdiction id. Address and parcel matches are limited to it. Repeatable.

[
  "jur_01h455vb4pex5vsknk084sn02q"
]

fipsstring[] nullable

A Census GEOID: 2 digits for a state or 5 for a county, such as 48 or 48453. Address and parcel matches are limited to it. Repeatable.

sizeinteger

Maximum number of suggestions, between 1 and 20. Defaults to 8.

Response

A page of suggestions.

object'list' required

The object's type. Always list.

has_moreboolean required

Whether there are more results after this page.

next_cursorstring nullable required

The cursor for the next page. Send it as cursor. Null on the last page.

suppressedinteger required

The number of matching results withheld because the plan does not include them.

Example response

{
  "data": [
    {
      "label": "4516 Printer Ln",
      "detail": "Raleigh, Wake County, NC",
      "href": "/v1/parcel/prc_01h455vb4pex5vsknk084sn02q"
    }
  ],
  "next_cursor": "eyJrIjoiMjAyNi0xMC0wMSIsInQiOjQyfQ"
}

Changes

No recorded changes to this operation across all 1 revision of this API.