POST/v3/live/company/match

Match

Accepts company attributes and returns matching companies ranked by relevance. At least one of companyName, website, socialProfile, socialProfileId, or listing is required; the first four are plain strings, listing takes (ticker, exchange) pairs, and each is a hard requirement. On the attribute filters (industry, country, etc.) 'or' is a soft ranking preference while 'and' is a hard filter accepting a single value; 'not' values are hard exclusions.

Request body

Each filter is an object of and / or / not arrays. or boosts matches without excluding others; use and with a single value to filter.

  • 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

    and accepts at most one value here — a company has exactly one; use or to match any of several.

    AND
    public

    The single value the company must hold (hard filter). A company holds exactly one value, so more than one distinct value (compared after trimming and, except for the range codes, ignoring case) is rejected with a 400, as is a value that is also in not

    OR

    Values that raise the ranking of companies holding any of them, without excluding the rest

    NOT

    Values the company must not hold (hard exclusion)

    Pick a suggestion or press Enter · Backspace on empty removes the last
  • industryobjectOptional
    Filter by industry. 'or' boosts matches without excluding others; use 'and' with a single value to filter

    and accepts at most one value here — a company has exactly one; use or to match any of several.

    AND

    The single value the company must hold (hard filter). A company holds exactly one value, so more than one distinct value (compared after trimming and, except for the range codes, ignoring case) is rejected with a 400, as is a value that is also in not

    OR
    computer software

    Values that raise the ranking of companies holding any of them, without excluding the rest

    NOT

    Values the company must not hold (hard exclusion)

    Pick a suggestion or press Enter · Backspace on empty removes the last
  • countryobjectOptional
    Filter by country. 'or' boosts matches without excluding others; use 'and' with a single value to filter

    and accepts at most one value here — a company has exactly one; use or to match any of several.

    AND

    The single value the company must hold (hard filter). A company holds exactly one value, so more than one distinct value (compared after trimming and, except for the range codes, ignoring case) is rejected with a 400, as is a value that is also in not

    OR
    united states

    Values that raise the ranking of companies holding any of them, without excluding the rest

    NOT

    Values the company must not hold (hard exclusion)

    Enter adds a value · Backspace on empty removes the last
  • 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

    and accepts at most one value here — a company has exactly one; use or to match any of several.

    AND

    The single value the company must hold (hard filter). A company holds exactly one value, so more than one distinct value (compared after trimming and, except for the range codes, ignoring case) is rejected with a 400, as is a value that is also in not

    OR
    california

    Values that raise the ranking of companies holding any of them, without excluding the rest

    NOT

    Values the company must not hold (hard exclusion)

    Enter adds a value · Backspace on empty removes the last
  • localityobjectOptional
    Filter by locality (city). 'or' boosts matches without excluding others; use 'and' with a single value to filter

    and accepts at most one value here — a company has exactly one; use or to match any of several.

    AND

    The single value the company must hold (hard filter). A company holds exactly one value, so more than one distinct value (compared after trimming and, except for the range codes, ignoring case) is rejected with a 400, as is a value that is also in not

    OR
    san francisco

    Values that raise the ranking of companies holding any of them, without excluding the rest

    NOT

    Values the company must not hold (hard exclusion)

    Enter adds a value · Backspace on empty removes the last
  • employeeCountRangeobjectOptional
    Filter by employee count range. 'or' boosts matches without excluding others; use 'and' with a single value to filter

    and accepts at most one value here — a company has exactly one; use or to match any of several.

    AND

    The single value the company must hold (hard filter). A company holds exactly one value, so more than one distinct value (compared after trimming and, except for the range codes, ignoring case) is rejected with a 400, as is a value that is also in not

    OR
    10001+

    Values that raise the ranking of companies holding any of them, without excluding the rest

    NOT

    Values the company must not hold (hard exclusion)

    Pick a suggestion or press Enter · Backspace on empty removes the last
  • revenueRangeInferredobjectOptional
    Filter by inferred revenue range. 'or' boosts matches without excluding others; use 'and' with a single value to filter

    and accepts at most one value here — a company has exactly one; use or to match any of several.

    AND

    The single value the company must hold (hard filter). A company holds exactly one value, so more than one distinct value (compared after trimming and, except for the range codes, ignoring case) is rejected with a 400, as is a value that is also in not

    OR
    $10B+

    Values that raise the ranking of companies holding any of them, without excluding the rest

    NOT

    Values the company must not hold (hard exclusion)

    Pick a suggestion or press Enter · Backspace on empty removes the last
  • 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
    • notobject[]Optional
      Values that must NOT match (hard exclusion)
    • orobject[]Optional
      Values where at least ONE must match (hard requirement)
  • 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
Headers
x-api-key Required · API key for authentication

Response

  • resultsobject[]
    • 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
    • Type of company
    • countrystring
      Country of the company's primary address
    • ISO 3166-1 alpha-2 code of the company's country
    • Primary stock ticker symbol, for public companies. Null when the company is not publicly traded.
    • Primary stock exchange the company trades on. Null when the company is not publicly traded.

Status codes