OCocean
Autocomplete

Autocomplete locations

Changed on

Auto complete the location search

post/v2/autocomplete/locations

Request

  • Base URL
    https://api.ocean.io
  • URL
    https://api.ocean.io/v2/autocomplete/locations
  • Auth
    none declared

Query parameters

apiTokenstring nullable

Headers

x-api-tokenstring nullable

Request body

querystring required

Beginning of the location

limitinteger

Number of locations to return. Default is 5 if not specified, maximum is 15.

locationType'companies' | 'people'

Example request

{
  "query": "londo",
  "limit": 5
}

Response

Successful Response

Example response

{
  "locations": [
    {
      "countryCode": "us",
      "filterCode": "us-CA",
      "name": "California",
      "parentCode": "us",
      "parentName": "United States"
    }
  ]
}

Changes

  • 82337760de72Revision changes
    • breaking

      the request property's minLength was increased from 0 to 1

    • info

      added the non-success response with the status