latestOpenAPI 3.0.12026-08-17127235413.6 KB

eab6a2753503

Deals

Deal Search

Retrieves deals along with the companies associated with the deal

get/deals/search

Query parameters

companyNamesstring

Accepts company names, pbIds, websites, and tickers to find all deals. Returns a list of deals related to companies that are an exact match. Use a comma to separate multiple values

ownershipStatusstring

Search for deals by <a href="https://my.pitchbook.com/api/lookup-tables/Companies#OWNERSHIP_STATUS_TREE" target="_blank">ownership status code</a> of the companies involved

backingStatusstring

Search for deals by <a href="https://my.pitchbook.com/api/lookup-tables/Companies#BACKING_STATUS_TREE" target="_blank">backing status code</a> of the companies involved

businessStatusstring

Search for deals by <a href="https://my.pitchbook.com/api/lookup-tables/Companies#BUSINESS_STATUS_TREE" target="_blank">business status code</a> of the companies involved

citystring

Search for deals by city location of the companies involved

stateProvincestring

Search for deals by <a href="https://my.pitchbook.com/api/lookup-tables/Location#US_STATE_TREE" target="_blank">state code</a> or <a href="https://my.pitchbook.com/api/lookup-tables/Location#CANADIAN_PROVINCE_TREE" target="_blank">province code</a> of the companies involved

countrystring

Search for deals by <a href="https://my.pitchbook.com/api/lookup-tables/Location#COUNTRY_TREE" target="_blank">country code</a> of the companies involved

postCodestring

Search for deals by postcode of the companies involved, included to support searching for both US postal code and foreign

locationTypestring

Search for deals by additional parameter concerning the companies involved specifying HQ Only (HQ_ONLY), Non-HQ Only (NON_HQ_ONLY) or any office location (ANY) values. Set this parameter in pair with city, stateProvince, country, postCode options

dateFoundedstring

Deals can be found by founding date of the companies involved. Search for deals of companies founded after a certain date using the > operator, companies founded before a certain date using the < operator and companies founded between 2 dates using the ^ operator. Format: YYYY-MM-DD

industrystring

Deals can be found by the <a href="https://my.pitchbook.com/api/lookup-tables/Industries, Verticals & Emerging Spaces#INDUSTRY_TREE" target="_blank">industry code</a> of the companies involved. Only one industry classification can be used at a time. This parameter cannot be combined with parameters from other industry classifications

verticalsstring

Deals can be found by the <a href="https://my.pitchbook.com/api/lookup-tables/Industries, Verticals & Emerging Spaces#VERTICAL_TREE" target="_blank">vertical code</a> of the companies involved. Only one industry classification can be used at a time. This parameter cannot be combined with parameters from other industry classifications

industryAndVerticalstring

When using both industry and vertical parameters, "OR" logic is used by default. To use "AND" logic, set this parameter to True. Set this parameter in pair with industry and vertical options

gecsSectorstring

Deals can be found by the <a href="https://my.pitchbook.com/api/lookup-tables/Industries, Verticals & Emerging Spaces#GECS_SECTOR_TREE" target="_blank">GECS sector code</a> of the companies involved. Only one industry classification can be used at a time. This parameter cannot be combined with parameters from other industry classifications

gecsIndustryGroupstring

Deals can be found by the <a href="https://my.pitchbook.com/api/lookup-tables/Industries, Verticals & Emerging Spaces#GECS_INDUSTRY_GROUP_TREE" target="_blank">GECS industry group code</a> of the companies involved. Only one industry classification can be used at a time. This parameter cannot be combined with parameters from other industry classifications

gecsIndustrystring

Deals can be found by the <a href="https://my.pitchbook.com/api/lookup-tables/Industries, Verticals & Emerging Spaces#GECS_INDUSTRY_TREE" target="_blank">GECS industry code</a> of the companies involved. Only one industry classification can be used at a time. This parameter cannot be combined with parameters from other industry classifications

totalRaisedstring

