POST/v3/live/company/match/bulk

Bulk match

Accepts up to 25 company match requests and returns one entry per request, in the same order, each with its matching companies ranked by relevance. Every request takes the same fields and follows the same rules as a single match, plus optional metadata that is echoed back. A request the single match would reject fails the whole batch with a 400 naming its position. Billed one credit per request that matched at least one company; requests with no match are not charged.

Version
v3
Rate limit
Tier 3 · 10–200 rps by plan
Billing
Company Search · Bulk match

Request body

  • requestsobject[]Optional
    Match requests, at most 25. Each takes the same fields as a single company match, plus optional metadata; results come back in the same order
    • companyNamestringOptional
      Company name. Supply this, website, socialProfile, or socialProfileId
    • websitestringOptional
      Company website, normalized to strip protocol and query string. Supply this, companyName, socialProfile, or socialProfileId
    • socialProfilestringOptional
      Social profile URL of the company, normalized to strip protocol, subdomain, and query string. Supply this, companyName, website, or socialProfileId
    • socialProfileIdstringOptional
      Numeric social profile ID of the company, matched exactly. Supply this, companyName, website, or socialProfile
    • companyTypeobjectOptional
      Filter by company type. 'or' boosts matches without excluding other types; use 'and' with a single value to filter
    • industryobjectOptional
      Filter by industry. 'or' boosts matches without excluding others; use 'and' with a single value to filter
    • countryobjectOptional
      Filter by country. 'or' boosts matches without excluding others; use 'and' with a single value to filter
    • countryCodeobjectOptional
      Filter by ISO 3166-1 alpha-2 country code, such as 'DE'. Matched case-insensitively; an unrecognized code is rejected with a 400. 'or' boosts matches without excluding others; use 'and' with a single value to filter
    • regionobjectOptional
      Filter by region (state/province). 'or' boosts matches without excluding others; use 'and' with a single value to filter
    • localityobjectOptional
      Filter by locality (city). 'or' boosts matches without excluding others; use 'and' with a single value to filter
    • employeeCountRangeobjectOptional
      Filter by employee count range. 'or' boosts matches without excluding others; use 'and' with a single value to filter
    • revenueRangeInferredobjectOptional
      Filter by inferred revenue range. 'or' boosts matches without excluding others; use 'and' with a single value to filter
    • primaryExchangeobjectOptional
      Filter by primary stock exchange, on its own. 'or' boosts matches without excluding others; use 'and' with a single value to filter. Reach for this to screen by exchange alone; when you know the ticker too, send them together as 'listing'
    • primaryTickerobjectOptional
      Filter by primary ticker symbol, on its own. 'or' boosts matches without excluding others; use 'and' with a single value to filter. Reach for this when the exchange is unknown; when you know it, send the two together as 'listing'
    • listingobjectOptional
      Stock listing as a (ticker, exchange) pair — a ticker is unique only within an exchange, so the pair is what identifies a listing. Each pair must carry both halves, and 'or' values are a hard requirement: the company must hold one of the pairs. Counts as an identity field, so a listing alone is enough to match on. Only a company's primary listing is indexed, so a secondary cross-listing will not match
    • latestFundingStageobjectOptional
      Filter by latest funding stage. 'or' boosts matches without excluding others; use 'and' with a single value to filter
    • fundingRoundCountobjectOptional
      Filter by funding round count (min/max)
    • fundingTotalobjectOptional
      Filter by total funding amount (min/max)
    • latestFundingAmountobjectOptional
      Filter by latest funding amount (min/max)
    • latestFundingDateobjectOptional
      Filter by latest funding date (gte/lte, supports YYYY, YYYY-MM, or YYYY-MM-DD)
    • keywordsobjectOptional
      Keyword filter matched against company description and tags. Unlike the other filters every clause here is hard and takes any number of values: 'and' requires all its keywords, 'or' requires at least one, 'not' excludes. Bounded by the total number of words across 'and', 'or' and 'not' rather than by the number of keywords, so one long phrase costs as much as several single words; a filter too large to evaluate is rejected with a 400
    • metadataobjectOptional
      Optional metadata to associate with the request. Will be returned in the response.
Headers
x-api-key Required · API key for authentication

Response

  • metadataobject
    Caller-supplied metadata echoed back from the request.
  • resultsobject[]
    Companies matching this request, ranked by relevance. Empty when nothing matched
    • displayNamestring
    • aggkCompanyIdstring
      AggKnowledge company ID
    • socialProfilestring
      Normalized company social profile URL. Absent when the company has none on file.
    • socialProfileIdinteger (int64)
      Company social profile ID. Absent when the company has no social profile on file.
    • namestring
    • websitestring
    • cleanedWebsitestring
      Company website without its scheme, leading www., query string or trailing slash. Keeps any subdomain and path.
    • cleanedDomainstring
      Host of the company website, without a leading www. or any path
    • rootDomainstring
      Registrable domain of the company website under the Public Suffix List, e.g. example.co.uk for shop.example.co.uk
    • descriptionstring
      Brief description of the company
    • tagsstring[]
      Tags associated with the company
    • companyTypeenum CompanyType
      Type of company
    • countrystring
      Country of the company's primary address
    • countryCodeenum CountryCode
      ISO 3166-1 alpha-2 code of the company's country
    • primaryTickerstring
      Primary stock ticker symbol, for public companies. Null when the company is not publicly traded.
    • primaryExchangestring
      Primary stock exchange the company trades on. Null when the company is not publicly traded.

Status codes