Lookalike companies search (deprecated)

Search companies using filters.

Cost calculation:

  • Request that contains one or more lookalike companies - 3 credits per company in the result
  • Request that does not contain lookalike companies - 1 credit per company in the result
POST
/v2/search/companies

Query Parameters

apiToken?string | null

Header Parameters

x-api-token?string | null

Request Body

size?integer

Number of companies to return. The maximum value is 10,000. To get more than 10,000 results, use searchAfter.

Default50
Example10
Range1 <= value <= 10000
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

Default1
Example10
Range1 <= value <= 10001
searchAfter?string

Use searchAfter returned by the previous request to get the next page

Example"NoBgdA7BAsBMEgGwBoAEAiADgGwK4HN8BTAJwC8wBjAewFt0BdIA"
companiesFilters?CompaniesFiltersV1

Collection of companies filters to be applied to the search

peopleFilters?PeopleFilters

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

Response Body

curl -X POST "https://api.ocean.io/v2/search/companies?apiToken=string" \
  -H "x-api-token: string" \
  -H "Content-Type: application/json" \
  -d '{}'
{
  "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"
  },
  "redirectMap": {
    "given_local_domain.uk": "original.com",
    "ikea.nl": "ikea.com"
  },
  "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
            }
          }
        ]
      },
      "score": 0.96
    }
  ]
}
{
  "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"
    }
  ]
}