How to query
You can use the query below to get the deals matching your API subscription:
You can query the API for specific criteria by adding one or more parameters to the API call. The response will only include deals matching at least one of the criteria specified.
Multiple criteria are interpreted using AND condition, whereas multiple values for the same criteria are interpreted with OR condition. For example to get all deals completed on or after the 1 January 2020 AND with dominant country USA, use:
To get all deals in the energy OR utilities sectors, use:
To get a single deal, you need to pass the deal’s ID to the query:
Results are returned by the API in blocks of 20 items per page. The position of the first item in the active response is identified by the value ‘firstCursor’ and the value ‘lastCursor’ identifies the position of the last item of the active response:
To paginate through the whole response you have to use the query parameters ‘pageAfter’ and ‘pageBefore’.
Passing the value of ‘lastCursor’ to ‘pageAfter’ in the API query will yield the next 20 items:
Passing the value of ‘firstCursor’ to ‘pageBefore’ in the API query will yield the previous 20 items:
When there are no pages left to return, the response will look similar to the following: