Autocomplete companies

Auto complete the name search

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Beginning of the name or the domain of a company

Example"ocea"

countryFilters?array<>

List of countries to filter for the autocompletion

Example["dk","se"]

excludeDomains?array<>

List of domains to exclude from the results

Example["ocean.com"]

forLookalikeSearch?boolean

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.

Defaulttrue

Response Body

`application/json`

curl -X POST "https://api.ocean.io/v2/autocomplete/companies" \  -H "Content-Type: application/json" \  -d '{    "name": "ocea"  }'

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

{
  "detail": "Conflicting API tokens provided in query parameters and headers"
}

{
  "detail": "Insufficient credits"
}

{
  "detail": "API token should be provided in headers or query parameters"
}

Empty

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Autocomplete companies

Query Parameters

Header Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Autocomplete companies

Query Parameters

Header Parameters

Request Body

Response Body

200application/json

400application/json

402application/json

403application/json

404

422application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`