Documentation menu

← Parcels

API reference

Suggest matches for typed text

GET/v1/suggestion

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.

Parameters

query

qrequiredstring
The text typed so far. At least 2 characters.
kind"address" | "parcel" | "jurisdiction"[] | null
Kinds of match to include. One of address, parcel or jurisdiction. Repeatable. Defaults to all kinds.
jurisdictionstring[] | null
A jurisdiction id. Address and parcel matches are limited to it. Repeatable.
fipsstring[] | null
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.

Responses

200
array of suggestion objects
A page of suggestions.
401
ProblemDetail
credential_missing, credential_invalid or credential_expired. The request has no valid credential.
403
ProblemDetail
scope_missing, person_required, api_key_not_accepted or entitlement_missing. The credential or plan does not allow this request. detail names the reason.
422
ProblemDetail
parameter_invalid, id_malformed or a cursor code. A parameter is missing or invalid. errors lists each one.
429
ProblemDetail
rate_limited. Too many requests. Retry after the Retry-After interval. Nothing is charged.
501
ProblemDetail
not_available. Suggestions are not available yet.

Credits

Free.

Example request

curl -G 'https://api.placestack.com/v1/suggestion' \
  --data-urlencode 'q=Raleigh' \
  -H "Authorization: Bearer $PLACESTACK_API_KEY"

Example response

{
  "object": "list",
  "data": [
    {
      "object": "suggestion",
      "kind": "address",
      "label": "4516 Printer Ln",
      "detail": "Raleigh, Wake County, NC",
      "query": {
        "key": "string"
      },
      "href": "/v1/parcel/prc_01h455vb4pex5vsknk084sn02q"
    }
  ],
  "has_more": true,
  "next_cursor": "eyJrIjoiMjAyNi0xMC0wMSIsInQiOjQyfQ",
  "suppressed": 0,
  "total": {
    "value": 1,
    "relation": "eq"
  }
}

Next steps

Zoning

Zoning classifications, with the uses each allows and its dimensional standards, cited to the ordinance.

Continue