Autocomplete locations

Quickstart#

Location filters use filterCode values rather than plain country codes. Use this endpoint to resolve a user's typed location into the correct filter codes for primaryLocations.includeLocations.

curl -X POST "https://api.ocean.io/v2/autocomplete/locations" \
  -H "X-Api-Token: YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "londo",
    "locationType": "companies",
    "limit": 5
  }'

import requests

response = requests.post(
    'https://api.ocean.io/v2/autocomplete/locations',
    headers={'X-Api-Token': 'YOUR_API_TOKEN'},
    json={'query': 'londo', 'locationType': 'companies', 'limit': 5},
)
data = response.json()

const response = await fetch('https://api.ocean.io/v2/autocomplete/locations', {
  method: 'POST',
  headers: { 'X-Api-Token': 'YOUR_API_TOKEN', 'Content-Type': 'application/json' },
  body: JSON.stringify({ query: 'londo', locationType: 'companies', limit: 5 }),
});
const data = await response.json();

Example response:

{
  "locations": [
    {
      "filterCode": "gb-ENG-LND",
      "name": "London",
      "countryCode": "gb",
      "parentCode": "gb-ENG",
      "parentName": "England",
      "type": 4
    }
  ]
}

Use filterCode in companiesFilters.primaryLocations.includeLocations or peopleFilters.locations.includeLocations.

Parameters#

Location types#

The type field in the response indicates the geographic level: