Body Required
-
size integer
Number of companies to return. The maximum value is 10,000. To get more than 10,000 results, use
searchAfter
.Minimum value is
1.0
, maximum value is10000.0
. Default value is50
. -
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,001Minimum value is
1.0
, maximum value is10001.0
. Default value is1
. -
searchAfter string | null
-
Additional properties are NOT allowed.
-
peopleFilters object | null
Additional properties are NOT allowed.
POST /v2/search/companies
curl \
-X POST https://api.ocean.io/v2/search/companies?apiToken=string \
-H "Content-Type: application/json" \
-d '{"size":10,"from":10,"searchAfter":"NoBgdA7BAsBMEgGwBoAEAiADgGwK4HN8BTAJwC8wBjAewFt0BdIA","companiesFilters":{"lookalikeDomains":["bestcustomer.com","idealcustomer.com"],"minScore":0.95,"includeDomains":["interesting.com","amazing.com"],"excludeDomains":["boring.com","useless.com"],"companySizes":["2-10","51-200","100001-500000"],"ecommerce":true,"socialMedias":{"mode":"anyOf","medias":["linkedin","facebook"]},"yearFounded":{"to":1990,"from":1960},"countriesCount":{"to":5,"from":1},"revenues":["0-1M","1-10M","\u003e1000M"],"employeeCountOcean":{"to":100,"from":10},"webTrafficVisits":{"to":10000,"from":1000},"mobileApps":{"to":5,"from":1},"headquarterGeolocation":{"radius":1000,"latitude":38.880817,"longitude":-77.10216},"geolocation":{"radius":5000,"latitude":50.83348,"longitude":-0.1410065},"locationsCount":{"to":10,"from":5},"departmentSizes":[{"to":10,"from":5,"department":"Accounting and Finance"}],"keywords":{"mode":"anyOf","keywords":["premium copy paper","paper"]},"states":[{"country":"us","abbreviation":"ca"},{"country":"ca","abbreviation":"yt"}],"employeeCountLinkedin":{"to":100,"from":50},"countries":["es","pt"],"primaryCountries":["de"],"industries":{"mode":"anyOf","industries":["Advertising Platforms","Biopharma"]},"excludeIndustries":["CRM","B2B"],"industryCategories":{"mode":"anyOf","industryCategories":["Real Estate","Hardware"]},"excludeIndustryCategories":["Information Technology","Privacy and Security"],"technologies":{"mode":"anyOf","technologies":["Amazon Advertising","Google Maps"]},"fieldsExist":["industries","emails","locations"],"fieldsNotExist":["industryCategories","phones"]},"peopleFilters":{"includeIds":["51e19df9c1d70c7c","971b1b1bfb1ffb1a"],"excludeIds":["51e19df9c1d70c7c","971b1b1bfb1ffb1a"],"seniorities":["Founder","Owner"],"jobTitles":["CEO","CTO"],"excludeJobTitles":["CEO","CTO"],"departments":["Management","Marketing and Advertising"],"countries":["us","dk"],"names":["John Doe","Peter Pan"],"emailStatuses":["verified","catchAll"],"emails":["email_1@domain.com","email_2@domain.com"],"keywords":["engineering","research"],"fieldsExist":["name","country","linkedinUrl"],"fieldsNotExist":["firstName","location","jobTitleEnglish"],"phoneStatuses":["verified","notFound"]}}'
Request examples
{
"size": 10,
"from": 10,
"searchAfter": "NoBgdA7BAsBMEgGwBoAEAiADgGwK4HN8BTAJwC8wBjAewFt0BdIA",
"companiesFilters": {
"lookalikeDomains": [
"bestcustomer.com",
"idealcustomer.com"
],
"minScore": 0.95,
"includeDomains": [
"interesting.com",
"amazing.com"
],
"excludeDomains": [
"boring.com",
"useless.com"
],
"companySizes": [
"2-10",
"51-200",
"100001-500000"
],
"ecommerce": true,
"socialMedias": {
"mode": "anyOf",
"medias": [
"linkedin",
"facebook"
]
},
"yearFounded": {
"to": 1990,
"from": 1960
},
"countriesCount": {
"to": 5,
"from": 1
},
"revenues": [
"0-1M",
"1-10M",
">1000M"
],
"employeeCountOcean": {
"to": 100,
"from": 10
},
"webTrafficVisits": {
"to": 10000,
"from": 1000
},
"mobileApps": {
"to": 5,
"from": 1
},
"headquarterGeolocation": {
"radius": 1000,
"latitude": 38.880817,
"longitude": -77.10216
},
"geolocation": {
"radius": 5000,
"latitude": 50.83348,
"longitude": -0.1410065
},
"locationsCount": {
"to": 10,
"from": 5
},
"departmentSizes": [
{
"to": 10,
"from": 5,
"department": "Accounting and Finance"
}
],
"keywords": {
"mode": "anyOf",
"keywords": [
"premium copy paper",
"paper"
]
},
"states": [
{
"country": "us",
"abbreviation": "ca"
},
{
"country": "ca",
"abbreviation": "yt"
}
],
"employeeCountLinkedin": {
"to": 100,
"from": 50
},
"countries": [
"es",
"pt"
],
"primaryCountries": [
"de"
],
"industries": {
"mode": "anyOf",
"industries": [
"Advertising Platforms",
"Biopharma"
]
},
"excludeIndustries": [
"CRM",
"B2B"
],
"industryCategories": {
"mode": "anyOf",
"industryCategories": [
"Real Estate",
"Hardware"
]
},
"excludeIndustryCategories": [
"Information Technology",
"Privacy and Security"
],
"technologies": {
"mode": "anyOf",
"technologies": [
"Amazon Advertising",
"Google Maps"
]
},
"fieldsExist": [
"industries",
"emails",
"locations"
],
"fieldsNotExist": [
"industryCategories",
"phones"
]
},
"peopleFilters": {
"includeIds": [
"51e19df9c1d70c7c",
"971b1b1bfb1ffb1a"
],
"excludeIds": [
"51e19df9c1d70c7c",
"971b1b1bfb1ffb1a"
],
"seniorities": [
"Founder",
"Owner"
],
"jobTitles": [
"CEO",
"CTO"
],
"excludeJobTitles": [
"CEO",
"CTO"
],
"departments": [
"Management",
"Marketing and Advertising"
],
"countries": [
"us",
"dk"
],
"names": [
"John Doe",
"Peter Pan"
],
"emailStatuses": [
"verified",
"catchAll"
],
"emails": [
"email_1@domain.com",
"email_2@domain.com"
],
"keywords": [
"engineering",
"research"
],
"fieldsExist": [
"name",
"country",
"linkedinUrl"
],
"fieldsNotExist": [
"firstName",
"location",
"jobTitleEnglish"
],
"phoneStatuses": [
"verified",
"notFound"
]
}
}
Response examples (200)
{
"companies": [
{
"company": {
"domain": "dundermifflinpaper.com",
"countries": [
"us",
"ca"
],
"primaryCountry": "us",
"companySize": "2-10",
"industryCategories": [
"Consumer Electronics",
"Hardware"
],
"industries": [
"Audio",
"Electronics"
],
"ecommerce": true,
"keywords": [
"paper",
"premium copy paper"
],
"employeeCountOcean": 57,
"employeeCountLinkedin": 70,
"revenue": "1-10M",
"yearFounded": 1999,
"description": "Dunder Mifflin Paper Company, Inc. is a fictional paper and office supplies wholesale company featured in the American television series The Office.",
"emails": [
"email1@domain.com",
"email2@domain.com"
],
"phones": [
{
"number": "+1 212 456 7890",
"country": "us",
"primary": true
},
{
"number": "+1 250 555 0199",
"country": "ca"
}
],
"logo": "https://cdn2.ocean.io/companies-logos-v1/domain.com/020539e284d9318e805301b672ad23047c30818a.png",
"technologies": [
"Accesso",
"Adcash",
"Atlassian Jira"
],
"technologyCategories": [
"Security",
"Analytics",
"Blogs"
],
"mobileApps": [
{
"link": "https://www.my.app.com/",
"name": "My awesome app"
}
],
"webTraffic": {
"visits": 10000,
"pageViews": 2155984,
"bounceRate": 0.5227,
"pagesPerVisit": 4.88
},
"medias": {
"linkedin": {
"url": "https://www.linkedin.com/company/dunder-mifflin",
"name": "Dunder Mifflin Paper Company, Inc.",
"handle": "dunder-mifflin"
},
"twitter": {
"url": "https://twitter.com/dunder-mifflin",
"name": "Dunder Mifflin Paper Company, Inc.",
"handle": "dunder-mifflin"
},
"youtube": {
"url": "https://youtube.com/channel/dunder-mifflin",
"name": "Dunder Mifflin Paper Company, Inc.",
"handle": "dunder-mifflin"
},
"facebook": {
"url": "https://facebook.com/dunder-mifflin",
"name": "Dunder Mifflin Paper Company, Inc.",
"handle": "dunder-mifflin"
},
"xing": {
"url": "https://xing.com/dunder-mifflin",
"name": "Dunder Mifflin Paper Company, Inc.",
"handle": "dunder-mifflin"
},
"tiktok": {
"url": "https://tiktok.com/dunder-mifflin",
"name": "Dunder Mifflin Paper Company, Inc.",
"handle": "dunder-mifflin"
},
"instagram": {
"url": "https://instagram.com/dunder-mifflin",
"name": "Dunder Mifflin Paper Company, Inc.",
"handle": "dunder-mifflin"
}
},
"name": "Dunder Mifflin Paper Company",
"legalName": "Dunder Mifflin Paper Company, Inc.",
"locations": [
{
"primary": true,
"latitude": 43.6471,
"longitude": -79.3971,
"country": "us",
"locality": "Scranton",
"region": "Lackawanna County",
"postalCode": "18505",
"streetAddress": "Scranton Business Park, 1725 Slough Ave Suit 200",
"state": "pa",
"regionCode": "PA"
}
],
"departmentSizes": [
{
"size": 10,
"department": "Accounting and Finance"
},
{
"size": 15,
"department": "Sales"
}
],
"rootUrl": "https://dundermifflinpaper.com/",
"faxes": [
{
"number": "5709045026",
"country": "us",
"primary": true
}
],
"impressum": {
"company": "Dunder Mifflin Paper Company, Inc.",
"address": "Scranton Business Park, 1725 Slough Ave Suit 200, Scranton, USA",
"email": "email@dundermifflin.com",
"phone": "+35123456789",
"fax": "+35123456790",
"vat": "123456",
"url": "https://dundermifflinpaper.com/impressum",
"people": [
{
"name": "Michael Scott",
"position": "Regional Manager"
}
]
}
},
"score": 0.96
}
],
"searchAfter": "NoBgdA7BAsBMEgGwBoAEAiADgGwK4HN8BTAJwC8wBjAewFt0BdIA",
"detail": "OK",
"total": 32871,
"missingDomains": {
"not-yet-crawled-domain.com": "data gathering started",
"domain-with-bad-content.com": "bad content"
}
}
Response examples (422)
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}