---
canonical_url: "https://docs.composio.dev/toolkits/ocean_io"
markdown_url: "https://docs.composio.dev/toolkits/ocean_io.md"
product: "platform"
version: null
last_updated: null
---

# Ocean.io

Ocean.io provides GTM intelligence for searching, enriching, and identifying companies and people that match an ideal customer profile.

- **Category:** sales & crm
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `OCEAN_IO`
- **Version:** 00000000_00

## Tools

### Autocomplete Values

**Slug:** `OCEAN_IO_AUTOCOMPLETE_VALUES`

Return Ocean.io suggestions for a company, keyword, job title, location, or skill query. Each call costs 0.1 credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum suggestions to return (1-15). Valid for keyword, job_title, location, and skill resources; omit it for company autocomplete. |
| `query` | string | Yes | Partial company name or domain, keyword, job title, location, or skill. Company requests send this value as `name`; all others send it as `query`. |
| `resource` | string ("company" | "keyword" | "job_title" | "location" | "skill") | Yes | Kind of value to autocomplete. |
| `location_type` | string ("companies" | "people") | No | Whether location suggestions should use company or people locations. Valid only when resource is `location`. |
| `country_filters` | array | No | ISO country codes used to filter company suggestions. Valid only when resource is `company`. |
| `exclude_domains` | array | No | Company domains to omit. Valid only when resource is `company`. |
| `for_lookalike_search` | boolean | No | For company suggestions, keep true when results will seed a lookalike search. Valid only when resource is `company`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Enrich Company

**Slug:** `OCEAN_IO_ENRICH_COMPANY`

Match and enrich one company from a domain, name, or LinkedIn URL, optionally using people as matching context. A matched result costs 0.1 credits. If Ocean.io must crawl the domain, the response explicitly reports processing instead of claiming enrichment completed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | array | No | Ocean.io company fields to return. Omit to request all available fields. |
| `people` | array | No | People associated with the company that Ocean.io can use as additional matching context. |
| `company` | object | Yes | Company to match. Provide at least one of domain, name, or linkedin_url. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Enrich Person

**Slug:** `OCEAN_IO_ENRICH_PERSON`

Match and enrich one professional profile using person identifiers and optional company context. Returns privacy-sensitive professional profile data and costs 0.1 credits per result. It never requests or returns email or phone reveal data. If Ocean.io lacks current data, this operation may start background crawling and report processing instead of completed data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `person` | object | Yes | Person to match using documented identifiers. More known values can improve matching, but this tool never requests contact reveal. |
| `company` | object | No | Optional current-employer context used to disambiguate the person. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Gather Missing Company Data

**Slug:** `OCEAN_IO_GATHER_MISSING_COMPANY_DATA`

Check 1-500 company domains and return every Ocean.io outcome category. Although this call is free, it has an external side effect: for domains with missing data, it can irreversibly start provider-side background data gathering.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domains` | array | Yes | Company domains to check (1-500). This free call can irreversibly queue provider-side background data gathering for domains whose data is missing. Every entry must be nonempty. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Credit Balance

**Slug:** `OCEAN_IO_GET_CREDIT_BALANCE`

Return general and specialized Ocean.io credit balances plus the remaining daily request allowance and reset time. This free call reports quota values but does not identify or infer the account's subscription plan.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Data Field Values

**Slug:** `OCEAN_IO_GET_DATA_FIELD_VALUES`

Return one Ocean.io taxonomy used to construct search filters, with optional case-insensitive local filtering and a bounded result set. This call is free.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum matching taxonomy values to return (1-500). |
| `query` | string | No | Optional case-insensitive local text filter. Matches value names and their category, department, country, or region labels as applicable. |
| `category` | string ("industries" | "linkedin_industries" | "technologies" | "regions" | "seniorities" | "departments" | "sub_departments") | Yes | Taxonomy to return from Ocean.io's data fields. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Lookup Companies

**Slug:** `OCEAN_IO_LOOKUP_COMPANIES`

Lookup and enrich 1-1000 companies by domain. Only successful matches are returned, at a cost of 0.05 credits per found result; no matches is a successful empty response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | array | No | Company fields to include in matched results. Omit to return all available fields. |
| `domains` | array | Yes | Company domains to look up (1-1000), without protocols or paths. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Lookup People

**Slug:** `OCEAN_IO_LOOKUP_PEOPLE`

Lookup up to 1000 professional profiles by LinkedIn handle, Ocean.io person ID, or both. This returns privacy-sensitive personal profile data and costs 0.05 credits per found result. It does not request or expose email addresses, phone numbers, or other contact-reveal data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ocean_ids` | array | No | Ocean.io person IDs to look up. Empty lists are ignored. |
| `linkedin_handles` | array | No | LinkedIn profile handles to look up, without requiring full profile URLs. Empty lists are ignored. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Companies

**Slug:** `OCEAN_IO_SEARCH_COMPANIES`

Search and page through companies using at least one non-empty company or employee filter. Results cost 0.2 credits each; the default 5-result first page costs at most 1 credit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum companies on this page. Defaults to 5 (at most 1 credit); each returned result costs 0.2 credits. |
| `cursor` | string | No | Opaque continuation token from a previous call; it restores the original filters, fields, and page size. |
| `fields` | array | No | Company fields to include in each result. Defaults to domain, name, primaryCountry, and companySize. Explicit null requests all available fields. Use GET_DATA_FIELD_VALUES for supported taxonomy values. |
| `people_filters` | object | No | Typed employee criteria; each returned company must have at least one matching person. |
| `company_filters` | object | No | Typed company and lookalike criteria for the search. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search People

**Slug:** `OCEAN_IO_SEARCH_PEOPLE`

Search one page of professional profiles with typed person and employer filters; the first page requires at least one non-empty filter. Results cost 0.2 credits each, so the default 5-result first page costs at most 1 credit. This tool does not request contact reveal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum people in this page. Defaults to 5 (at most 1 credit); Ocean.io charges 0.2 credits per returned result. |
| `cursor` | string | No | Opaque continuation token from a previous response. It restores the original filters, projection, and page settings. |
| `fields` | array | No | Profile and employer fields to return. Defaults to id, domain, name, jobTitle, and linkedinUrl. Explicit null uses Ocean.io's larger default field set. Contact-address projections are intentionally unavailable. |
| `people_filters` | object | No | Typed criteria applied to professional profiles. |
| `company_filters` | object | No | Typed criteria applied to each profile's current employer. |
| `people_per_company` | integer | No | Maximum matching people per company. When set, total accessible results are capped at 10,000. |
| `job_title_threshold` | number | No | Similarity threshold for job-title matching. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |