Get locations typeahead suggestions scoped by country code

Send Authorization: Token $CASAFARI_TOKEN with your existing API token; see where to get it.

The same path under /api, signed in with a bearer token, is in the REST API reference: POST /api/v1/references/locations/typeahead.

#Description

Returns location typeahead suggestions within the given country (ES or PT).

#Request body

Content type application/json. Optional. Type: object.

#Example request

Placeholders only: replace the token and the values with your own.

curl -X POST "https://api.casafari.com/v1/references/locations/typeahead" \
  -H "Authorization: Token $CASAFARI_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "country_codes": [
    "PT"
  ],
  "name": "lisboa",
  "lang": "en",
  "size": 30
}'

#Responses

#200

Type: object.

{
  "typeahead": [
    {
      "location_id": 1296,
      "name": "Lisboa",
      "matched_name": "Lisboa",
      "administrative_level": "Distrito",
      "breadcrumbs": [
        {
          "location_id": 499,
          "name": "Portugal"
        },
        {
          "location_id": 1296,
          "name": "Lisboa"
        }
      ]
    }
  ]
}

#401 Unauthorized

Type: object.

#403 Forbidden

Type: object.

#Related pages

• Get agencies (GET /v1/references/agencies)
• Get agents (GET /v1/references/agents)
• Get conditions (GET /v1/references/conditions)
• Get features (GET /v1/references/features)
• The same path in the REST API reference (POST /api/v1/references/locations/typeahead)
• Existing Casafari API v1: all operations
• Existing API customers: token and documentation