post /v2/search/companies

Lookalike companies search (deprecated)

Search companies using filters.
This endpoint is deprecated.

Authorizations

apiToken string
x-api-token string

Body application/json

size integer
Number of companies to return. The maximum value is 10,000. To get more than 10,000 results, use `searchAfter`.
from integer
Return companies from number X. Passing 1 will return all the results. Passing 10 will return results from the 10th. Note: `size + from` cannot be higher than 10,001
searchAfter string
Use `searchAfter` returned by the previous request to get the next page
Collection of companies filters to be applied to the search
Find domains similar to the provided
Array of string
Only return specified domains
Array of string
Exclude specified domains from the results
Array of string
Filter by company size ranges
Array of PublicCompanySize
enum
"0-1""2-10""11-50""51-200""201-500""501-1000""1001-5000""5001-10000""10001-50000""50001-100000""100001-500000""500000+"
ecommerce boolean
true -> returns only e-commerce companies<br>false -> excludes e-commerce companies<br>none -> returns everything
Filter by year founded. Valid range: 0-2100
from integer
Greater than or equal to
to integer
Less than or equal to
Filter by the number of countries in which the company operates. Valid range: 0-300
from integer
Greater than or equal to
to integer
Less than or equal to
Filter by revenue ranges
Array of Revenue
enum
"0-1M""1-10M""10-50M""50-100M""100-500M""500-1000M"">1000M"
Only return companies that have a certain number of employee profiles in our database. Valid range: 0-10,000,000
from integer
Greater than or equal to
to integer
Less than or equal to
Filter by the number of mobile apps that the company produced. Valid range: 0-10,000
from integer
Greater than or equal to
to integer
Less than or equal to
Filter by mobile app attributes (count, downloads, release year)
Filter by the number of mobile apps that the company produced. Valid range: 0-10,000
from integer
Greater than or equal to
to integer
Less than or equal to
Filter by the number of mobile app downloads. Valid range: 0-10,000,000,000
from integer
Greater than or equal to
to integer
Less than or equal to
Filter by the release year of mobile apps. Valid range: 2000-2100
from integer
Greater than or equal to
to integer
Less than or equal to
Only return companies that have a certain amount of locations. Valid range: 0-100,000
from integer
Greater than or equal to
to integer
Less than or equal to
Filter by the size of company departments. Valid range: 0-10,000,000
Array of DepartmentSizeFilter
from integer
Greater than or equal to
to integer
Less than or equal to
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"
The number of employees a company has on LinkedIn. Valid range: 0-10,000,000
from integer
Greater than or equal to
to integer
Less than or equal to
Filter by company industries. Available values are located at /v2/data-fields endpoint.<br>
Array of the industries to include
Array of string
mode enum
[default] anyOf - match at least one of the industries<br>allOf - match all of the industries
"anyOf""allOf"
Array of the industries to exclude
Array of string
Filter by company industry categories. Available values are located at /v2/data-fields endpoint.<br>
Array of the industry categories to include
Array of string
mode enum
[default] anyOf - match at least one of the industry categories<br>allOf - match all of the industry categories
"anyOf""allOf"
Array of the industry categories to exclude
Array of string
Filter by Linkedin industries. This is OR filter. Available values are located at /v2/data-fields endpoint.<br>
Array of string
Array of Linkedin industries to exclude. Available values are located at /v2/data-fields endpoint.<br>
Array of string
Filter by funding rounds
Amount of money raised in funding round. Valid range: 0-100,000,000,000
from integer
Greater than or equal to
to integer
Less than or equal to
List of funding round types
Array of FundingRoundType
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"
Date range of the funding round. Valid range: 1800-01-01 to 2100-12-31
from string
Date in YYYY-MM-DD format
to string
Date in YYYY-MM-DD format
Filter by **all** countries where the company has presence.<br>Must be provided as alpha-2 ISO 3166 country codes.<br>`["es", "pt"]` means Spain (primary/not primary) **OR** Portugal (primary/not primary).<br>if additional filter `primaryCountries = ["de"]` is used then it means:<br>(Spain (not primary) **OR** Portugal (not primary)) **AND** Germany (primary)
Array of string
Filter only by **primary** countries where the company has presence.<br>Must be provided as alpha-2 ISO 3166 country codes.<br>`countries = ["de", "at"]` means Germany (primary) **OR** Austria (primary).<br>if additional filter `countries = ["es"]` is used then it means:<br>(Germany (primary) **OR** Austria (primary)) **AND** Spain (not primary)
Array of string
Filter by country states (if applicable)
Array of State
country string Required
Alpha-2 ISO 3166 country code
abbreviation string Required
Valid state abbreviation. List available in the region section there: /v2/data-fields.
Filter only by **primary** states where the company has presence.<br>Behavior is the same as for primary countries
Array of State
country string Required
Alpha-2 ISO 3166 country code
abbreviation string Required
Valid state abbreviation. List available in the region section there: /v2/data-fields.
Filter by cities
Array of CompaniesCityFilter
city string Required
City name
country string
Alpha-2 ISO 3166 country code
Filter by country region (if applicable)
country string Required
Alpha-2 ISO 3166 country code
abbreviation string Required
Valid state abbreviation. List available in the region section there: /v2/data-fields.
postalCode string
Filter by postal code
Filter only by **primary** cities where the company has presence.<br>Behavior is the same as for primary countries
Array of CompaniesCityFilter
city string Required
City name
country string
Alpha-2 ISO 3166 country code
Filter by country region (if applicable)
country string Required
Alpha-2 ISO 3166 country code
abbreviation string Required
Valid state abbreviation. List available in the region section there: /v2/data-fields.
postalCode string
Filter by postal code
Filter by headquarter location
latitude number Required
Latitude of the location
longitude number Required
Longitude of the location
radius integer Required
Radius in meters
Filter by locations of offices other than the headquarters
latitude number Required
Latitude of the location
longitude number Required
Longitude of the location
radius integer Required
Radius in meters
Only return companies that have a certain amount of visits. Valid range: 0-100,000,000,000
from integer
Greater than or equal to
to integer
Less than or equal to
Filter by keywords
Array of the keywords
Array of string
mode enum
[default] anyOf - match at least one of the keywords<br>allOf - match all of the keywords<br>noneOf - match none of the keywords
"anyOf""allOf""noneOf"
Return records where specified fields exist
Array of enum
enum
"companySize""countries""departmentSizes""description""emails""faxes""impressum""industries""industryCategories""keywords""legalName""linkedinIndustry""locations""logo""medias""mobileApps""name""phones""primaryCountry""revenue""rootUrl""technologies""technologyCategories""webTraffic""yearFounded"
Return records where specified fields do not exist
Array of enum
enum
"companySize""countries""departmentSizes""description""emails""faxes""impressum""industries""industryCategories""keywords""legalName""linkedinIndustry""locations""logo""medias""mobileApps""name""phones""primaryCountry""revenue""rootUrl""technologies""technologyCategories""webTraffic""yearFounded"
Filter by social media presence
Array of the social medias to include
Array of enum
enum
"linkedin""x""facebook""instagram""youtube""xing""tiktok"
mode enum
[default] anyOf - match at least one of the medias<br>allOf - match all of the medias
"anyOf""allOf"
Filter by software technologies used by the company. Available values are located at /v2/data-fields endpoint.<br>
Array of the technologies to include
Array of string
mode enum
[default] anyOf - match at least one of the technologies<br>allOf - match all of the technologies
"anyOf""allOf"
minScore number
Minimum score for companies to appear in the results.
Collection of people filters to be applied to the search, the search results will display companies that have at least one person matching those filters
Only return specified people. Note: this is not implemented yet.
Array of string
Exclude specified people from the results. Note: this is not implemented yet.
Array of string
Filter by seniorities. Available values are located at /v2/data-fields endpoint.<br>
Array of Seniority
enum
"Owner""Founder""Board Member""C-Level""Partner""VP""Head""Director""Manager""Other"
Filter by job title
Array of string
Exclude people by job title
Array of string
Filter by departments. Available values are located at /v2/data-fields endpoint.<br>
Array of Department
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"
Filter by countries (alpha-2 ISO 3166 country codes)
Array of string
List of states/regions (ISO-3166-2 region codes) to search for people
Array of State
country string Required
Alpha-2 ISO 3166 country code
abbreviation string Required
Valid state abbreviation. List available in the region section there: /v2/data-fields.
List of states/regions (ISO-3166-2 region codes) to exclude when searching for people
Array of State
country string Required
Alpha-2 ISO 3166 country code
abbreviation string Required
Valid state abbreviation. List available in the region section there: /v2/data-fields.
List of countries (alpha-2 ISO 3166 country codes) to exclude when searching for people
Array of string
Filter by names
Array of string
Filter by email address
Array of string
Filter people based on keywords from their summary
Array of string
Return records where specified fields exist
Array of enum
enum
"country""departments""firstName""jobTitle""jobTitleEnglish""lastName""linkedinUrl""location""name""photo""seniorities""summary"
Return records where specified fields do not exist
Array of enum
enum
"country""departments""firstName""jobTitle""jobTitleEnglish""lastName""linkedinUrl""location""name""photo""seniorities""summary"
changedPositionAfter string
Return people who started a new job between the specified date (inclusive) and now
changedPositionBefore string
Return people who started a new currently active job before the specified date (inclusive)
Fields to return in the Company objects. Only requesting the fields that are needed will use less bandwidth and result in faster responses. If not specified, all fields are returned that can be seen in the example.
Array of CompanyField
enum
"domain""countries""primaryCountry""companySize""industryCategories""industries""linkedinIndustry""ecommerce""keywords""employeeCountOcean""employeeCountLinkedin""revenue""yearFounded""description""emails""phones""phones.number""phones.country""phones.primary""logo""technologies""technologyCategories""mobileApps""mobileApps.link""mobileApps.name""webTraffic""webTraffic.visits""webTraffic.pageViews""webTraffic.pagesPerVisit""medias""medias.linkedin""medias.twitter""medias.youtube""medias.facebook""medias.xing""medias.tiktok""medias.instagram""name""legalName""locations""locations.primary""locations.country""locations.locality""locations.region""locations.postalCode""locations.streetAddress""locations.state""locations.regionCode""departmentSizes""rootUrl""faxes""faxes.number""faxes.country""faxes.primary""impressum""impressum.company""impressum.address""impressum.email""impressum.phone""impressum.fax""impressum.vat""impressum.url""impressum.people""fundingRound""fundingRound.date""fundingRound.type""fundingRound.moneyRaisedInUsd""fundingRound.cbUrl""redirectedFrom""updatedAt""headcountGrowth""headcountGrowth.threeMonths""headcountGrowth.threeMonthsPercentage""headcountGrowth.sixMonths""headcountGrowth.sixMonthsPercentage""headcountGrowth.twelveMonths""headcountGrowth.twelveMonthsPercentage""headcountGrowthPerDepartment"

Responses

200 Successful Response
searchAfter string
Used for pagination. Use `searchAfter` returned by this request in the next request to get the next page of search results. If `searchAfter` is not present in the response then there is no next page.
detail string Required
Status text
total integer
Total number of results of the search, accessible with pagination.
Domains from `lookalikeDomains` filter that are either not present in Ocean's database or present but lacking necessary data to perform the search, along with the reason
object
Mapping of original domains passed in filters to their redirected domains.
object
creditsUsed number Required
Number of credits charged for this request.
Array of found companies. Returns empty array if no results
Array of PublicCompanyWithScore
Company found in the database
domain string Required
Domain of the company, used as a unique identifier
List of all countries in which the company operates
Array of string
primaryCountry string
Main country of the company
Company size range
enum
"0-1""2-10""11-50""51-200""201-500""501-1000""1001-5000""5001-10000""10001-50000""50001-100000""100001-500000""500000+"
Industry categories of the company<br>Available values can be found at /v2/data-fields endpoint.
Array of string
Industries of the company<br>Available values can be found at /v2/data-fields endpoint.
Array of string
linkedinIndustry string
Linkedin industry of the company<br>Available values can be found at /v2/data-fields endpoint.
ecommerce boolean
True if the company is an e-commerce company
Keywords associated with the company
Array of string
employeeCountOcean integer
Number of people working at the company in our database.
employeeCountLinkedin integer
Number of people linked to the company page on Linkedin. This number might be higher than `employeeCountOcean` because of private profiles.
Revenue range
enum
"0-1M""1-10M""10-50M""50-100M""100-500M""500-1000M"">1000M"
yearFounded integer
Year the company was founded
description string
Company's description
Emails of the company
Array of string
Phones of the company
Array of ContactNumber
number string Required
Contact number
country string
Country code of the contact number
primary boolean
True if the contact number is the primary contact number of the company
logo string
Logo of the company (URL)
Software technologies used by the company
Array of string
Technology categories of the company
Array of string
Mobile apps produced by the company
Array of MobileApp
link string
Website address for this app
name string Required
App name
Web traffic of the domain
visits integer
Total number of visits of the website for the last available month
pageViews integer
Number of views of the website for the last available month
pagesPerVisit number
Average number of pages viewed per visit for the last available month
bounceRate number
Bounce rate of the domain for the last available month
Social medias of the company
LinkedIn page associated with the company
url string Required
URL of the media
handle string
ids extracted from social media urls
name string
Name of the company as it appears in the social media account
Specialties of the company as it appears in the social media account. Right now we only have this for LinkedIn.
Array of string
Twitter page associated with the company
url string Required
URL of the media
handle string
ids extracted from social media urls
name string
Name of the company as it appears in the social media account
Specialties of the company as it appears in the social media account. Right now we only have this for LinkedIn.
Array of string
YouTube page associated with the company
url string Required
URL of the media
handle string
ids extracted from social media urls
name string
Name of the company as it appears in the social media account
Specialties of the company as it appears in the social media account. Right now we only have this for LinkedIn.
Array of string
Facebook page associated with the company
url string Required
URL of the media
handle string
ids extracted from social media urls
name string
Name of the company as it appears in the social media account
Specialties of the company as it appears in the social media account. Right now we only have this for LinkedIn.
Array of string
Xing page associated with the company
url string Required
URL of the media
handle string
ids extracted from social media urls
name string
Name of the company as it appears in the social media account
Specialties of the company as it appears in the social media account. Right now we only have this for LinkedIn.
Array of string
TikTok page associated with the company
url string Required
URL of the media
handle string
ids extracted from social media urls
name string
Name of the company as it appears in the social media account
Specialties of the company as it appears in the social media account. Right now we only have this for LinkedIn.
Array of string
Instagram page associated with the company
url string Required
URL of the media
handle string
ids extracted from social media urls
name string
Name of the company as it appears in the social media account
Specialties of the company as it appears in the social media account. Right now we only have this for LinkedIn.
Array of string
name string
Name of the company
legalName string
Legal name of the company
Locations of the company
Array of Location
primary boolean
True if the location is the headquarter of the company
latitude number
Latitude of the location
longitude number
Longitude of the location
country string
Country code of the location
locality string
Locality (city) of the location
region string
Region of the location. Available abbreviation values are located at /v2/data-fields endpoint (region section)
postalCode string
Postal code of the location
streetAddress string
Street address of the location
state string Deprecated
Abbreviation of the location (if applicable). Available abbreviation values are located at /v2/data-fields endpoint (region section). Deprecated, please use `region` instead
regionCode string
Region code of the location
Number of employees per department
Array of DepartmentSize
Department name
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"
size integer Required
Department size
rootUrl string
Root url to access the website
Faxes of the company
Array of ContactNumber
number string Required
Contact number
country string
Country code of the contact number
primary boolean
True if the contact number is the primary contact number of the company
Impressum (Imprint) data of the company (only for Germany, Austria, Switzerland)
company string
Company name as mentioned in Impressum
address string
Company address as mentioned in Impressum
email string
Company email as mentioned in Impressum
phone string
Company phone as mentioned in Impressum
fax string
Company fax as mentioned in Impressum
vat string
VAT number as mentioned in Impressum
url string
url where Impressum can be found
People mentioned in Impressum
Array of ImpressumPerson
name string Required
position string
Funding round of the company
date string
Date of the funding round
Type of the funding round
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"
moneyRaisedInUsd integer
Amount of money raised in USD
cbUrl string
URL of the funding round on Crunchbase
Urls that redirects to this domain. We provide maximum 10 urls in this field.
Array of string
updatedAt string
When has the company data been updated for the last time
Headcount growth of the company
threeMonths integer
Actual headcount change (positive or negative number)
threeMonthsPercentage number
Headcount growth as a decimal (e.g., 0.15 represents 15% growth)
sixMonths integer
Actual headcount change (positive or negative number)
sixMonthsPercentage number
Headcount growth as a decimal (e.g., 0.15 represents 15% growth)
twelveMonths integer
Actual headcount change (positive or negative number)
twelveMonthsPercentage number
Headcount growth as a decimal (e.g., 0.15 represents 15% growth)
Headcount growth per department
Array of DepartmentSizesGrowth
Department name
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"
Headcount growth per department
threeMonths integer
Actual headcount change (positive or negative number)
threeMonthsPercentage number
Headcount growth as a decimal (e.g., 0.15 represents 15% growth)
sixMonths integer
Actual headcount change (positive or negative number)
sixMonthsPercentage number
Headcount growth as a decimal (e.g., 0.15 represents 15% growth)
twelveMonths integer
Actual headcount change (positive or negative number)
twelveMonthsPercentage number
Headcount growth as a decimal (e.g., 0.15 represents 15% growth)
score number
Similarity score used for similarity search
400 Bad Request
detail enum Required
"Conflicting API tokens provided in query parameters and headers""Plan version not supported for this endpoint"
402 Payment Required
detail enum Required
"Insufficient credits"
403 Forbidden
detail enum Required
"API token should be provided in headers or query parameters""Current API token is not registered in our database"
404 Not found
422 Validation Error
Array of ValidationError
Array of string | integer
string | integer
msg string Required
type string Required
input any
object