The Ocean.io API Documentation API from Ocean.io — 0 operation(s) for ocean.io api documentation.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/ocean-io-ocean-io-api-documentation-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Ocean.io API Documentation API
summary: Welcome to Ocean.io's API.
description: "\n Welcome to Ocean.io's API.\n The API can be used to access all our API endpoints, such as our enrich API to look up company information, or our discover API to identify companies based on specific search criteria such as semantic similarity, technologies or industries.\n Ocean.io's APIs are a set of HTTPS endpoints that you can use to retrieve and integrate Ocean.io's data into your existing workflows.\n All requests should be made through https and the request and response bodies should be formatted in JSON.\n "
version: 2.0.0
x-logo:
url: https://cdn2.ocean.io/assets/images/logo/256x92_ocean-logo.svg
servers:
- url: https://api.ocean.io
tags:
- name: Ocean.io API Documentation
paths: {}
webhooks:
reveal_emails:
post:
summary: Reveal Email Results
description: 'When the email verifications are done, the results will be sent to you via a POST request to
the url you passed in the Reveal endpoint.'
operationId: reveal_email_resultsreveal_emails_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PublicRevealEmailWebhookResult'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ocean.io API Documentation
people_search_emails:
post:
summary: People Search Email Results
description: 'When the email verifications from the search are done, the results will be sent to you via a POST request to
the url you passed in the Search People endpoint.'
operationId: people_search_email_resultspeople_search_emails_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PublicSearchPeopleEmailWebhookResult'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ocean.io API Documentation
enrich_person_email:
post:
summary: Enrich Person Email Result
description: 'When the email verification from the request is done, the results will be sent to you via a POST request to
the url you passed in the `Enrich person` endpoint.'
operationId: enrich_person_email_resultenrich_person_email_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EmailWebhookPerson'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ocean.io API Documentation
reveal_phones:
post:
summary: Reveal Phone Results
description: 'When the phone verifications are done, the results will be sent to you via a POST request to
the url you passed in the Reveal endpoint.'
operationId: reveal_phone_resultsreveal_phones_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PublicRevealPhoneWebhookResult'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ocean.io API Documentation
people_search_phones:
post:
summary: People Search Phone Results
description: 'When the phone verifications from the search are done, the results will be sent to you via a POST request to
the url you passed in the Search People endpoint.'
operationId: people_search_phone_resultspeople_search_phones_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PublicSearchPeoplePhoneWebhookResult'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ocean.io API Documentation
enrich_person_phone:
post:
summary: Enrich Person Phone Result
description: 'When the phone verification from the request is done, the results will be sent to you via a POST request to
the url you passed in the `Enrich person` endpoint.'
operationId: enrich_person_phone_resultenrich_person_phone_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PhoneWebhookPerson'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ocean.io API Documentation
enrich_companies:
post:
summary: Enrich Companies Result
description: 'When the companies enrichment request is completed, the results will be sent to you via a POST request
to the url you provided in the `Enrich companies` endpoint.'
operationId: enrich_companies_resultenrich_companies_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EnrichCompaniesWebhookResult'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ocean.io API Documentation
enrich_people:
post:
summary: Enrich People Result
description: 'When the people enrichment request is completed, the results will be sent to you via a POST request
to the url you provided in the `Enrich people` endpoint.'
operationId: enrich_people_resultenrich_people_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EnrichPeopleWebhookResult'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Ocean.io API Documentation
components:
schemas:
ImpressumPerson:
properties:
name:
type: string
title: Name
examples:
- Michael Scott
position:
type: string
nullable: true
title: Position
examples:
- Regional Manager
type: object
required:
- name
title: ImpressumPerson
Media:
properties:
url:
type: string
title: Media URL
description: URL of the media
handle:
type: string
nullable: true
title: Handle
description: ids extracted from social media urls
name:
type: string
nullable: true
title: Name
description: Name of the company as it appears in the social media account
specialties:
items:
type: string
type: array
nullable: true
title: Specialties
description: Specialties of the company as it appears in the social media account. Right now we only have this for LinkedIn.
examples:
- - artificial intelligence
- machine learning
type: object
required:
- url
title: Media
MatchStatus:
type: string
enum:
- Success
- Not enough data
- Not found
- Too many matches
title: MatchStatus
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
Medias:
properties:
linkedin:
$ref: '#/components/schemas/Media'
nullable: true
description: LinkedIn page associated with the company
examples:
- handle: dunder-mifflin
name: Dunder Mifflin Paper Company, Inc.
url: https://www.linkedin.com/company/dunder-mifflin
twitter:
$ref: '#/components/schemas/Media'
nullable: true
description: Twitter page associated with the company
examples:
- handle: dunder-mifflin
name: Dunder Mifflin Paper Company, Inc.
url: https://twitter.com/dunder-mifflin
youtube:
$ref: '#/components/schemas/Media'
nullable: true
description: YouTube page associated with the company
examples:
- handle: dunder-mifflin
name: Dunder Mifflin Paper Company, Inc.
url: https://youtube.com/channel/dunder-mifflin
facebook:
$ref: '#/components/schemas/Media'
nullable: true
description: Facebook page associated with the company
examples:
- handle: dunder-mifflin
name: Dunder Mifflin Paper Company, Inc.
url: https://facebook.com/dunder-mifflin
xing:
$ref: '#/components/schemas/Media'
nullable: true
description: Xing page associated with the company
examples:
- handle: dunder-mifflin
name: Dunder Mifflin Paper Company, Inc.
url: https://xing.com/dunder-mifflin
tiktok:
$ref: '#/components/schemas/Media'
nullable: true
description: TikTok page associated with the company
examples:
- handle: dunder-mifflin
name: Dunder Mifflin Paper Company, Inc.
url: https://tiktok.com/dunder-mifflin
instagram:
$ref: '#/components/schemas/Media'
nullable: true
description: Instagram page associated with the company
examples:
- handle: dunder-mifflin
name: Dunder Mifflin Paper Company, Inc.
url: https://instagram.com/dunder-mifflin
type: object
title: Medias
Department:
type: string
enum:
- Accounting and Finance
- Board
- Business Support
- Customer Relations
- Design
- Editorial Personnel
- Engineering
- Founder/Owner
- Healthcare
- HR
- Legal
- Management
- Manufacturing
- Marketing and Advertising
- Operations
- PR and Communications
- Procurement
- Product
- Quality Control
- R&D
- Sales
- Security
- Supply Chain
- Other
title: Department
PublicCompanySize:
type: string
enum:
- 0-1
- 2-10
- 11-50
- 51-200
- 201-500
- 501-1000
- 1001-5000
- 5001-10000
- 10001-50000
- 50001-100000
- 100001-500000
- 500000+
title: PublicCompanySize
PublicPerson:
properties:
id:
type: string
title: Id
description: Internal ocean id of the person
examples:
- e9447c74eafa8a19
domain:
type: string
title: Domain
description: Domain of the company the person is working for
examples:
- google.com
name:
type: string
nullable: true
title: Name
description: Full name of the person
examples:
- John Doe
firstName:
type: string
nullable: true
title: Firstname
description: First name of the person
examples:
- John
lastName:
type: string
nullable: true
title: Lastname
description: Last name of the person
examples:
- Doe
country:
type: string
nullable: true
title: Country
description: Country code of the person
examples:
- us
- dk
state:
type: string
nullable: true
title: State
description: State code of the person
examples:
- CA
- NY
location:
type: string
nullable: true
title: Location
description: Location of the person
examples:
- Copenhagen, Capital Region, Denmark
linkedinUrl:
type: string
nullable: true
title: Linkedinurl
description: Link to the linkedin profile of the person
examples:
- https://www.linkedin.com/in/someone
seniorities:
items:
$ref: '#/components/schemas/Seniority'
type: array
nullable: true
title: Seniorities
description: List of seniorities computed from the job title of the person
examples:
- - C-Level
- Manager
departments:
items:
$ref: '#/components/schemas/Department'
type: array
nullable: true
title: Departments
description: List of departments computed from the job title of the person
examples:
- - Management
- Marketing and Advertising
photo:
type: string
nullable: true
title: Photo
description: Link to the person's profile picture on LinkedIn
examples:
- http://media.licdn.com/dms/image/somelink
jobTitle:
type: string
nullable: true
title: Jobtitle
description: Job title of the person
examples:
- Professeur
jobTitleEnglish:
type: string
nullable: true
title: Jobtitleenglish
description: English translation of the person's job title
examples:
- Teacher
currentJobDescription:
type: string
nullable: true
title: Currentjobdescription
description: Current job description of the person
examples:
- Software Engineer specializing in cloud infrastructure
experiences:
items:
$ref: '#/components/schemas/Experience'
type: array
nullable: true
title: Experiences
description: List of experiences of the person
examples:
- - dateFrom: '2020-01-01'
dateTo: '2021-01-01'
description: Software Engineer specializing in cloud infrastructure
domain: domain.com
jobTitle: Software Engineer
summary:
type: string
nullable: true
title: Summary
description: Summary of the person
examples:
- Some text that the person wrote to describe themselves
skills:
items:
type: string
type: array
nullable: true
title: Skills
description: Skills of the person
examples:
- - Product Management
- Entrepreneurship
- Social Media
phone:
$ref: '#/components/schemas/public_api__models__person__Phone'
nullable: true
description: Phone numbers of the person
examples:
- numbers:
- '+4512345678'
- +33 6 00 00 00 00
status: verified
email:
$ref: '#/components/schemas/public_api__models__person__Email'
nullable: true
description: Email of the person
examples:
- address: example.jonas@ocean.io
status: verified
inferredEmails:
items:
type: string
type: array
title: Inferredemails
description: List of inferred email addresses for the person. This is only available for enterprise subscriptions.
examples:
- - john.doe@domain.com
- j.doe@domain.com
updatedAt:
type: string
nullable: true
title: Updated at
description: When has the person data been updated for the last time
examples:
- '2022-10-27T12:09:37Z'
connectionsCount:
type: integer
nullable: true
title: Number of connections
description: Number of LinkedIn connections of the person
examples:
- 10
- 500
followersCount:
type: integer
nullable: true
title: Number of followers
description: Number of LinkedIn followers of the person
examples:
- 50
- 1000
headline:
type: string
nullable: true
title: Headline
description: Headline of the person
examples:
- Senior Software Engineer | Tech Lead
type: object
required:
- id
- domain
title: PublicPerson
Revenue:
type: string
enum:
- 0-1M
- 1-10M
- 10-50M
- 50-100M
- 100-500M
- 500-1000M
- '>1000M'
title: Revenue
public_api__models__reveal_phones__Phone:
properties:
numbers:
items:
type: string
type: array
nullable: true
title: Numbers
description: Phone numbers
examples:
- - '+4512345678'
- +33 6 00 00 00 00
status:
type: string
enum:
- verified
- notFound
- inProgress
title: Status
description: 'Status of the phone numbers: verified or not found'
personId:
type: string
title: Personid
description: Ocean ID of the person
examples:
- personId
type: object
required:
- numbers
- status
- personId
title: Phone
EmailWebhookPerson:
properties:
id:
type: string
title: Id
description: Internal ocean id of the person
examples:
- e9447c74eafa8a19
domain:
type: string
title: Domain
description: Domain of the company the person is working for
examples:
- google.com
name:
type: string
nullable: true
title: Name
description: Full name of the person
examples:
- John Doe
firstName:
type: string
nullable: true
title: Firstname
description: First name of the person
examples:
- John
lastName:
type: string
nullable: true
title: Lastname
description: Last name of the person
examples:
- Doe
country:
type: string
nullable: true
title: Country
description: Country code of the person
examples:
- us
- dk
state:
type: string
nullable: true
title: State
description: State code of the person
examples:
- CA
- NY
location:
type: string
nullable: true
title: Location
description: Location of the person
examples:
- Copenhagen, Capital Region, Denmark
linkedinUrl:
type: string
nullable: true
title: Linkedinurl
description: Link to the linkedin profile of the person
examples:
- https://www.linkedin.com/in/someone
seniorities:
items:
$ref: '#/components/schemas/Seniority'
type: array
nullable: true
title: Seniorities
description: List of seniorities computed from the job title of the person
examples:
- - C-Level
- Manager
departments:
items:
$ref: '#/components/schemas/Department'
type: array
nullable: true
title: Departments
description: List of departments computed from the job title of the person
examples:
- - Management
- Marketing and Advertising
photo:
type: string
nullable: true
title: Photo
description: Link to the person's profile picture on LinkedIn
examples:
- http://media.licdn.com/dms/image/somelink
jobTitle:
type: string
nullable: true
title: Jobtitle
description: Job title of the person
examples:
- Professeur
jobTitleEnglish:
type: string
nullable: true
title: Jobtitleenglish
description: English translation of the person's job title
examples:
- Teacher
currentJobDescription:
type: string
nullable: true
title: Currentjobdescription
description: Current job description of the person
examples:
- Software Engineer specializing in cloud infrastructure
experiences:
items:
$ref: '#/components/schemas/Experience'
type: array
nullable: true
title: Experiences
description: List of experiences of the person
examples:
- - dateFrom: '2020-01-01'
dateTo: '2021-01-01'
description: Software Engineer specializing in cloud infrastructure
domain: domain.com
jobTitle: Software Engineer
summary:
type: string
nullable: true
title: Summary
description: Summary of the person
examples:
- Some text that the person wrote to describe themselves
skills:
items:
type: string
type: array
nullable: true
title: Skills
description: Skills of the person
examples:
- - Product Management
- Entrepreneurship
- Social Media
phone:
$ref: '#/components/schemas/public_api__models__person__Phone'
nullable: true
description: Phone numbers of the person
examples:
- numbers:
- '+4512345678'
- +33 6 00 00 00 00
status: verified
email:
$ref: '#/components/schemas/public_api__models__person__Email'
nullable: true
title: Email
description: Email of the person
examples:
- address: guessed@somedomain.com
status: guessed
- address: verified@otherdomain.com
status: verified
inferredEmails:
items:
type: string
type: array
title: Inferredemails
description: List of inferred email addresses for the person. This is only available for enterprise subscriptions.
examples:
- - john.doe@domain.com
- j.doe@domain.com
updatedAt:
type: string
nullable: true
title: Updated at
description: When has the person data been updated for the last time
examples:
- '2022-10-27T12:09:37Z'
connectionsCount:
type: integer
nullable: true
title: Number of connections
description: Number of LinkedIn connections of the person
examples:
- 10
- 500
followersCount:
type: integer
nullable: true
title: Number of followers
description: Number of LinkedIn followers of the person
examples:
- 50
- 1000
headline:
type: string
nullable: true
title: Headline
description: Headline of the person
examples:
- Senior Software Engineer | Tech Lead
type: object
required:
- id
- domain
title: EmailWebhookPerson
MobileApp:
properties:
link:
type: string
nullable: true
title: url
description: Website address for this app
examples:
- https://www.my.app.com/
name:
type: string
title: App name
description: App name
examples:
- My awesome app
type: object
required:
- name
title: MobileApp
OverallEnrichmentStatus:
type: string
enum:
- Completed
- Incomplete
title: OverallEnrichmentStatus
DepartmentSizesGrowth:
properties:
department:
$ref: '#/components/schemas/Department'
description: Department name
growth:
$ref: '#/components/schemas/Growth'
nullable: true
title: Headcount growth
description: Headcount growth per department
type: object
required:
- department
- growth
title: DepartmentSizesGrowth
public_api__models__reveal_emails__Email:
properties:
address:
type: string
nullable: true
title: Address
description: Email address
examples:
- name@gmail.com
status:
type: string
enum:
- verified
- guessed
- catchAll
- notFound
title: Status
description: 'Status of the address: verified, catchAll or guessed'
personId:
type: string
title: Personid
description: Ocean ID of the person
examples:
- personId
type: object
required:
- address
- status
- personId
title: Email
PublicSearchPeopleEmailWebhookResult:
properties:
people:
items:
$ref: '#/components/schemas/EmailWebhookPerson'
type: array
title: People
detail:
type: string
title: Detail
description: Status text
examples:
- OK
total:
type: integer
nullable: true
title: Total
description: Total number of results of the search, accessible with pagination.
examples:
- 32871
type: object
required:
- people
- detail
title: PublicSearchPeopleEmailWebhookResult
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
FundingRoundType:
type: string
enum:
- Seed
- Series A
- Angel
- Series B
- Series Unknown
- Pre-Seed
- Grant
- Series C
- Convertible Note
- Debt Financing
- Non-Equity Assistance
- Undisclosed
- Series D
- Corporate Round
- Equity Crowdfunding
- Product Crowdfunding
- Series E
- Private Equity
- Secondary Market
- Initial Coin Offering
- Post-IPO Equity
- Series F
- Post-IPO Debt
- Series H
- Series G
- Post-IPO Secondary
- Series I
- Series J
title: FundingRoundType
WebTraffic:
properties:
visits:
type: integer
nullable: true
title: Total visits for the last available month
description: Total number of visits of the website for the last available month
pageViews:
type: integer
nullable: true
title: Website views
description: Number of views of the website for the last available month
pagesPerVisit:
type: number
nullable: true
title: Pages per visit
description: Average number of pages viewed per visit for the last available month
bounceRate:
type: number
nullable: true
title: Bouncerate
description: Bounce rate of the domain for the last available month
type: object
title: WebTraffic
DepartmentSize:
properties:
department:
$ref: '#/components/schemas/Department'
description: Department name
size:
type: integer
title: Size
description: Department size
type: object
required:
- department
- size
title: DepartmentSize
public_api__models__person__Email:
properties:
address:
type: string
nullable: true
title: Address
description: Email address
examples:
- name@gmail.com
status:
type: string
enum:
- verified
- guessed
- catchAll
- notFound
title: Status
description: 'Status of the address: verified, catchAll or guessed'
type: object
required:
- address
- status
title: Email
PhoneWebhookPerson:
properties:
id:
type: string
title: Id
description: Internal ocean id of the person
examples:
- e9447c74eafa8a19
domain:
type: string
title: Domain
description: Domain of the company the person is working for
examples:
- google.com
name:
type: string
nullable: true
title: Name
description: Full name of the person
examples:
- John Doe
firstName:
type: string
nullable: true
title: Firstname
description: First name of the person
examples:
- John
lastName:
type: string
nullable: true
title: Lastname
description: Last name of the person
examples:
- Doe
country:
type: string
nullable: true
title: Country
description: Country code of the person
examples:
- us
- dk
state:
type: string
nullable: true
title: State
description: State code of the person
examples:
- CA
- NY
location:
type: string
nullable: true
title: Location
description: Location of the person
examples:
- Copenhagen, Capita
# --- truncated at 32 KB (60 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ocean-io/refs/heads/main/openapi/ocean-io-ocean-io-api-documentation-api-openapi.yml