Sign in

v2

latestOpenAPI 3.1.02026-07-2626156230.6 KB
Search

Lookalike companies search (deprecated)

Search companies using filters.

post/v2/search/companies

Query parameters

apiTokenstring nullable

Headers

x-api-tokenstring nullable

Request body

sizeinteger

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

frominteger

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

searchAfterstring nullable

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

fieldsCompanyField[] nullable

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.

Example request

{
  "size": 10,
  "from": 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,
    "revenues": [
      "0-1M",
      "1-10M",
      ">1000M"
    ],
    "departmentSizes": [
      {
        "department": "Accounting and Finance",
        "from": 5,
        "to": 10
      }
    ],
    "industries": {
      "industries": [
        "Digital Agencies",
        "Advertising Services"
      ]
    },
    "excludeIndustries": [
      "CRM",
      "B2B"
    ],
    "excludeIndustryCategories": [
      "Information Technology",
      "Privacy and Security"
    ],
    "linkedinIndustries": [
      "Management Consulting",
      "Computer Software"
    ],
    "excludeLinkedinIndustries": [
      "Management Consulting",
      "Computer Software"
    ],
    "fundingRound": {
      "types": [
        "Seed",
        "Series A"
      ]
    },
    "countries": [
      "es",
      "pt"
    ],
    "primaryCountries": [
      "de"
    ],
    "states": [
      {
        "abbreviation": "CA",
        "country": "us"
      },
      {
        "abbreviation": "YT",
        "country": "ca"
      }
    ],
    "primaryStates": [
      {
        "abbreviation": "NY",
        "country": "us"
      }
    ],
    "cities": [
      {
        "city": "New York",
        "country": "us"
      },
      {
        "city": "Los Angeles",
        "country": "us"
      }
    ],
    "primaryCities": [
      {
        "city": "New York",
        "country": "us"
      },
      {
        "city": "Los Angeles",
        "country": "us"
      }
    ],
    "fieldsExist": [
      "industries",
      "emails",
      "locations"
    ],
    "fieldsNotExist": [
      "industryCategories",
      "phones"
    ],
    "minScore": 0.95
  },
  "peopleFilters": {
    "includeIds": [
      "51e19df9c1d70c7c",
      "971b1b1bfb1ffb1a"
    ],
    "excludeIds": [
      "51e19df9c1d70c7c",
      "971b1b1bfb1ffb1a"
    ],
    "seniorities": [
      "Founder",
      "Owner"
    ],
    "jobTitles": [
      "CEO",
      "CTO"
    ],
    "excludeJobTitles": [
      "CEO",
      "CTO"
    ],
    "departments": [
      "Management",
      "Marketing and Advertising"
    ],
    "countries": [
      "us",
      "dk"
    ],
    "states": [
      {
        "abbreviation": "NY",
        "country": "us"
      },
      {
        "abbreviation": "ON",
        "country": "ca"
      },
      {
        "abbreviation": "5",
        "country": "at"
      },
      {
        "abbreviation": "SH",
        "country": "de"
      }
    ],
    "excludeStates": [
      {
        "abbreviation": "NY",
        "country": "us"
      },
      {
        "abbreviation": "ON",
        "country": "ca"
      },
      {
        "abbreviation": "5",
        "country": "at"
      },
      {
        "abbreviation": "SH",
        "country": "de"
      }
    ],
    "excludeCountries": [
      "us",
      "dk"
    ],
    "names": [
      "John Doe",
      "Peter Pan"
    ],
    "emails": [
      "email_1@domain.com",
      "email_2@domain.com"
    ],
    "keywords": [
      "engineering",
      "research"
    ],
    "fieldsExist": [
      "name",
      "country",
      "linkedinUrl"
    ],
    "fieldsNotExist": [
      "firstName",
      "location",
      "jobTitleEnglish"
    ],
    "changedPositionAfter": "2023-01",
    "changedPositionBefore": "2023-01"
  },
  "fields": [
    "domain",
    "countries",
    "primaryCountry",
    "companySize",
    "industryCategories",
    "industries",
    "linkedinIndustry",
    "ecommerce",
    "keywords",
    "employeeCountOcean",
    "employeeCountLinkedin",
    "revenue",
    "yearFounded",
    "description",
    "emails",
    "phones",
    "logo",
    "technologies",
    "technologyCategories",
    "mobileApps",
    "webTraffic",
    "medias",
    "name",
    "legalName",
    "locations",
    "departmentSizes",
    "rootUrl",
    "faxes",
    "impressum",
    "fundingRound",
    "updatedAt"
  ]
}

Response

Successful Response

searchAfterstring nullable

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.

detailstring required

Status text

totalinteger nullable

Total number of results of the search, accessible with pagination.

missingDomainsobject nullable

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

redirectMapobject nullable

Mapping of original domains passed in filters to their redirected domains.

creditsUsednumber required

Number of credits charged for this request.

Example response

{
  "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"
  },
  "creditsUsed": 1,
  "companies": [
    {
      "company": {
        "domain": "dundermifflinpaper.com",
        "countries": [
          "us",
          "ca"
        ],
        "primaryCountry": "us",
        "industryCategories": [
          "Consumer Electronics",
          "Hardware"
        ],
        "industries": [
          "Audio",
          "Electronics"
        ],
        "linkedinIndustry": "Computer Software",
        "ecommerce": true,
        "keywords": [
          "paper",
          "premium copy paper"
        ],
        "employeeCountOcean": 57,
        "employeeCountLinkedin": 70,
        "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"
          }
        ],
        "medias": {
          "linkedin": {
            "specialties": [
              "artificial intelligence",
              "machine learning"
            ]
          },
          "twitter": {
            "specialties": [
              "artificial intelligence",
              "machine learning"
            ]
          },
          "youtube": {
            "specialties": [
              "artificial intelligence",
              "machine learning"
            ]
          },
          "facebook": {
            "specialties": [
              "artificial intelligence",
              "machine learning"
            ]
          },
          "xing": {
            "specialties": [
              "artificial intelligence",
              "machine learning"
            ]
          },
          "tiktok": {
            "specialties": [
              "artificial intelligence",
              "machine learning"
            ]
          },
          "instagram": {
            "specialties": [
              "artificial intelligence",
              "machine learning"
            ]
          }
        },
        "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"
            }
          ]
        },
        "redirectedFrom": [
          "pol.dk",
          "pressen.nu"
        ],
        "updatedAt": "2022-08-22T12:09:37Z",
        "headcountGrowthPerDepartment": [
          {
            "department": "Accounting and Finance",
            "growth": {
              "sixMonths": 10,
              "sixMonthsPercentage": 0.2,
              "threeMonths": 5,
              "threeMonthsPercentage": 0.1,
              "twelveMonths": 15,
              "twelveMonthsPercentage": 0.3
            }
          }
        ]
      },
      "score": 0.96
    }
  ]
}