Autocomplete keywords

Quickstart#

Keywords are free-text descriptors used in companiesFilters.keywords on Search Companies. Use this endpoint to suggest valid keyword values as the user types.

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

import requests

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

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

Example response:

{
  "keywords": ["software", "software development", "software engineering", "software as a service", "software testing"]
}

Pass the selected keyword directly into the keywords filter on your search request.

Parameters#