Search
Lookalike companies search
Search companies using filters. Looking for the legacy endpoint? Access it here
Request Body
application/json
Requiredsize
Maximum number of resultsNumber of companies to return. The maximum value is 10,000. To get more than 10,000 results, use searchAfter
.
Default:
50
Minimum: 1
Maximum: 10000
searchAfter
string | null | nullcompaniesFilters
object | null | nullpeopleFilters
object | null | nullQuery Parameters
apiToken
string | null | nullHeader Parameters
x-api-token
string | null | nullResponse Body
Successful Response
TypeScript Definitions
Use the response body type in TypeScript.
searchAfter
string | null | nulldetail
RequiredDetailStatus text
total
integer | null | nullmissingDomains
object | null | nullcompanies
RequiredCompanies foundArray of found companies. Returns empty array if no results
Bad Request
TypeScript Definitions
Use the response body type in TypeScript.
detail
RequiredstringValue in:
"Conflicting API tokens provided in query parameters and headers"
Payment Required
TypeScript Definitions
Use the response body type in TypeScript.
detail
RequiredstringValue in:
"Insufficient credits"
Forbidden
TypeScript Definitions
Use the response body type in TypeScript.
detail
RequiredstringValue in:
"API token should be provided in headers or query parameters" | "Current API token is not registered in our database"
Not found
Validation Error
TypeScript Definitions
Use the response body type in TypeScript.
detail
Detailcurl -X POST "https://api.ocean.io/v3/search/companies?apiToken=string" \
-H "x-api-token: string" \
-H "Content-Type: application/json" \
-d '{
"size": 10,
"searchAfter": "NoBgdA7BAsBMEgGwBoAEAiADgGwK4HN8BTAJwC8wBjAewFt0BdIA",
"companiesFilters": {
"lookalikeDomains": [
"bestcustomer.com",
"idealcustomer.com"
],
"includeDomains": [
"interesting.com",
"amazing.com"
],
"excludeDomains": [
"boring.com",
"useless.com"
],
"companySizes": [
"2-10",
"51-200",
"100001-500000"
],
"ecommerce": true,
"yearFounded": {
"from": 1960,
"to": 1990
},
"countriesCount": {
"from": 1,
"to": 5
},
"revenues": [
"0-1M",
"1-10M",
">1000M"
],
"employeeCountOcean": {
"from": 10,
"to": 100
},
"mobileApps": {
"from": 1,
"to": 5
},
"locationsCount": {
"from": 5,
"to": 10
},
"departmentSizes": [
{
"department": "Accounting and Finance",
"from": 5,
"to": 10
}
],
"employeeCountLinkedin": {
"from": 50,
"to": 100
},
"industries": {
"industries": [
"Advertising Platforms",
"Biopharma"
],
"mode": "anyOf"
},
"excludeIndustries": [
"CRM",
"B2B"
],
"industryCategories": {
"industryCategories": [
"Real Estate",
"Hardware"
],
"mode": "anyOf"
},
"excludeIndustryCategories": [
"Information Technology",
"Privacy and Security"
],
"linkedinIndustries": [
"Management Consulting",
"Computer Software"
],
"excludeLinkedinIndustries": [
"Management Consulting",
"Computer Software"
],
"fundingRound": {
"date": {
"from": "2020-01-01",
"to": "2023-01-01"
},
"raised": {
"from": 1000000,
"to": 5000000
},
"types": [
"Seed",
"Series A"
]
},
"primaryLocations": {
"includeCountries": [
"es",
"pt"
],
"excludeCountries": [
"br",
"de"
],
"includeRegions": [
{
"abbreviation": "CA",
"country": "us"
},
{
"abbreviation": "YT",
"country": "ca"
}
],
"excludeRegions": [
{
"abbreviation": "CA",
"country": "us"
},
{
"abbreviation": "YT",
"country": "ca"
}
],
"includeCities": [
{
"city": "New York",
"country": "us"
},
{
"city": "Los Angeles",
"country": "us"
}
],
"excludeCities": [
{
"city": "New York",
"country": "us"
},
{
"city": "Los Angeles",
"country": "us"
}
],
"geolocation": {
"latitude": 38.880817,
"longitude": -77.10216,
"radius": 1000
}
},
"otherLocations": {
"includeCountries": [
"es",
"pt"
],
"excludeCountries": [
"br",
"de"
],
"includeRegions": [
{
"abbreviation": "CA",
"country": "us"
},
{
"abbreviation": "YT",
"country": "ca"
}
],
"excludeRegions": [
{
"abbreviation": "CA",
"country": "us"
},
{
"abbreviation": "YT",
"country": "ca"
}
],
"includeCities": [
{
"city": "New York",
"country": "us"
},
{
"city": "Los Angeles",
"country": "us"
}
],
"excludeCities": [
{
"city": "New York",
"country": "us"
},
{
"city": "Los Angeles",
"country": "us"
}
],
"geolocation": {
"latitude": 38.880817,
"longitude": -77.10216,
"radius": 1000
}
},
"webTraffic": {
"views": {
"from": 1000,
"to": 1000000
},
"visits": {
"from": 1000,
"to": 10000
}
},
"socialMedias": {
"medias": {
"all_of": [
"facebook",
"x"
],
"any_of": [
"youtube",
"xing"
],
"none_of": [
"instagram",
"tiktok"
]
},
"min_count": 3
},
"technologies": {
"apps": {
"all_of": [
"Amazon Advertising",
"Google Maps"
],
"any_of": [
"BrightEdge",
"Nette Framework"
],
"none_of": [
"Kount",
"Nativo"
]
},
"categories": {
"all_of": [
"Analytics",
"Security"
],
"any_of": [
"Advertising",
"WordPress themes"
],
"none_of": [
"CMS",
"Reviews"
]
}
},
"keywords": {
"all_of": [
"lead generation",
"marketing"
],
"any_of": [
"smart prospecting",
"data platform"
],
"none_of": [
"seo"
]
},
"minRelevance": "B",
"maxRelevance": "B"
},
"peopleFilters": {
"lookalikeLinkedinHandles": [
"michael-scott-13532",
"dwight-schrute"
],
"countries": [
"us",
"dk"
],
"includePeopleIds": [
"43g19df9c1d70f9a",
"54hb1b1bfb1ffc5t"
],
"includeLinkedinHandles": [
"jim-halpert-5343",
"toby-67832"
],
"excludePeopleIds": [
"43g19df9c1d70f9a",
"54hb1b1bfb1ffc5t"
],
"excludeLinkedinHandles": [
"jim-halpert-5343",
"toby-67832"
],
"seniorities": [
"Founder",
"Owner"
],
"skills": {
"allOf": [
"Product Management",
"Entrepreneurship"
],
"anyOf": [
"Social Media",
"Competitive Analysis"
],
"noneOf": [
"Writing",
"Project Management"
]
},
"jobTitleKeywords": {
"allOf": [
"Manager"
],
"anyOf": [
"Marketing",
"designer"
],
"noneOf": [
"content"
]
},
"allJobDescriptions": {
"allOf": [
"software engineer"
],
"anyOf": [
"software engineer"
],
"noneOf": [
"entry-level"
]
},
"currentJobDescription": {
"allOf": [
"software engineer",
"big tech company"
],
"anyOf": [
"software engineer"
],
"noneOf": [
"entry-level"
]
},
"profileDescription": {
"allOf": [
"software engineer"
],
"anyOf": [
"software engineer"
],
"noneOf": [
"entry-level"
]
},
"regions": [
"CA",
"TX"
],
"states": [
{
"abbreviation": "NY",
"country": "us"
},
{
"abbreviation": "ENG",
"country": "gb"
},
{
"abbreviation": "5",
"country": "at"
},
{
"abbreviation": "SH",
"country": "de"
}
],
"cities": [
{
"city": "New York",
"country": "us"
},
{
"city": "Los Angeles",
"country": "us"
}
],
"names": [
"John Doe",
"Peter Pan"
],
"departments": [
"Management",
"Marketing and Advertising"
],
"fieldsExist": [
"name",
"country",
"linkedinUrl"
],
"fieldsNotExist": [
"firstName",
"location",
"jobTitleEnglish"
],
"changedPositionAfter": "2023-01",
"changedPositionBefore": "2023-01"
}
}'
const body = JSON.stringify({
"size": 10,
"searchAfter": "NoBgdA7BAsBMEgGwBoAEAiADgGwK4HN8BTAJwC8wBjAewFt0BdIA",
"companiesFilters": {
"lookalikeDomains": [
"bestcustomer.com",
"idealcustomer.com"
],
"includeDomains": [
"interesting.com",
"amazing.com"
],
"excludeDomains": [
"boring.com",
"useless.com"
],
"companySizes": [
"2-10",
"51-200",
"100001-500000"
],
"ecommerce": true,
"yearFounded": {
"from": 1960,
"to": 1990
},
"countriesCount": {
"from": 1,
"to": 5
},
"revenues": [
"0-1M",
"1-10M",
">1000M"
],
"employeeCountOcean": {
"from": 10,
"to": 100
},
"mobileApps": {
"from": 1,
"to": 5
},
"locationsCount": {
"from": 5,
"to": 10
},
"departmentSizes": [
{
"department": "Accounting and Finance",
"from": 5,
"to": 10
}
],
"employeeCountLinkedin": {
"from": 50,
"to": 100
},
"industries": {
"industries": [
"Advertising Platforms",
"Biopharma"
],
"mode": "anyOf"
},
"excludeIndustries": [
"CRM",
"B2B"
],
"industryCategories": {
"industryCategories": [
"Real Estate",
"Hardware"
],
"mode": "anyOf"
},
"excludeIndustryCategories": [
"Information Technology",
"Privacy and Security"
],
"linkedinIndustries": [
"Management Consulting",
"Computer Software"
],
"excludeLinkedinIndustries": [
"Management Consulting",
"Computer Software"
],
"fundingRound": {
"date": {
"from": "2020-01-01",
"to": "2023-01-01"
},
"raised": {
"from": 1000000,
"to": 5000000
},
"types": [
"Seed",
"Series A"
]
},
"primaryLocations": {
"includeCountries": [
"es",
"pt"
],
"excludeCountries": [
"br",
"de"
],
"includeRegions": [
{
"abbreviation": "CA",
"country": "us"
},
{
"abbreviation": "YT",
"country": "ca"
}
],
"excludeRegions": [
{
"abbreviation": "CA",
"country": "us"
},
{
"abbreviation": "YT",
"country": "ca"
}
],
"includeCities": [
{
"city": "New York",
"country": "us"
},
{
"city": "Los Angeles",
"country": "us"
}
],
"excludeCities": [
{
"city": "New York",
"country": "us"
},
{
"city": "Los Angeles",
"country": "us"
}
],
"geolocation": {
"latitude": 38.880817,
"longitude": -77.10216,
"radius": 1000
}
},
"otherLocations": {
"includeCountries": [
"es",
"pt"
],
"excludeCountries": [
"br",
"de"
],
"includeRegions": [
{
"abbreviation": "CA",
"country": "us"
},
{
"abbreviation": "YT",
"country": "ca"
}
],
"excludeRegions": [
{
"abbreviation": "CA",
"country": "us"
},
{
"abbreviation": "YT",
"country": "ca"
}
],
"includeCities": [
{
"city": "New York",
"country": "us"
},
{
"city": "Los Angeles",
"country": "us"
}
],
"excludeCities": [
{
"city": "New York",
"country": "us"
},
{
"city": "Los Angeles",
"country": "us"
}
],
"geolocation": {
"latitude": 38.880817,
"longitude": -77.10216,
"radius": 1000
}
},
"webTraffic": {
"views": {
"from": 1000,
"to": 1000000
},
"visits": {
"from": 1000,
"to": 10000
}
},
"socialMedias": {
"medias": {
"all_of": [
"facebook",
"x"
],
"any_of": [
"youtube",
"xing"
],
"none_of": [
"instagram",
"tiktok"
]
},
"min_count": 3
},
"technologies": {
"apps": {
"all_of": [
"Amazon Advertising",
"Google Maps"
],
"any_of": [
"BrightEdge",
"Nette Framework"
],
"none_of": [
"Kount",
"Nativo"
]
},
"categories": {
"all_of": [
"Analytics",
"Security"
],
"any_of": [
"Advertising",
"WordPress themes"
],
"none_of": [
"CMS",
"Reviews"
]
}
},
"keywords": {
"all_of": [
"lead generation",
"marketing"
],
"any_of": [
"smart prospecting",
"data platform"
],
"none_of": [
"seo"
]
},
"minRelevance": "B",
"maxRelevance": "B"
},
"peopleFilters": {
"lookalikeLinkedinHandles": [
"michael-scott-13532",
"dwight-schrute"
],
"countries": [
"us",
"dk"
],
"includePeopleIds": [
"43g19df9c1d70f9a",
"54hb1b1bfb1ffc5t"
],
"includeLinkedinHandles": [
"jim-halpert-5343",
"toby-67832"
],
"excludePeopleIds": [
"43g19df9c1d70f9a",
"54hb1b1bfb1ffc5t"
],
"excludeLinkedinHandles": [
"jim-halpert-5343",
"toby-67832"
],
"seniorities": [
"Founder",
"Owner"
],
"skills": {
"allOf": [
"Product Management",
"Entrepreneurship"
],
"anyOf": [
"Social Media",
"Competitive Analysis"
],
"noneOf": [
"Writing",
"Project Management"
]
},
"jobTitleKeywords": {
"allOf": [
"Manager"
],
"anyOf": [
"Marketing",
"designer"
],
"noneOf": [
"content"
]
},
"allJobDescriptions": {
"allOf": [
"software engineer"
],
"anyOf": [
"software engineer"
],
"noneOf": [
"entry-level"
]
},
"currentJobDescription": {
"allOf": [
"software engineer",
"big tech company"
],
"anyOf": [
"software engineer"
],
"noneOf": [
"entry-level"
]
},
"profileDescription": {
"allOf": [
"software engineer"
],
"anyOf": [
"software engineer"
],
"noneOf": [
"entry-level"
]
},
"regions": [
"CA",
"TX"
],
"states": [
{
"abbreviation": "NY",
"country": "us"
},
{
"abbreviation": "ENG",
"country": "gb"
},
{
"abbreviation": "5",
"country": "at"
},
{
"abbreviation": "SH",
"country": "de"
}
],
"cities": [
{
"city": "New York",
"country": "us"
},
{
"city": "Los Angeles",
"country": "us"
}
],
"names": [
"John Doe",
"Peter Pan"
],
"departments": [
"Management",
"Marketing and Advertising"
],
"fieldsExist": [
"name",
"country",
"linkedinUrl"
],
"fieldsNotExist": [
"firstName",
"location",
"jobTitleEnglish"
],
"changedPositionAfter": "2023-01",
"changedPositionBefore": "2023-01"
}
})
fetch("https://api.ocean.io/v3/search/companies?apiToken=string", {
headers: {
"x-api-token": "string"
},
body
})
package main
import (
"fmt"
"net/http"
"io/ioutil"
"strings"
)
func main() {
url := "https://api.ocean.io/v3/search/companies?apiToken=string"
body := strings.NewReader(`{
"size": 10,
"searchAfter": "NoBgdA7BAsBMEgGwBoAEAiADgGwK4HN8BTAJwC8wBjAewFt0BdIA",
"companiesFilters": {
"lookalikeDomains": [
"bestcustomer.com",
"idealcustomer.com"
],
"includeDomains": [
"interesting.com",
"amazing.com"
],
"excludeDomains": [
"boring.com",
"useless.com"
],
"companySizes": [
"2-10",
"51-200",
"100001-500000"
],
"ecommerce": true,
"yearFounded": {
"from": 1960,
"to": 1990
},
"countriesCount": {
"from": 1,
"to": 5
},
"revenues": [
"0-1M",
"1-10M",
">1000M"
],
"employeeCountOcean": {
"from": 10,
"to": 100
},
"mobileApps": {
"from": 1,
"to": 5
},
"locationsCount": {
"from": 5,
"to": 10
},
"departmentSizes": [
{
"department": "Accounting and Finance",
"from": 5,
"to": 10
}
],
"employeeCountLinkedin": {
"from": 50,
"to": 100
},
"industries": {
"industries": [
"Advertising Platforms",
"Biopharma"
],
"mode": "anyOf"
},
"excludeIndustries": [
"CRM",
"B2B"
],
"industryCategories": {
"industryCategories": [
"Real Estate",
"Hardware"
],
"mode": "anyOf"
},
"excludeIndustryCategories": [
"Information Technology",
"Privacy and Security"
],
"linkedinIndustries": [
"Management Consulting",
"Computer Software"
],
"excludeLinkedinIndustries": [
"Management Consulting",
"Computer Software"
],
"fundingRound": {
"date": {
"from": "2020-01-01",
"to": "2023-01-01"
},
"raised": {
"from": 1000000,
"to": 5000000
},
"types": [
"Seed",
"Series A"
]
},
"primaryLocations": {
"includeCountries": [
"es",
"pt"
],
"excludeCountries": [
"br",
"de"
],
"includeRegions": [
{
"abbreviation": "CA",
"country": "us"
},
{
"abbreviation": "YT",
"country": "ca"
}
],
"excludeRegions": [
{
"abbreviation": "CA",
"country": "us"
},
{
"abbreviation": "YT",
"country": "ca"
}
],
"includeCities": [
{
"city": "New York",
"country": "us"
},
{
"city": "Los Angeles",
"country": "us"
}
],
"excludeCities": [
{
"city": "New York",
"country": "us"
},
{
"city": "Los Angeles",
"country": "us"
}
],
"geolocation": {
"latitude": 38.880817,
"longitude": -77.10216,
"radius": 1000
}
},
"otherLocations": {
"includeCountries": [
"es",
"pt"
],
"excludeCountries": [
"br",
"de"
],
"includeRegions": [
{
"abbreviation": "CA",
"country": "us"
},
{
"abbreviation": "YT",
"country": "ca"
}
],
"excludeRegions": [
{
"abbreviation": "CA",
"country": "us"
},
{
"abbreviation": "YT",
"country": "ca"
}
],
"includeCities": [
{
"city": "New York",
"country": "us"
},
{
"city": "Los Angeles",
"country": "us"
}
],
"excludeCities": [
{
"city": "New York",
"country": "us"
},
{
"city": "Los Angeles",
"country": "us"
}
],
"geolocation": {
"latitude": 38.880817,
"longitude": -77.10216,
"radius": 1000
}
},
"webTraffic": {
"views": {
"from": 1000,
"to": 1000000
},
"visits": {
"from": 1000,
"to": 10000
}
},
"socialMedias": {
"medias": {
"all_of": [
"facebook",
"x"
],
"any_of": [
"youtube",
"xing"
],
"none_of": [
"instagram",
"tiktok"
]
},
"min_count": 3
},
"technologies": {
"apps": {
"all_of": [
"Amazon Advertising",
"Google Maps"
],
"any_of": [
"BrightEdge",
"Nette Framework"
],
"none_of": [
"Kount",
"Nativo"
]
},
"categories": {
"all_of": [
"Analytics",
"Security"
],
"any_of": [
"Advertising",
"WordPress themes"
],
"none_of": [
"CMS",
"Reviews"
]
}
},
"keywords": {
"all_of": [
"lead generation",
"marketing"
],
"any_of": [
"smart prospecting",
"data platform"
],
"none_of": [
"seo"
]
},
"minRelevance": "B",
"maxRelevance": "B"
},
"peopleFilters": {
"lookalikeLinkedinHandles": [
"michael-scott-13532",
"dwight-schrute"
],
"countries": [
"us",
"dk"
],
"includePeopleIds": [
"43g19df9c1d70f9a",
"54hb1b1bfb1ffc5t"
],
"includeLinkedinHandles": [
"jim-halpert-5343",
"toby-67832"
],
"excludePeopleIds": [
"43g19df9c1d70f9a",
"54hb1b1bfb1ffc5t"
],
"excludeLinkedinHandles": [
"jim-halpert-5343",
"toby-67832"
],
"seniorities": [
"Founder",
"Owner"
],
"skills": {
"allOf": [
"Product Management",
"Entrepreneurship"
],
"anyOf": [
"Social Media",
"Competitive Analysis"
],
"noneOf": [
"Writing",
"Project Management"
]
},
"jobTitleKeywords": {
"allOf": [
"Manager"
],
"anyOf": [
"Marketing",
"designer"
],
"noneOf": [
"content"
]
},
"allJobDescriptions": {
"allOf": [
"software engineer"
],
"anyOf": [
"software engineer"
],
"noneOf": [
"entry-level"
]
},
"currentJobDescription": {
"allOf": [
"software engineer",
"big tech company"
],
"anyOf": [
"software engineer"
],
"noneOf": [
"entry-level"
]
},
"profileDescription": {
"allOf": [
"software engineer"
],
"anyOf": [
"software engineer"
],
"noneOf": [
"entry-level"
]
},
"regions": [
"CA",
"TX"
],
"states": [
{
"abbreviation": "NY",
"country": "us"
},
{
"abbreviation": "ENG",
"country": "gb"
},
{
"abbreviation": "5",
"country": "at"
},
{
"abbreviation": "SH",
"country": "de"
}
],
"cities": [
{
"city": "New York",
"country": "us"
},
{
"city": "Los Angeles",
"country": "us"
}
],
"names": [
"John Doe",
"Peter Pan"
],
"departments": [
"Management",
"Marketing and Advertising"
],
"fieldsExist": [
"name",
"country",
"linkedinUrl"
],
"fieldsNotExist": [
"firstName",
"location",
"jobTitleEnglish"
],
"changedPositionAfter": "2023-01",
"changedPositionBefore": "2023-01"
}
}`)
req, _ := http.NewRequest("POST", url, body)
req.Header.Add("x-api-token", "string")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
import requests
url = "https://api.ocean.io/v3/search/companies?apiToken=string"
body = {
"size": 10,
"searchAfter": "NoBgdA7BAsBMEgGwBoAEAiADgGwK4HN8BTAJwC8wBjAewFt0BdIA",
"companiesFilters": {
"lookalikeDomains": [
"bestcustomer.com",
"idealcustomer.com"
],
"includeDomains": [
"interesting.com",
"amazing.com"
],
"excludeDomains": [
"boring.com",
"useless.com"
],
"companySizes": [
"2-10",
"51-200",
"100001-500000"
],
"ecommerce": true,
"yearFounded": {
"from": 1960,
"to": 1990
},
"countriesCount": {
"from": 1,
"to": 5
},
"revenues": [
"0-1M",
"1-10M",
">1000M"
],
"employeeCountOcean": {
"from": 10,
"to": 100
},
"mobileApps": {
"from": 1,
"to": 5
},
"locationsCount": {
"from": 5,
"to": 10
},
"departmentSizes": [
{
"department": "Accounting and Finance",
"from": 5,
"to": 10
}
],
"employeeCountLinkedin": {
"from": 50,
"to": 100
},
"industries": {
"industries": [
"Advertising Platforms",
"Biopharma"
],
"mode": "anyOf"
},
"excludeIndustries": [
"CRM",
"B2B"
],
"industryCategories": {
"industryCategories": [
"Real Estate",
"Hardware"
],
"mode": "anyOf"
},
"excludeIndustryCategories": [
"Information Technology",
"Privacy and Security"
],
"linkedinIndustries": [
"Management Consulting",
"Computer Software"
],
"excludeLinkedinIndustries": [
"Management Consulting",
"Computer Software"
],
"fundingRound": {
"date": {
"from": "2020-01-01",
"to": "2023-01-01"
},
"raised": {
"from": 1000000,
"to": 5000000
},
"types": [
"Seed",
"Series A"
]
},
"primaryLocations": {
"includeCountries": [
"es",
"pt"
],
"excludeCountries": [
"br",
"de"
],
"includeRegions": [
{
"abbreviation": "CA",
"country": "us"
},
{
"abbreviation": "YT",
"country": "ca"
}
],
"excludeRegions": [
{
"abbreviation": "CA",
"country": "us"
},
{
"abbreviation": "YT",
"country": "ca"
}
],
"includeCities": [
{
"city": "New York",
"country": "us"
},
{
"city": "Los Angeles",
"country": "us"
}
],
"excludeCities": [
{
"city": "New York",
"country": "us"
},
{
"city": "Los Angeles",
"country": "us"
}
],
"geolocation": {
"latitude": 38.880817,
"longitude": -77.10216,
"radius": 1000
}
},
"otherLocations": {
"includeCountries": [
"es",
"pt"
],
"excludeCountries": [
"br",
"de"
],
"includeRegions": [
{
"abbreviation": "CA",
"country": "us"
},
{
"abbreviation": "YT",
"country": "ca"
}
],
"excludeRegions": [
{
"abbreviation": "CA",
"country": "us"
},
{
"abbreviation": "YT",
"country": "ca"
}
],
"includeCities": [
{
"city": "New York",
"country": "us"
},
{
"city": "Los Angeles",
"country": "us"
}
],
"excludeCities": [
{
"city": "New York",
"country": "us"
},
{
"city": "Los Angeles",
"country": "us"
}
],
"geolocation": {
"latitude": 38.880817,
"longitude": -77.10216,
"radius": 1000
}
},
"webTraffic": {
"views": {
"from": 1000,
"to": 1000000
},
"visits": {
"from": 1000,
"to": 10000
}
},
"socialMedias": {
"medias": {
"all_of": [
"facebook",
"x"
],
"any_of": [
"youtube",
"xing"
],
"none_of": [
"instagram",
"tiktok"
]
},
"min_count": 3
},
"technologies": {
"apps": {
"all_of": [
"Amazon Advertising",
"Google Maps"
],
"any_of": [
"BrightEdge",
"Nette Framework"
],
"none_of": [
"Kount",
"Nativo"
]
},
"categories": {
"all_of": [
"Analytics",
"Security"
],
"any_of": [
"Advertising",
"WordPress themes"
],
"none_of": [
"CMS",
"Reviews"
]
}
},
"keywords": {
"all_of": [
"lead generation",
"marketing"
],
"any_of": [
"smart prospecting",
"data platform"
],
"none_of": [
"seo"
]
},
"minRelevance": "B",
"maxRelevance": "B"
},
"peopleFilters": {
"lookalikeLinkedinHandles": [
"michael-scott-13532",
"dwight-schrute"
],
"countries": [
"us",
"dk"
],
"includePeopleIds": [
"43g19df9c1d70f9a",
"54hb1b1bfb1ffc5t"
],
"includeLinkedinHandles": [
"jim-halpert-5343",
"toby-67832"
],
"excludePeopleIds": [
"43g19df9c1d70f9a",
"54hb1b1bfb1ffc5t"
],
"excludeLinkedinHandles": [
"jim-halpert-5343",
"toby-67832"
],
"seniorities": [
"Founder",
"Owner"
],
"skills": {
"allOf": [
"Product Management",
"Entrepreneurship"
],
"anyOf": [
"Social Media",
"Competitive Analysis"
],
"noneOf": [
"Writing",
"Project Management"
]
},
"jobTitleKeywords": {
"allOf": [
"Manager"
],
"anyOf": [
"Marketing",
"designer"
],
"noneOf": [
"content"
]
},
"allJobDescriptions": {
"allOf": [
"software engineer"
],
"anyOf": [
"software engineer"
],
"noneOf": [
"entry-level"
]
},
"currentJobDescription": {
"allOf": [
"software engineer",
"big tech company"
],
"anyOf": [
"software engineer"
],
"noneOf": [
"entry-level"
]
},
"profileDescription": {
"allOf": [
"software engineer"
],
"anyOf": [
"software engineer"
],
"noneOf": [
"entry-level"
]
},
"regions": [
"CA",
"TX"
],
"states": [
{
"abbreviation": "NY",
"country": "us"
},
{
"abbreviation": "ENG",
"country": "gb"
},
{
"abbreviation": "5",
"country": "at"
},
{
"abbreviation": "SH",
"country": "de"
}
],
"cities": [
{
"city": "New York",
"country": "us"
},
{
"city": "Los Angeles",
"country": "us"
}
],
"names": [
"John Doe",
"Peter Pan"
],
"departments": [
"Management",
"Marketing and Advertising"
],
"fieldsExist": [
"name",
"country",
"linkedinUrl"
],
"fieldsNotExist": [
"firstName",
"location",
"jobTitleEnglish"
],
"changedPositionAfter": "2023-01",
"changedPositionBefore": "2023-01"
}
}
response = requests.request("POST", url, json = body, headers = {
"x-api-token": "string",
"Content-Type": "application/json"
})
print(response.text)
{
"searchAfter": "NoBgdA7BAsBMEgGwBoAEAiADgGwK4HN8BTAJwC8wBjAewFt0BdIA",
"detail": "OK",
"total": 32871,
"missingDomains": {
"domain-with-bad-content.com": "bad content",
"domain-with-missing-context-vector.com": "missing context vector",
"not-yet-crawled-domain.com": "data gathering started"
},
"companies": [
{
"company": {
"domain": "dundermifflinpaper.com",
"countries": [
"us",
"ca"
],
"primaryCountry": "us",
"companySize": "2-10",
"industryCategories": [
"Consumer Electronics",
"Hardware"
],
"industries": [
"Audio",
"Electronics"
],
"linkedinIndustry": "Computer Software",
"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": [
{
"country": "us",
"number": "+1 212 456 7890",
"primary": true
},
{
"country": "ca",
"number": "+1 250 555 0199"
}
],
"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": {
"bounceRate": 0.5227,
"pageViews": 2155984,
"pagesPerVisit": 4.88,
"visits": 10000
},
"medias": {
"linkedin": {
"handle": "dunder-mifflin",
"name": "Dunder Mifflin Paper Company, Inc.",
"url": "https://www.linkedin.com/company/dunder-mifflin"
},
"twitter": {
"handle": "dunder-mifflin",
"name": "Dunder Mifflin Paper Company, Inc.",
"url": "https://twitter.com/dunder-mifflin"
},
"youtube": {
"handle": "dunder-mifflin",
"name": "Dunder Mifflin Paper Company, Inc.",
"url": "https://youtube.com/channel/dunder-mifflin"
},
"facebook": {
"handle": "dunder-mifflin",
"name": "Dunder Mifflin Paper Company, Inc.",
"url": "https://facebook.com/dunder-mifflin"
},
"xing": {
"handle": "dunder-mifflin",
"name": "Dunder Mifflin Paper Company, Inc.",
"url": "https://xing.com/dunder-mifflin"
},
"tiktok": {
"handle": "dunder-mifflin",
"name": "Dunder Mifflin Paper Company, Inc.",
"url": "https://tiktok.com/dunder-mifflin"
},
"instagram": {
"handle": "dunder-mifflin",
"name": "Dunder Mifflin Paper Company, Inc.",
"url": "https://instagram.com/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": [
{
"department": "Accounting and Finance",
"size": 10
},
{
"department": "Sales",
"size": 15
}
],
"rootUrl": "https://dundermifflinpaper.com/",
"faxes": [
{
"country": "us",
"number": "5709045026",
"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"
}
]
},
"fundingRound": {
"cbUrl": "https://www.crunchbase.com/funding_round/orderyoyo-post-ipo-equity--5c26b0c0",
"date": "2020-01-01",
"moneyRaisedInUsd": 1000000,
"type": "Seed"
},
"headcountGrowth": {
"sixMonths": 20,
"threeMonths": 10,
"twelveMonths": 30
},
"headcountGrowthPerDepartment": [
{
"department": "Accounting and Finance",
"growth": {
"sixMonths": 20,
"threeMonths": 10,
"twelveMonths": 30
}
}
]
},
"relevance": "A"
}
]
}
{
"detail": "Conflicting API tokens provided in query parameters and headers"
}
{
"detail": "Insufficient credits"
}
{
"detail": "API token should be provided in headers or query parameters"
}
Empty
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}