OCocean
Autocomplete

Autocomplete companies

Changed on

Auto complete the name search

post/v2/autocomplete/companies

Request

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

Query parameters

apiTokenstring nullable

Headers

x-api-tokenstring nullable

Request body

namestring required

Beginning of the name or the domain of a company

countryFiltersstring[] nullable

List of countries to filter for the autocompletion

excludeDomainsstring[] nullable

List of domains to exclude from the results

forLookalikeSearchboolean

When false, returns all matching companies without domain validation or status filters. WARNING: Do not set this parameter to false if the autocomplete results will be used as input for a lookalike search.

Example request

{
  "name": "ocea",
  "countryFilters": [
    "dk",
    "se"
  ],
  "excludeDomains": [
    "ocean.com"
  ]
}

Response

Successful Response

Example response

{
  "companies": [
    {
      "domain": "ocean.io",
      "logo": "https://cdn2.ocean.io/companies-logos-v1/domain.com/020539e284d9318e805301b672ad23047c30818a.png",
      "name": "Ocean"
    }
  ]
}

Changes

  • 82337760de72Revision changes
    • breaking

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

    • breaking

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

    • breaking

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

    • info

      added the non-success response with the status