Find deals by the companies' total amount of money they have raised to date in millions. Use the > operator to find companies that have raised more than a certain value, use the < to find companies who have raised less than a certain value and the ^ operator to search within a range. Amounts in millions

keywordsstring

Search for deals by keywords associated with the companies involved or keywords appearing in their business description. Only one industry classification can be used at a time. This parameter cannot be combined with parameters from other industry classifications

onlyMostRecentTransactionstring

Find most recent deals. To use this parameter set it as True

dealTypestring

Find specific <a href="https://my.pitchbook.com/api/lookup-tables/Deals#DEAL_TYPE_TREE" target="_blank">deal type code</a>

dealStatusstring

Distinguish between failed, upcoming, completed deals and more. Pass a <a href="https://my.pitchbook.com/api/lookup-tables/Deals#DEAL_STATUS_TREE" target="_blank">deal status code</a>

dealSizestring

Find deals of a certain size. Search for deals larger than an amount using the > operator, deals smaller than a certain amount using the < operator and deals in a range using the ^ operator. Amounts in millions

includeDealsWithoutDealSizestring

Include deals without a known deal size. Set this parameter as True only when Deal Size parameter is applied. False by default

excludeDealsWithoutDealSizestring

Exclude deals without a known deal size. Set this parameter as True only when Deal Size parameter is not applied. False by default

dealDatestring

Find deals within a certain time frame. Search for a deal after a certain date using the > operator, a deal before a certain date using the < operator and a deal between 2 dates using the ^ operator. Format: YYYY-MM-DD

partialExitstring

Find deals with partial investor's exit within them. To use this parameter set it as True

fullExitstring

Find deals with full investor's exit within them. To use this parameter set it as True

investorNamesstring

Search for deals by who invested in them with an exact match. Accepts investor names, pbIds, websites, and tickers to return all deals they participated in. Use a comma to separate multiple values

exitTypestring

Find specific deal types with investor's exit within them. Pass a <a href="https://my.pitchbook.com/api/lookup-tables/Deals#EXIT_TYPE_TREE" target="_blank">exit type code</a>

exitStatusstring

Distinguish between failed, upcoming, completed exits and more. Pass a <a href="https://my.pitchbook.com/api/lookup-tables/Deals#DEAL_STATUS_TREE" target="_blank">deal status code</a>

exitSizestring

Find deals of a certain size with investor's exit within them. Search for deals with an exit larger than an amount using the > operator, deals with an exit smaller than a certain amount using the < operator and deals with an exit size in a range using the ^ operator. Amounts in millions

exitDatestring

Find deals of a certain time frame with investor's exit within them. Search for deals with an exit after a certain date using the > operator, companies with an exit before a certain date using the < operator and companies with an exit between 2 dates using the ^ operator. Format: YYYY-MM-DD

preMoneyValuationstring

Search for deals by companies' valuation prior to a financing. Search for deals with companies' valuation prior to a financing larger than an amount using the > operator, deals with companies' valuation prior to a financing smaller than a certain amount using the < operator and deals with companies' valuation prior to a financing in a range using the ^ operator. Amounts in millions

postValuationstring

Search for deals by companies' valuation prior at or post investment. Search for deals with companies' valuation prior at or post investment larger than an amount using the > operator, deals with companies' valuation prior at or post investment smaller than a certain amount using the < operator and deals with companies' valuation prior at or post investment in a range using the ^ operator. Amounts in millions

revenuestring

Find deals by the revenue of the companies involved. Search for deals with companies' revenue more than an amount using the > operator, deals with companies' revenue less than an amount using the < operator or deals with companies' revenue in a range using the ^ operator. Amounts in millions

currencystring

Specify the currency that your other parameters, such as dealSize, are entered as. It depends on the <a href="https://my.pitchbook.com/api/lookup-tables/Currency#CURRENCY_CODE_TREE" target="_blank">currency</a> in user preferences

pagestring

Results are returned so that they can be paged through. Set this parameter to increment the page

perPagestring

How many returned results show on page

Response

OK