Getting started

Introduction

The Gain.pro API gives you programmatic access to all data on the Gain.pro platform. In addition, you can also manage users, saved filters and companies lists with it. In fact, the Gain.pro app uses the exact same API. So you get access to the same functionality as is available to our own frontend code. This means that besides this documentation you can also use your browser developer tools to see how the API is used and which methods are called on each page by our frontend code. We highly recommend doing this while exploring this documentation. See Using the browser to get started.

The Gain.pro API uses the JSONRPC light-weight remote procedure call (RPC) protocol. It’s a simple protocol based on JSON. We recommend skimming through the specification before reading on. It’s very short and simple.

Alright. Now that you know how JSONRPC more or less works, let’s begin with an example API call using curl:

> curl -X POST --location "https://gain.pro/app/rpc/" \
-H "Authorization: Bearer 2D45ESwuEbrJlKrowPnNiqabZCN" \
-d '{
                "jsonrpc": "2.0",
                "id": "request-1",
                "method": "data.getDeal",
                "params": {
                        "id": 46924
                }
        }'

This request returns the details of a (private equity) deal with id = 46924:

{
        "id": "request-1",
        "jsonrpc": "2.0",
        "result": {
                "announcementDate": {
                        "day": null,
                        "month": 8,
                        "year": 2022
                },
                "asset": "Baricol Bariatrics",
                "businessActivities": "Production of supplements",
                "buyers": [
                        {
                                "division": null,
                                "leadingParty": false,
                                "linkedAssetId": 14660,
                                "linkedInvestorId": null,
                                "linkedStrategyId": null,
                                "name": "FitForMe",
                                "order": 0,
                                "reason": null,
                                "region": "NL",
                                "share": {
                                        "confidence": "estimate",
                                        "date": null,
                                        "value": "majority"
                                },
                                "sharePct": null,
                                "type": "asset"
                        }
                ],
                "currency": "EUR",
                "dealStatus": null,
                "division": null,
                "ebit": null,
                "ebitda": null,
                "equity": null,
                "ev": null,
                "evEbitMultiple": null,
                "evEbitdaMultiple": null,
                "evRevenueMultiple": null,
                "evTotalAssetsMultiple": null,
                "fte": null,
                "fundingRoundAmountRaised": null,
                "fundingRoundPostMoneyValuation": null,
                "fundingRoundPreMoneyValuation": null,
                "fundingRoundType": null,
                "highlightedBuyerId": 64088,
                "highlightedSellerId": null,
                "id": 46924,
                "linkedAssetId": null,
                "notes": [],
                "publicationDate": "2022-08-31T09:17:25+02:00",
                "reasons": [],
                "region": "SE",
                "revenue": null,
                "sector": null,
                "sellers": [],
                "sources": [
                        {
                                "language": null,
                                "order": 0,
                                "publicationMonth": 8,
                                "publicationYear": 2022,
                                "publisher": "Bariatric News",
                                "title": "FitForMe joins forces with Baricol Bariatric",
                                "url": "https://www.bariatricnews.net/post/fitforme-joins-forces-with-baricol-bariatric"
                        }
                ],
                "status": "published",
                "subsector": "pharmaceuticals",
                "totalAssets": null
        }
}

As you can see, the response is a similar top-level JSON object, but instead of the params field there is a result property now. Let’s take a look at the request again and go over the headers and fields:

> curl -X POST --location "https://gain.pro/app/rpc/" \
-H "Authorization: Bearer 2D45ESwuEbrJlKrowPnNiqabZCN" \
-d '{
                "jsonrpc": "2.0",
                "id": "request-1",
                "method": "data.getDeal",
                "params": {
                        "id": 46924
                }
        }'

The URL of the API is https://gain.pro/app/rpc/. All requests are sent here.

The API authentication token is passed as HTTP Authorization header. To execute the call you need to obtain an API token. This is done by calling the account.login method, described in more detail in authentication. If you execute it with an invalid token you get a response with an error message.

When we look at the payload of the request (everything after the -d option), there are a couple of things to note.

First, the "jsonrpc": "2.0" field: this is a field that must always be passed (it identifies the JSON blob as JSONPRC).

Next, the "id" field must be set to some string by the caller of the API. It doesn’t really matter what the value is, as long as it’s a (non-empty) value. The server will return the same id so that the caller can match the response with the request. This is very useful when multiple calls are done in parallel. Using the id you can distinguish easily which response corresponds to which requests.

If no id is specified (or left empty), the server does not send back a response (but still executes the request). This behavior is specified by the JSONRPC protocol, but it’s frequent mistake to forget to set the request id.

The two final top-level fields are "method" and "params" that specify the actual method to call.

The "method" parameter must set to string with the format <service name>.<method name>. Each service has its own method set and is described in its own reference section in this documentation. A good point to start is the data service: this is where you can access all data that is found on the Gain.pro platform.

The "params" parameter has a structure that is defined by the method reference. If you pass an invalid value, you’ll get an error message.

For SDK or language bindings (Java, C#, Python, etc) to this API, see here.

Authentication

The request must be accompanied by an authorization token. This token is passed in the Authorization header. Any RPC HTTP request has the following general structure:

POST /app/rpc/ HTTP/1.1
Accept: application/json, */*;q=0.5
Accept-Encoding: gzip, deflate
Authorization: Bearer 2D45ESwuEbrJlKrowPnNiqabZCN
Connection: keep-alive
Content-Length: 58
Content-Type: application/json
Host: gain.pro
User-Agent: HTTPie/3.2.1

{
    "id": "1",
    "jsonrpc": "2.0",
    "method": "data.listAssets"
    "params": {
        // ...
    }
}

To obtain an API token, the login.account must be called with the credentials of your API user account.

Here’s an example using curl:

> curl -X POST "https://gain.pro/app/rpc/" -d\
    '{
        "jsonrpc": "2.0",
        "id": "1",
        "method": "account.login",
        "params": {
            "username": <USERNAME>,
            "password": <PASSWORD>
        }
    }'

{
    "id": "1",
    "jsonrpc": "2.0",
    "result": "OJkASSlKW2E7q6x1lFqSyqKJOg1"
}

Of course, when logging in, no token needs to be sent (as the purpose is to obtain a token). So the Authorization header is missing here.

A token is typically valid for 30 days (this depends on the subscription settings).

All tokens are also invalidated when a user logs out.

If a request is done using an invalid token an error with error code -32001 (“Invalid authentication”) is returned. In this case the user’s credentials can be used to (automatically) obtain a new token.

Using the browser

An interesting fact about our API is that the Gain.pro frontend uses the exact same API.

The big benefit is that you can use browser developer tools to inspect how the API is used. APIs are often best understood by example, so this is a great way to explore the API or understand how it works.

Because the actual service and method name that is called is not present in the API endpoint URL (https://gain.pro/app/rpc) we developed the habit of adding the method name as a query parameter (i.e. after the ‘?’). Query parameters are ignored by the RPC server but you’ll see it in the request overview and so can easily pick the requests you’re interested in.

After you’ve selected a specific call, the “Headers” tab will show all headers sent by the browser. This will include the authorization token that is set by the Gain.pro frontend code (no other headers are set).

Next, the “Payload” tab shows the request body. You may want to inspect this to see how the parameters or option you set with the mouse (filters, etc) are actually send to the server. You may use these request body as a basis to construct your own request from.

Finally, the “Response” tab show the data that is returned from the server. This can be instructive as well to inspect as it shows what is exactly returned for the request.

Pagination

List methods, such as data.listAssets share common pagination parameters:

curl -X POST --location "https://gain.pro/app/rpc/" \
-H "Authorization: Bearer 2D45ESwuEbrJlKrowPnNiqabZCN" \
-d '{
                "jsonrpc": "2.0",
                "id": "request-1",
                "method": "data.listAssets",
                "params": {
                        "limit": 1,
                        "page": 0
                }
        }'

The pagination parameters here are "limit" and "page".

It’s important to note that both have 0 as their default value, so if you don’t specify them you’ll get an empty "items" array.

The "counts" object can be used to loop through all (or as many) items using "limit" to specify the number of items you want per call.

{        
        "id": "request-1",
        "jsonrpc": "2.0",
        "result": {
                "args": {
                        "filter": [],
                        "limit": 1,
                        "page": 0,
                        "search": "",
                        "sort": []
                },
                "counts": {
                        "filtered": 13418,
                        "total": 13418
                },
                "items": [
                      // ... 
                ]
        }
}

The "filter" and "search" parameters are described in filtering. Sorting is described in sorting.

Sorting

The "sort" parameter of all list methods accepts an array of properties to sort the list on.

The properties are defined by the list item type that is returned by the list method. For example, the data.listAssets method returns an array of AssetListItems. The returned list can be sorted on all (sortable) properties of this item.

Sorting is done by default in ascending order. To sort in descending or, prefix the property name with a minus sign ("-"). For example, to sort the data.listAssets method results on descending EBITDA, then on ascending name, you would use:


curl -X POST --location "https://gain.pro/app/rpc/" \
-H "Authorization: Bearer 2D45ESwuEbrJlKrowPnNiqabZCN" \
-d '{
                "jsonrpc": "2.0",
                "id": "request-1",
                "method": "data.listAssets",
                "params": {
                		"sort": ["-ebitda", "name"],
                        "limit": 3,
                        "page": 0
                }
        }'

Take a look at the AssetListItem properties to view all sortable properties.

Filtering

Most list methods have a filter parameter that allows to filter the result using boolean conditions. Here’s a simple example of a filter used with the listAssets method:

{
  "id": "1",
  "jsonrpc": "2.0",
  "method": "data.listAssets",
  "params": {
  "filter": [
    {
      "field": "revenue",
      "operator": ">",
      "value": 100
    }
    ],
    "limit": 5
  },
  "sort": "revenue"
}

This query will return the 5 smallest companies with revenue above 100 million EUR in ascending order.

Any list item field in the list method can be filtered (unless otherwise specified).

For the listAssets the list item is AssetListItem. Take a look at its definition to get a feel of all fields that are filterable.

To find the list item type for any list method, look at the reference for the method and follow the return type. For example, the listAssets returns an AssetList which in turn contains a field items. This field is an array of asset list items, the list item for this method. (Note that some other fields are return as well: result counts (totals and filtered) and the parameters that were given. The counts can be used to iterate over all results if pagination is used.)

The operators that can be used in a filters are: "<", "<=", "=", "!=", ">", ">=", "or", "and" and "not".

When applied to a string field, the "=" and "!=" operator perform a substring search.

When boolean operators ("and", "or" and "not") are used, the value should be an array of filters. In case of "not" this array should contain a single filter item. For boolean operators, the field parameter must be left empty.

Note that the filter parameter is an array. If multiple filter items are given, these are combined using the boolean "and" operator. For example, using the parameters below we search for companies with both revenue > 100 and region = GB (Great Brittain). The filters are combined using an implicit “and”:

{
  "id": "1",
  "jsonrpc": "2.0",
  "method": "data.listAssets",
  "params": {
  "filter": [
    {
      "field": "revenue",
      "operator": ">",
      "value": 100
    },
    {
      "field": "region",
      "operator": "=",
      "value": "GB"
    }
    ],
    "limit": 5
  },
  "sort": "revenue"
}

If you want to do an "or" filtering instead, a top-level “or” filter needs to be created with two child filter items, for example:

{
  "id": "1",
  "jsonrpc": "2.0",
  "method": "data.listAssets",
  "params": {
  "filter": [
    {
        "operator": "or",
        "value": [ 
          { 
            "field": "revenue",
            "operator": ">",
            "value": 100
          },
          {
            "field": "region",
            "operator": "=",
            "ebitda": 10
          }
        ]
    },
  ],
  "limit": 5
  },
  "sort": "revenue"
}

This will search for all companies with revenue > 100 or ebitda > 10.

To make filtering on specific ids a bit easier, some special rules apply. Integer fields that represent an id can be compared directly against an array of ids. In this case the filter means “any of” (for "=") and “not any of” (for "!="). For example, to return the asset list items of the assets with ids 4822, 10021 and 3193 the following filter can be used:

{
  "id": "1",
  "jsonrpc": "2.0",
  "method": "data.listAssets",
  "params": {
  "filter": [
    {
      "field": "assetId",
      "operator": "=",
      "value": [822, 10021, 3193]
    }
    ],
    "limit": 5
  },
  "sort": "revenue"
}

This is a lot shorter and convenient then using "or" filters (although that’s also possible, of course).

This also works the other way around: an array of ids (for example the ownerIds of the asset list item) can be compared directly against a single integer value. When a field with an array of ids is compared against array of ids, the filter will match all items where the field array contains any of the values of the filter array (i.e. their intersection is not empty). For example, to list all assets that have owners with id = 28 (Equistone) or id = 633 (Softbank), the following filter can be used:

{
  "id": "1",
  "jsonrpc": "2.0",
  "method": "data.listAssets",
  "params": {
  "filter": [
    {
      "field": "ownerIds",
      "operator": "=",
      "value": [28, 633]
    }
    ],
    "limit": 5
  },
  "sort": "revenue"
}

Again, this is a quite natural and convenient way to specify such a filter, but more the verbose using boolean operators also works.

Error handling

If a request cannot be executed due to a request error or due to an issue on the server side, an error message is returned. For example:

 {
                "error": {
                        "code": -32602,
                        "message": "id must be of type number or string"
                },
                "id": "request-1",
                "jsonrpc": "2.0"
},

Some error codes are defined by the JSONRPC specification, which also specifies when then are sent back. Other error codes are application specific. Both error types are specified in the errors section.

Rate limiting

The Gain.pro API uses rate limiting to control API traffic. Requests are limited to 120 requests per minute, per authenticated API user.

If you exceed the rate limit, your request will fail with a 429 response status code:

> HTTP/2 429
> date: Fri, 02 Jun 2023 09:04:44 GMT

When you are rate limited, you should not make any requests for the upcoming minute.

HTTP status codes

While using the Gain.pro API, you may encounter the following HTTP status codes:

Status code Description
200 Ok, the request was successful and the response body contains the requested data
210 No content, the request was successful but there is no response data
400 Bad request, there is an error in your request
404 Not found, the requested resource is not available
429 Too many requests, your request was rate limited
503 Service unavailable, the server is down for maintenance

Note: Always inspect your response body, as with JSONRPC a status code 200 can still contain an error in the response body as documented in Error handling.

SDKs

We currently do not offer SDKs or type definitions.

Services

Data service

The data service provides methods to access and search the Gain.pro data graph.

Method reference

Method
data.getAdvisor() ⎯
Parameters
Name Type Description
id number(int)
preview bool
Returns
Advisor
Description

Method reference

Method
data.getArticle() ⎯
Parameters
Name Type Description
id number(int)
preview bool
Returns
Article
Description

Method reference

Method
data.getAsset() ⎯ Get all information about a company.
Parameters
Name Type Description
assetId number(int)
preview bool
Returns
Asset
Description
Companies are referred to as 'Assets' in the API.

Method reference

Method
data.getDeal() ⎯ Get all information about a deal.
Parameters
Name Type Description
id number(int)
Returns
Deal
Description

Method reference

Method
data.getIndustry() ⎯
Parameters
Name Type Description
id number(int)
preview bool
Returns
Industry
Description

Method reference

Method
data.getInvestor() ⎯
Parameters
Name Type Description
id number(int)
preview bool
Returns
Investor
Description

Method reference

Method
data.getInvestorStrategy() ⎯
Parameters
Name Type Description
id number(int)
Returns
InvestorStrategy
Description

Method reference

Method
data.getLegalEntity() ⎯
Parameters
Name Type Description
id number(int)
Returns
LegalEntity
Description

Method reference

Method
data.getPerson() ⎯
Parameters
Name Type Description
id number(int)
Returns
Person
Description

Method reference

Method
data.getSimilarAssets() ⎯
Parameters
Name Type Description
likeAssetId number(int) ID of the asset to which the returned assets must be similar
limit number(int)
Returns
AssetList
Description

Method reference

Method
data.listAdvisorDeals() ⎯
Parameters
Name Type Description
filter array(Filter) A filter field must match with a property from the returned list item type. The value must match the type of the corresponding property and can be wrapped in an array to create an or clause of multiple values for the given filter. When combing multiple filters the results will match all of the given filters
limit number(int)
page number(int)
prompt string Only relevant for internal use.
promptObjectIds array(number(int)) Only relevant for internal use.
search string
sort array(string) The sort field must match with a property from the returned list item type. The results will be ordered in ascending order by default, prefix the field with a dash to order in descending order. Multiple sort fields will sort the results by the given combination.
Returns
AdvisorDealsList
Description

Method reference

Method
data.listAdvisors() ⎯
Parameters
Name Type Description
filter array(Filter) A filter field must match with a property from the returned list item type. The value must match the type of the corresponding property and can be wrapped in an array to create an or clause of multiple values for the given filter. When combing multiple filters the results will match all of the given filters
limit number(int)
page number(int)
prompt string Only relevant for internal use.
promptObjectIds array(number(int)) Only relevant for internal use.
search string
sort array(string) The sort field must match with a property from the returned list item type. The results will be ordered in ascending order by default, prefix the field with a dash to order in descending order. Multiple sort fields will sort the results by the given combination.
Returns
AdvisorList
Description

Method reference

Method
data.listArticles() ⎯
Parameters
Name Type Description
filter array(Filter) A filter field must match with a property from the returned list item type. The value must match the type of the corresponding property and can be wrapped in an array to create an or clause of multiple values for the given filter. When combing multiple filters the results will match all of the given filters
limit number(int)
page number(int)
prompt string Only relevant for internal use.
promptObjectIds array(number(int)) Only relevant for internal use.
search string
sort array(string) The sort field must match with a property from the returned list item type. The results will be ordered in ascending order by default, prefix the field with a dash to order in descending order. Multiple sort fields will sort the results by the given combination.
Returns
ArticleList
Description

Method reference

Method
data.listAssets() ⎯ List and filter companies.
Parameters
Name Type Description
filter array(Filter) A filter field must match with a property from the returned list item type. The value must match the type of the corresponding property and can be wrapped in an array to create an or clause of multiple values for the given filter. When combing multiple filters the results will match all of the given filters
limit number(int)
page number(int)
prompt string Only relevant for internal use.
promptObjectIds array(number(int)) Only relevant for internal use.
search string
sort array(string) The sort field must match with a property from the returned list item type. The results will be ordered in ascending order by default, prefix the field with a dash to order in descending order. Multiple sort fields will sort the results by the given combination.
Returns
AssetList
Description
Search companies based on all available information. The data.AssetListItem type is a denormalized version of data.Asset, with one-to-many relationships reduced to arrays and financials available in both original currencies and standardized Euro values for easier filtering.

Method reference

Method
data.listCurrencies() ⎯
Parameters
Name Type Description
filter array(Filter) A filter field must match with a property from the returned list item type. The value must match the type of the corresponding property and can be wrapped in an array to create an or clause of multiple values for the given filter. When combing multiple filters the results will match all of the given filters
limit number(int)
page number(int)
prompt string Only relevant for internal use.
promptObjectIds array(number(int)) Only relevant for internal use.
search string
sort array(string) The sort field must match with a property from the returned list item type. The results will be ordered in ascending order by default, prefix the field with a dash to order in descending order. Multiple sort fields will sort the results by the given combination.
Returns
CurrencyList
Description

Method reference

Method
data.listDeals() ⎯ List and filter deals.
Parameters
Name Type Description
filter array(Filter) A filter field must match with a property from the returned list item type. The value must match the type of the corresponding property and can be wrapped in an array to create an or clause of multiple values for the given filter. When combing multiple filters the results will match all of the given filters
limit number(int)
page number(int)
prompt string Only relevant for internal use.
promptObjectIds array(number(int)) Only relevant for internal use.
search string
sort array(string) The sort field must match with a property from the returned list item type. The results will be ordered in ascending order by default, prefix the field with a dash to order in descending order. Multiple sort fields will sort the results by the given combination.
Returns
DealList
Description
Search deals based on all available deal information. The data.DealListItem type is a denormalized version of data.Deal, with one-to-many relationships reduced to arrays and financials available in both original currencies and standardized Euro values for easier filtering. Note that all 'Buyer' and 'Seller' fields are analogously defined.

Method reference

Method
data.listIndustries() ⎯
Parameters
Name Type Description
filter array(Filter) A filter field must match with a property from the returned list item type. The value must match the type of the corresponding property and can be wrapped in an array to create an or clause of multiple values for the given filter. When combing multiple filters the results will match all of the given filters
limit number(int)
page number(int)
prompt string Only relevant for internal use.
promptObjectIds array(number(int)) Only relevant for internal use.
search string
sort array(string) The sort field must match with a property from the returned list item type. The results will be ordered in ascending order by default, prefix the field with a dash to order in descending order. Multiple sort fields will sort the results by the given combination.
Returns
IndustryList
Description

Method reference

Method
data.listIndustryMarketSegments() ⎯
Parameters
Name Type Description
filter array(Filter) A filter field must match with a property from the returned list item type. The value must match the type of the corresponding property and can be wrapped in an array to create an or clause of multiple values for the given filter. When combing multiple filters the results will match all of the given filters
limit number(int)
page number(int)
prompt string Only relevant for internal use.
promptObjectIds array(number(int)) Only relevant for internal use.
search string
sort array(string) The sort field must match with a property from the returned list item type. The results will be ordered in ascending order by default, prefix the field with a dash to order in descending order. Multiple sort fields will sort the results by the given combination.
Returns
IndustryMarketSegmentList
Description

Method reference

Method
data.listInvestorFunds() ⎯
Parameters
Name Type Description
filter array(Filter) A filter field must match with a property from the returned list item type. The value must match the type of the corresponding property and can be wrapped in an array to create an or clause of multiple values for the given filter. When combing multiple filters the results will match all of the given filters
limit number(int)
page number(int)
prompt string Only relevant for internal use.
promptObjectIds array(number(int)) Only relevant for internal use.
search string
sort array(string) The sort field must match with a property from the returned list item type. The results will be ordered in ascending order by default, prefix the field with a dash to order in descending order. Multiple sort fields will sort the results by the given combination.
Returns
InvestorFundList
Description

Method reference

Method
data.listInvestorStrategies() ⎯ List and filter investor strategies.
Parameters
Name Type Description
filter array(Filter) A filter field must match with a property from the returned list item type. The value must match the type of the corresponding property and can be wrapped in an array to create an or clause of multiple values for the given filter. When combing multiple filters the results will match all of the given filters
limit number(int)
page number(int)
prompt string Only relevant for internal use.
promptObjectIds array(number(int)) Only relevant for internal use.
search string
sort array(string) The sort field must match with a property from the returned list item type. The results will be ordered in ascending order by default, prefix the field with a dash to order in descending order. Multiple sort fields will sort the results by the given combination.
Returns
InvestorStrategyList
Description
The underlying assets that build up the values in the strategy list item fields (such as counts and assets EBITDA values, regions and sectors) can be filtered as well. To do this use the field names as you would in the listAssets method, but prefixed with 'assets.' (any non-prefixed filters will filter on the strategy list item fields directly, as normal). For example, to filter the assets on EBITDA > 10 and then show only the strategies that have at least one asset for this filter, use 'assetsFiltered > 1' and 'asset.ebitda > 10'.

Method reference

Method
data.listInvestors() ⎯
Parameters
Name Type Description
filter array(Filter) A filter field must match with a property from the returned list item type. The value must match the type of the corresponding property and can be wrapped in an array to create an or clause of multiple values for the given filter. When combing multiple filters the results will match all of the given filters
limit number(int)
page number(int)
prompt string Only relevant for internal use.
promptObjectIds array(number(int)) Only relevant for internal use.
search string
sort array(string) The sort field must match with a property from the returned list item type. The results will be ordered in ascending order by default, prefix the field with a dash to order in descending order. Multiple sort fields will sort the results by the given combination.
Returns
InvestorList
Description

Method reference

Method
data.listLegalEntities() ⎯
Parameters
Name Type Description
filter array(Filter) A filter field must match with a property from the returned list item type. The value must match the type of the corresponding property and can be wrapped in an array to create an or clause of multiple values for the given filter. When combing multiple filters the results will match all of the given filters
limit number(int)
page number(int)
prompt string Only relevant for internal use.
promptObjectIds array(number(int)) Only relevant for internal use.
search string
sort array(string) The sort field must match with a property from the returned list item type. The results will be ordered in ascending order by default, prefix the field with a dash to order in descending order. Multiple sort fields will sort the results by the given combination.
Returns
LegalEntityList
Description

Method reference

Method
data.listPersons() ⎯
Parameters
Name Type Description
filter array(Filter) A filter field must match with a property from the returned list item type. The value must match the type of the corresponding property and can be wrapped in an array to create an or clause of multiple values for the given filter. When combing multiple filters the results will match all of the given filters
limit number(int)
page number(int)
prompt string Only relevant for internal use.
promptObjectIds array(number(int)) Only relevant for internal use.
search string
sort array(string) The sort field must match with a property from the returned list item type. The results will be ordered in ascending order by default, prefix the field with a dash to order in descending order. Multiple sort fields will sort the results by the given combination.
Returns
PersonList
Description

Method reference

Method
data.listRegions() ⎯
Parameters
Name Type Description
filter array(Filter) A filter field must match with a property from the returned list item type. The value must match the type of the corresponding property and can be wrapped in an array to create an or clause of multiple values for the given filter. When combing multiple filters the results will match all of the given filters
limit number(int)
page number(int)
prompt string Only relevant for internal use.
promptObjectIds array(number(int)) Only relevant for internal use.
search string
sort array(string) The sort field must match with a property from the returned list item type. The results will be ordered in ascending order by default, prefix the field with a dash to order in descending order. Multiple sort fields will sort the results by the given combination.
Returns
RegionList
Description

Method reference

Method
data.listSectors() ⎯
Parameters
Name Type Description
filter array(Filter) A filter field must match with a property from the returned list item type. The value must match the type of the corresponding property and can be wrapped in an array to create an or clause of multiple values for the given filter. When combing multiple filters the results will match all of the given filters
limit number(int)
page number(int)
prompt string Only relevant for internal use.
promptObjectIds array(number(int)) Only relevant for internal use.
search string
sort array(string) The sort field must match with a property from the returned list item type. The results will be ordered in ascending order by default, prefix the field with a dash to order in descending order. Multiple sort fields will sort the results by the given combination.
Returns
SectorList
Description

Method reference

Method
data.listSubsectors() ⎯
Parameters
Name Type Description
filter array(Filter) A filter field must match with a property from the returned list item type. The value must match the type of the corresponding property and can be wrapped in an array to create an or clause of multiple values for the given filter. When combing multiple filters the results will match all of the given filters
limit number(int)
page number(int)
prompt string Only relevant for internal use.
promptObjectIds array(number(int)) Only relevant for internal use.
search string
sort array(string) The sort field must match with a property from the returned list item type. The results will be ordered in ascending order by default, prefix the field with a dash to order in descending order. Multiple sort fields will sort the results by the given combination.
Returns
SubsectorList
Description

Method reference

Method
data.search() ⎯
Parameters
Name Type Description
advisors bool
assets bool
conferenceEditions bool
entities bool
industries bool
investors bool
lenders bool
limit number(int)
query string
Returns
array(SearchResultItem)
Description

Enums

Enum reference

Enum
TeamMemberStatus ⎯ Some enum summary, with description below.
Values
Name Type Value Description
TeamMemberStatusValid string "valid"
TeamMemberStatusInvalid string "invalid"
TeamMemberStatusToValidate string "toValidate"
Description

Enum reference

Enum
TeamMemberPosition ⎯ Some enum summary, with description below.
Values
Name Type Value Description
TeamMemberPositionPartner string "partner"
TeamMemberPositionDirector string "director"
TeamMemberPositionManager string "manager"
TeamMemberPositionAssociate string "associate"
Description

Enum reference

Enum
DealCloudStatus ⎯ Some enum summary, with description below.
Values
Name Type Value Description
DealCloudStatusCreated string "created"
DealCloudStatusUpdated string "updated"
DealCloudStatusFailed string "failed"
Description

Enum reference

Enum
SalesforceStatus ⎯ Some enum summary, with description below.
Values
Name Type Value Description
SalesforceStatusCreated string "created"
SalesforceStatusUpdated string "updated"
SalesforceStatusDeleted string "deleted"
SalesforceStatusFailed string "failed"
Description

Enum reference

Enum
AssetSourceType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
AssetSourceIndustry string "industry"
AssetSourceInvestor string "investor"
AssetSourceInvestorStrategy string "investorStrategy"
AssetSourceIndustrySegment string "industrySegment"
AssetSourceBookmarkList string "bookmarkList"
AssetSourceConferenceEdition string "conferenceEdition"
AssetSourceSimilarAssets string "similarAssets"
Description

Enum reference

Enum
AdvisoryActivity ⎯ Some enum summary, with description below.
Values
Name Type Value Description
AdvisoryActivityTax string "tax"
AdvisoryActivityDebt string "debt"
AdvisoryActivityOperational string "operational"
AdvisoryActivityHR string "hr"
AdvisoryActivityExecutiveSearch string "executiveSearch"
AdvisoryActivityECM string "ecm"
AdvisoryActivityForensics string "forensics"
AdvisoryActivityMA string "ma"
AdvisoryActivityFinancial string "financial"
AdvisoryActivityItTechnology string "itTechnology"
AdvisoryActivityFairnessOpinion string "fairnessOpinion"
AdvisoryActivityCommercial string "commercial"
AdvisoryActivityLegal string "legal"
AdvisoryActivityPR string "pr"
AdvisoryActivityEnvironmentalSocial string "environmentalSocial"
AdvisoryActivityInsurance string "insurance"
AdvisoryActivityOther string "other"
Description

Enum reference

Enum
DealItemStatus ⎯ Some enum summary, with description below.
Values
Name Type Value Description
DealItemStatusNew string "new"
DealItemStatusReview string "review"
DealItemStatusPublished string "published"
Description

Enum reference

Enum
DealReason ⎯ Some enum summary, with description below.
Values
Name Type Value Description
DealSellReasonDivestiture string "divestiture"
DealSellReasonStrategicExit string "strategicExit"
DealSellReasonIPO string "IPO"
DealBuyReasonPlatform string "platform"
DealBuyReasonPublicToPrivate string "publicToPrivate"
DealBuyReasonVCRound string "vcRound"
Description

Enum reference

Enum
DealStatus ⎯ Some enum summary, with description below.
Values
Name Type Value Description
DealStatusLive string "live"
DealStatusPaused string "paused"
DealStatusAborted string "aborted"
DealStatusCompleted string "completed"
Description

Enum reference

Enum
DealFactConfidence ⎯ Some enum summary, with description below.
Values
Name Type Value Description
DealFactConfidenceReported string "reported"
DealFactConfidenceEstimate string "estimate"
DealFactConfidenceMarketed string "marketed"
DealFactConfidenceDerived string "derived"
Description

Enum reference

Enum
DealFundingRoundType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
DealFundingRoundPreSeed string "preSeed"
DealFundingRoundSeriesA string "seriesA"
DealFundingRoundSeriesB string "seriesB"
DealFundingRoundSeriesC string "seriesC"
DealFundingRoundSeriesD string "seriesD"
DealFundingRoundSeriesE string "seriesE"
DealFundingRoundSeriesF string "seriesF"
DealFundingRoundSeriesG string "seriesG"
DealFundingRoundSeriesH string "seriesH"
DealFundingRoundSeriesI string "seriesI"
DealFundingRoundSeriesJ string "seriesJ"
DealFundingRoundVenture string "venture"
DealFundingRoundUnknown string "otherUnknown"
Description

Enum reference

Enum
DealSideType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
DealSideTypeAsset string "asset"
DealSideTypeOwner string "investor"
DealSideTypeOther string "other"
Description

Enum reference

Enum
InvestorFundConfidence ⎯ Some enum summary, with description below.
Values
Name Type Value Description
InvestorFundConfidenceReported string "reported"
InvestorFundConfidenceEstimate string "estimate"
Description

Enum reference

Enum
DealSideShare ⎯ Some enum summary, with description below.
Values
Name Type Value Description
DealSideShareMajority string "majority"
DealSideShareMinority string "minority"
DealSideShareSharedMajority string "sharedMajority"
Description

Enum reference

Enum
DealFactSideShareConfidence ⎯ Some enum summary, with description below.
Values
Name Type Value Description
DealFactSideShareConfidenceReported string "reported"
DealFactSideShareConfidenceEstimate string "estimate"
Description

Enum reference

Enum
NoteType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
NoteTypeMotivation string "motivation"
NoteTypeFinancing string "financing"
Description

Enum reference

Enum
DealStageType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
DealStagePreparation string "preparation"
DealStageLaunch string "launch"
DealStageNonBindingOffers string "nonBindingOffers"
DealStageBindingOffers string "bindingOffers"
DealStageCompleted string "completed"
Description

Enum reference

Enum
DealType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
DealTypeDealroom string "dealroom"
Description

Enum reference

Enum
DealAdvisorAdvised ⎯ Some enum summary, with description below.
Values
Name Type Value Description
DealAdvisorAdvisedUnknown string "unknown"
DealAdvisorAdvisedSellers string "sellers"
DealAdvisorAdvisedBuyers string "buyers"
Description

Enum reference

Enum
ArticleType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
ArticleTypeNewAssets string "newAssets"
ArticleTypeNewFinancials string "newFinancials"
ArticleTypeInTheNews string "inTheNews"
ArticleTypePeerReview string "peerReview"
ArticleTypeIndustryResearch string "industryResearch"
Description

Enum reference

Enum
ArticleCategory ⎯ Some enum summary, with description below.
Values
Name Type Value Description
ArticleCategoryPlatformDeal string "platformDeal"
ArticleCategoryAddon string "addOn"
ArticleCategoryStrategicExit string "strategicExit"
ArticleCategoryVcRound string "vcRound"
ArticleCategoryOther string "other"
Description

Enum reference

Enum
AssetProfileType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
AssetProfileTypeMinimal string "minimal" Legacy type: No new Minimal profiles are created, and remaining profiles are gradually converted to Full or Minimal as part of regular update cycles.
AssetProfileTypeLimited string "limited" Same as AssetProfileTypeFull, except without curated AssetCompetitors.
AssetProfileTypeFull string "full" Asset profiles whose content is fully curated, except where explicitly marked otherwise.
AssetProfileTypeAutomated string "automated" Asset profiles whose content is fully generated by GenAI models.
Description

Enum reference

Enum
AssetOwnershipType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
AssetOwnershipTypePrivate string "private" This company is majority-owned by an individual or a group of individuals (e.g. family, management team).
AssetOwnershipTypeListed string "listed" This company is listed on a stock exchange and (some of) its shares are traded publicly.
AssetOwnershipTypeRegular string "regular" This company is majority-owned by one or several institutional investors.
AssetOwnershipTypeOther string "other" Other ownership types (e.g. foundations, employee trusts, creditors, joint ventures).
AssetOwnershipTypeMinority string "minority" This company is minority-owned by one or several institutional investors.
AssetOwnershipTypeSubsidiary string "subsidiary" This company is a part/subsidiary of another company.
AssetOwnershipTypeBankrupt string "bankrupt" This company is insolvent and stopped operating.
AssetOwnershipTypeVentureCapital string "ventureCapital" This company is backed by venture capital from one or multiple investors.
AssetOwnershipTypeGovernment string "government" This company is majority-owned by a government, municipality or other public entity.
Description

Enum reference

Enum
AssetCustomerBaseType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
AssetCustomerBaseTypeBusinessToBusiness string "businessToBusiness"
AssetCustomerBaseTypeBusinessToConsumer string "businessToConsumer"
AssetCustomerBaseTypeBusinessToGovernment string "businessToGovernment"
Description

Enum reference

Enum
AssetBusinessActivityType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
AssetBusinessActivityTypeManufacturing string "manufacturing"
AssetBusinessActivityTypeDistribution string "distribution"
AssetBusinessActivityTypeResearchAndDevelopment string "researchAndDevelopment"
AssetBusinessActivityTypeServices string "services"
AssetBusinessActivityTypeEngineering string "engineering"
AssetBusinessActivityTypeDesign string "design"
AssetBusinessActivityTypeOperator string "operator"
AssetBusinessActivityTypeRetail string "retail"
AssetBusinessActivityTypeOther string "other"
Description

Enum reference

Enum
AssetSalesChannelType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
AssetSalesChannelTypeOnline string "online"
AssetSalesChannelTypeBrickAndMortar string "brickAndMortar"
AssetSalesChannelTypeIndirectSales string "indirectSales"
AssetSalesChannelTypeDirectSales string "directSales"
Description

Enum reference

Enum
AssetPricePositioningType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
AssetPricePositioningTypeDiscount string "discount"
AssetPricePositioningTypePremium string "premium"
Description

Enum reference

Enum
FinancialResultAmountType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
FinancialResultAmountTypeActual string "actual"
FinancialResultAmountTypeEstimated string "estimated"
FinancialResultAmountTypeAI string "ai"
Description

Enum reference

Enum
FinancialResultPeriodicityType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
FinancialResultPeriodicityTypeAnnual string "annual"
FinancialResultPeriodicityTypeNextTwelveMonths string "nextTwelveMonths"
FinancialResultPeriodicityTypeLastTwelveMonths string "lastTwelveMonths"
Description

Enum reference

Enum
AssetShareholderShare ⎯ Some enum summary, with description below.
Values
Name Type Value Description
ShareholderTypeMajority string "majority"
ShareholderTypeMinority string "minority"
Description

Enum reference

Enum
PersonExperiencePositionType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
PersonExperiencePositionTypeChiefExecutiveOfficer string "chiefExecutiveOfficer"
PersonExperiencePositionTypeCoChiefExecutiveOfficer string "coChiefExecutiveOfficer"
PersonExperiencePositionTypeManagingDirector string "managingDirector"
PersonExperiencePositionTypeDirector string "director"
PersonExperiencePositionTypeChairman string "chairman"
PersonExperiencePositionTypeBoardMember string "boardMember"
PersonExperiencePositionTypeRepresentative string "representative"
Description

Enum reference

Enum
PersonExperienceStatusType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
PersonExperienceStatusTypeValid string "valid"
PersonExperienceStatusTypeInvalid string "invalid"
PersonExperienceStatusTypeToValidate string "toValidate"
Description

Enum reference

Enum
FileDataType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
FileDataTypeAnnualReport string "annualReport"
FileDataTypeAssetBenchmarkingExcel string "assetBenchmarkingExcel"
FileDataTypeAssetCapitalizationExcel string "assetCapitalizationExcel"
FileDataTypeAssetFinancialsExcel string "assetFinancialsExcel"
FileDataTypeAssetFactsheet string "assetFactsheet"
FileDataTypeCreditsafeReport string "creditsafeReport"
FileDataTypeDealsExcel string "dealsExcel"
FileDataTypeDownload string "download"
FileDataTypeDownloadZip string "downloadZip"
FileDataTypeEarningsCallTranscript string "earningsCallTranscript"
FileDataTypeLegalEntityExcel string "legalEntityExcel"
FileDataTypeListOfShareholders string "listOfShareholders"
FileDataTypeLogo string "logo"
Description

Enum reference

Enum
AssetDealCapitalizationTernary ⎯ Some enum summary, with description below.
Values
Name Type Value Description
AssetDealCapitalizationTernaryTrue string "true"
AssetDealCapitalizationTernaryFalse string "false"
AssetDealCapitalizationTernaryUnknown string "unknown"
Description

Enum reference

Enum
LiquidationSeniority ⎯ Some enum summary, with description below.
Values
Name Type Value Description
LiquidationSeniorityStandard string "standard"
LiquidationSeniorityPariPassu string "pariPassu"
LiquidationSeniorityTiered string "tiered"
Description

Enum reference

Enum
AssetCompetitorRefinementStatus ⎯ Some enum summary, with description below.
Values
Name Type Value Description
AssetCompetitorRefinementStatusCompleted string "completed"
AssetCompetitorRefinementStatusProcessing string "processing"
AssetCompetitorRefinementStatusNotRequested string "notRequested"
Description

Enum reference

Enum
DealsPerYearType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
DealsPerYearTypeBookmarkList string "bookmarkList"
DealsPerYearTypeConferenceEdition string "conferenceEdition"
DealsPerYearTypeSimilarAssets string "similarAssets"
Description

Enum reference

Enum
ObjectType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
ObjectTypeAsset string "asset"
ObjectTypeIndustry string "industry"
ObjectTypeInvestor string "investor"
ObjectTypeEntity string "entity"
ObjectTypeAdvisor string "advisor"
ObjectTypeDeal string "deal"
ObjectTypePerson string "person"
ObjectTypeLender string "lender"
ObjectTypeCredit string "credit"
ObjectTypeLegalEntity string "legal_entity"
Description

Enum reference

Enum
IndustryStatus ⎯ Some enum summary, with description below.
Values
Name Type Value Description
IndustryStatusArchived string "archived"
IndustryStatusNew string "new"
IndustryStatusReview string "review"
IndustryStatusPublished string "published"
Description

Enum reference

Enum
IndustryChartType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
IndustryChartTypeRevenueSegmentation string "revenueSegmentation"
IndustryChartTypeEbitdaSegmentation string "ebitdaSegmentation"
IndustryChartTypeAssetBenchmarking string "AssetBenchmarking"
IndustryChartTypeStrategicMajority string "strategicMajority"
IndustryChartTypeLikelihoodOfSponsorExit string "likelihoodOfSponsorExit"
IndustryChartTypeLikelihoodOfLeadershipChange string "likelihoodOfLeadershipChange"
Description

Enum reference

Enum
InvestorStatus ⎯ Some enum summary, with description below.
Values
Name Type Value Description
InvestorStatusArchived string "archived"
InvestorStatusNew string "new"
InvestorStatusReview string "review"
InvestorStatusPublished string "published"
Description

Enum reference

Enum
InvestorStrategyClassification ⎯ Some enum summary, with description below.
Values
Name Type Value Description
InvestorStrategyClassificationBuyout string "buyout"
InvestorStrategyClassificationGrowth string "growth"
InvestorStrategyClassificationVentureCapital string "ventureCapital"
InvestorStrategyClassificationEarlyStage string "earlyStage"
InvestorStrategyClassificationExpansion string "expansion"
InvestorStrategyClassificationSpecialSituation string "specialSituation"
InvestorStrategyClassificationInfrastructure string "infrastructure"
InvestorStrategyClassificationCredit string "credit"
InvestorStrategyClassificationDirectLending string "directLending"
InvestorStrategyClassificationMezzanine string "mezzanine"
InvestorStrategyClassificationSpecialSituationsDebt string "specialSituationsDebt"
InvestorStrategyClassificationDistressedDebt string "distressedDebt"
InvestorStrategyClassificationVentureDebt string "ventureDebt"
InvestorStrategyClassificationCoInvestment string "coInvestment"
InvestorStrategyClassificationOthers string "others"
InvestorStrategyClassificationTurnaround string "turnaround"
InvestorStrategyClassificationDirectSecondaries string "directSecondaries"
InvestorStrategyClassificationRealEstate string "realEstate"
Description

Enum reference

Enum
InvestorStrategyPreferredStake ⎯ Some enum summary, with description below.
Values
Name Type Value Description
InvestorStrategyPreferredStakeMinority string "minority"
InvestorStrategyPreferredStakeMajority string "majority"
InvestorStrategyPreferredStakeFlexible string "flexible"
InvestorStrategyPreferredStakeUnknown string "unknown"
Description

Enum reference

Enum
InvestorFundFundraisingStatus ⎯ Some enum summary, with description below.
Values
Name Type Value Description
InvestorFundFundraisingStatusLaunched string "launched"
InvestorFundFundraisingStatusFirstClose string "firstClose"
InvestorFundFundraisingStatusFinalClose string "finalClose"
InvestorFundFundraisingStatusClosed string "closed"
Description

Enum reference

Enum
LegalEntityShareholderType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
LegalEntityShareholderTypePerson string "person"
LegalEntityShareholderTypeLegalEntity string "legalEntity"
LegalEntityShareholderTypeOther string "other"
Description

Enum reference

Enum
LegalEntityUrlMethod ⎯ Some enum summary, with description below.
Values
Name Type Value Description
LegalEntityUrlMethodAutomated string "automated"
LegalEntityUrlMethodManual string "manual"
Description

Enum reference

Enum
LegalEntityUrlSource ⎯ Some enum summary, with description below.
Values
Name Type Value Description
LegalEntityURLSourceAssets string "assets"
LegalEntityURLSourceOther string "other"
Description

Enum reference

Enum
LenderType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
LenderTypeDirect string "direct"
LenderTypeBank string "bank"
Description

Enum reference

Enum
ProfileType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
ProfileTypeAdvisor string "advisor"
ProfileTypeAsset string "asset"
ProfileTypeInvestor string "investor"
ProfileTypeLender string "lender"
Description

Enum reference

Enum
BrokerRecommendationPeriodicity ⎯ Some enum summary, with description below.
Values
Name Type Value Description
BrokerRecommendationPeriodicityWeekly string "weekly"
BrokerRecommendationPeriodicityBiWeekly string "biWeekly"
BrokerRecommendationPeriodicityMonthly string "monthly"
BrokerRecommendationPeriodicityBiMonthly string "biMonthly"
BrokerRecommendationPeriodicityQuarterly string "quarterly"
Description

Enum reference

Enum
ListRelatedAssetsSource ⎯ Some enum summary, with description below.
Values
Name Type Value Description
ListRelatedAssetsSourceIndustry string "industry"
ListRelatedAssetsSourceIndustryMarketSegment string "industryMarketSegment"
ListRelatedAssetsSourceBookmarkList string "bookmarkList"
Description

Enum reference

Enum
AssetSummaryValuationPeriod ⎯ Some enum summary, with description below.
Values
Name Type Value Description
AssetSummaryValuationPeriodLastFiscalYear string "lastFiscalYear"
AssetSummaryValuationPeriodCurrentFiscalYear string "currentFiscalYear"
AssetSummaryValuationPeriodNextFiscalYear string "nextFiscalYear"
AssetSummaryValuationPeriodLastTwelveMonths string "lastTwelveMonths"
AssetSummaryValuationPeriodNextTwelveMonths string "nextTwelveMonths"
Description

Enum reference

Enum
SourceObjectType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
SourceObjectTypeAssetOwnership string "assetOwnership"
SourceObjectTypeDeal string "deal"
SourceObjectTypeLender string "lender"
Description

Enum reference

Enum
CreditType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
CreditTypeSeniorDebt string "seniorDebt"
CreditTypeSubordinatedDebt string "subordinatedDebt"
CreditTypeRevolvingCredit string "revolvingCredit"
CreditTypeHybridFinancing string "hybridFinancing"
CreditTypePurposeSpecificFinancing string "purposeSpecificFinancing"
CreditTypeSustainabilityLinkedFinancing string "sustainabilityLinkedFinancing"
CreditTypeCorporateBond string "corporateBond"
CreditTypeEquity string "equity"
CreditTypeUnknown string "unknown"
Description

Enum reference

Enum
CreditSubtype ⎯ Some enum summary, with description below.
Values
Name Type Value Description
CreditSubtypeFirstLien string "firstLien"
CreditSubtypeSecondLien string "secondLien"
CreditSubtypeTLA string "tla"
CreditSubtypeTLB string "tlb"
CreditSubtypeSubordinatedLoan string "subordinatedLoan"
CreditSubtypeMezzanine string "mezzanine"
CreditSubtypePaymentInKind string "paymentInKind"
CreditSubtypeUnitrancheDebt string "unitrancheDebt"
CreditSubtypeConvertibleDebt string "convertibleDebt"
CreditSubtypeStructuredDebt string "structuredDebt"
CreditSubtypeBridgeLoan string "bridgeLoan"
CreditSubtypeDebenture string "debenture"
CreditSubtypeCommonStock string "commonStock"
CreditSubtypePreferredStock string "preferredStock"
CreditSubtypeWarrants string "warrants"
Description

Enum reference

Enum
CreditReferenceRate ⎯ Some enum summary, with description below.
Values
Name Type Value Description
CreditReferenceRateLibor string "libor"
CreditReferenceRateSofr string "sofr"
CreditReferenceRatePrime string "prime"
CreditReferenceRateFederalFunds string "federalFunds"
CreditReferenceRateSonia string "sonia"
CreditReferenceRateEuribor string "euribor"
CreditReferenceRateStibor string "stibor"
CreditReferenceRateNibor string "nibor"
CreditReferenceRateCdor string "cdor"
CreditReferenceRateCorra string "corra"
CreditReferenceRateBbsy string "bbsy"
CreditReferenceRateTibor string "tibor"
CreditReferenceRateHibor string "hibor"
CreditReferenceRateSibor string "sibor"
CreditReferenceRateBkbm string "bkbm"
CreditReferenceRatePribor string "pribor"
CreditReferenceRateBubor string "bubor"
CreditReferenceRateKlibor string "klibor"
CreditReferenceRatePhiref string "phiref"
CreditReferenceRateTaibor string "taibor"
CreditReferenceRateBsby string "bsby"
CreditReferenceRateSora string "sora"
CreditReferenceRateTonar string "tonar"
CreditReferenceRateBbsw string "bbsw"
CreditReferenceRateSaron string "saron"
CreditReferenceRateCibor string "cibor"
Description

Enum reference

Enum
CurrencyDisplayType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
CurrencyDisplayTypeCode string "code"
CurrencyDisplayTypeSymbol string "symbol"
Description

Enum reference

Enum
NewsArticleType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
FinancialReleaseNewsType string "financialRelease"
PlatformDealNewsType string "platformDeal"
FundingRoundDealNewsType string "fundingRoundDeal"
StrategicExitNewsType string "strategicExitDeal"
PublicToPrivateNewsType string "publicToPrivateDeal"
AddOnNewsType string "addOnDeal"
Description

Enum reference

Enum
SearchItemType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
SearchItemTypeAdvisor string "advisor"
SearchItemTypeAutomatedAsset string "automatedAsset"
SearchItemTypeConferenceEdition string "conferenceEdition"
SearchItemTypeCuratedAsset string "curatedAsset"
SearchItemTypeEntity string "entity"
SearchItemTypeIndustry string "industry"
SearchItemTypeInvestor string "investor"
SearchItemTypeLender string "lender"
Description

Enum reference

Enum
ReportSeverity ⎯ Some enum summary, with description below.
Values
Name Type Value Description
ReportSeverityInfo string "info"
ReportSeverityError string "error"
ReportSeverityWarning string "warning"
Description

Enum reference

Enum
ReportService ⎯ Some enum summary, with description below.
Values
Name Type Value Description
ReportServiceApp string "web-app"
ReportServiceCMS string "web-cms"
ReportServiceBrowserExtension string "web-browser-extension"
Description

Enum reference

Enum
TicketType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
TicketTypeRequestAdvisorProfile string "requestAdvisorProfile"
TicketTypeRequestCompanyProfile string "requestCompanyProfile"
TicketTypeRequestConferenceProfile string "requestConferenceProfile"
TicketTypeRequestDealProfile string "requestDealProfile"
TicketTypeRequestInvestorProfile string "requestInvestorProfile"
TicketTypeShareCompanyFeedback string "shareCompanyFeedback"
TicketTypeShareInvestorFeedback string "shareInvestorFeedback"
TicketTypeShareInvestorFundFeedback string "shareInvestorFundFeedback"
TicketTypeShareInvestorStrategyFeedback string "shareInvestorStrategyFeedback"
Description

Enum reference

Enum
TicketAttributeType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
TicketAttributeAdvisorName string "advisorName"
TicketAttributeAdvisorWebsite string "advisorWebsite"
TicketAttributeCompanyName string "companyName"
TicketAttributeCompanyRegion string "companyRegion"
TicketAttributeCompanyWebsite string "companyWebsite"
TicketAttributeConferenceName string "conferenceName"
TicketAttributeConferenceWebsite string "conferenceWebsite"
TicketAttributeDealBuyers string "dealBuyers"
TicketAttributeDealDate string "dealDate"
TicketAttributeDealSellers string "dealSellers"
TicketAttributeDealTargetName string "dealTargetName"
TicketAttributeDealTargetWebsite string "dealTargetWebsite"
TicketAttributeGainProCompanyUrl string "gainProCompanyUrl"
TicketAttributeGainProInvestorUrl string "gainProInvestorUrl"
TicketAttributeInvestorFundName string "investorFundName"
TicketAttributeInvestorName string "investorName"
TicketAttributeInvestorStrategyName string "investorStrategyName"
TicketAttributeInvestorWebsite string "investorWebsite"
Description

Enum reference

Enum
AuthenticationType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
AuthenticationTypeEmail string "email"
AuthenticationTypeSSO string "sso"
Description

Enum reference

Enum
CustomFieldSource ⎯ Some enum summary, with description below.
Values
Name Type Value Description
CustomFieldSourceManual string "manual"
CustomFieldSourceDealCloud string "dealcloud"
CustomFieldSourceSalesforce string "salesforce"
Description

Enum reference

Enum
CustomFieldType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
CustomFieldTypeInteger string "integer"
CustomFieldTypeFloat string "float"
CustomFieldTypeString string "string"
CustomFieldTypeBool string "bool"
CustomFieldTypeDateTime string "dateTime"
CustomFieldTypeSingleSelect string "singleSelect"
CustomFieldTypeURL string "url"
Description

Enum reference

Enum
UserPermissionRole ⎯ Some enum summary, with description below.
Values
Name Type Value Description
UserPermissionRoleOwner string "owner"
UserPermissionRoleEditor string "editor"
UserPermissionRoleViewer string "viewer"
Description

Enum reference

Enum
UserPermissionObjectType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
UserPermissionObjectTypeBookmarkList string "bookmarkList"
Description

Enum reference

Enum
UserRole ⎯ Some enum summary, with description below.
Values
Name Type Value Description
UserRole string "user"
UserRoleAdministrator string "admin"
UserRoleSuperAdministrator string "superadmin"
Description

Enum reference

Enum
UserUnitSystem ⎯ Some enum summary, with description below.
Values
Name Type Value Description
UserUnitSystemKm string "km"
UserUnitSystemMiles string "miles"
Description

Enum reference

Enum
UserStatus ⎯ Some enum summary, with description below.
Values
Name Type Value Description
UserStatusNotInvited string "notInvited"
UserStatusInvited string "invited"
UserStatusActive string "active"
UserStatusDeactivated string "deactivated"
Description

Enum reference

Enum
BookmarkListType ⎯ Some enum summary, with description below.
Values
Name Type Value Description
BookmarkListTypeAssets string "assets"
BookmarkListTypeRecentAssetsFilter string "recentAssetsFilter"
BookmarkListTypeInvestors string "investors"
Description

Types

Type reference

Type
ActiveConsolidator ⎯
Properties
Name Type Description
assetDescription string | null
assetEbitdaEur number(float) | null
assetEbitdaYear number(int) | null
assetFte number(float) | null
assetId number(int)
assetLogoFileUrl string | null
assetName string
assetRegion string | null
assetRevenueEur number(float) | null
assetRevenueIsAiGenerated bool | null
assetRevenueWithAiGeneratedEur number(float) | null
assetRevenueYear number(int) | null
dealCount number(int)
lastDealMonth number(int) | null
lastDealYear number(int) | null
Description

Type reference

Type
ActiveConsolidatorList ⎯
Properties
Name Type Description
count number(int)
items array(ActiveConsolidator)
Description

Type reference

Type
ActiveInvestor ⎯
Properties
Name Type Description
assetCount number(int)
assetEbitdasEur array(number(float))
dealCount number(int)
investorId number(int)
investorLogoFileUrl string | null
investorName string
investorOperationalHqCountryCode string | null
lastDealMonth number(int) | null
lastDealYear number(int) | null
medianEbitdaEur number(float) | null
Description

Type reference

Type
ActiveInvestorList ⎯
Properties
Name Type Description
count number(int)
items array(ActiveInvestor)
Description

Type reference

Type
ActiveStrategicAcquirer ⎯
Properties
Name Type Description
assetDescription string | null
assetEbitdaEur number(float) | null
assetEbitdaYear number(int) | null
assetFte number(float) | null
assetId number(int)
assetLogoFileUrl string | null
assetName string
assetRegion string | null
assetRevenueEur number(float) | null
assetRevenueIsAiGenerated bool | null
assetRevenueWithAiGeneratedEur number(float) | null
assetRevenueYear number(int) | null
dealCount number(int)
lastDealMonth number(int) | null
lastDealYear number(int) | null
Description

Type reference

Type
ActiveStrategicAcquirerList ⎯
Properties
Name Type Description
count number(int)
items array(ActiveStrategicAcquirer)
Description

Type reference

Type
Address ⎯
Properties
Name Type Description
id number(int)
city string
countryCode string
formattedAddress string
lat number(float)
lng number(float)
locationType string | null
region string | null
Description

Type reference

Type
Advisor ⎯
Properties
Name Type Description
id number(int)
advisoryActivities array(string(AdvisoryActivity))
aliases array(AdvisorAlias)
createdAt string(rfc3339)
founders string | null
fteMeasurements array(AdvisorFteMeasurement)
linkedInUrl string | null
linkedinExternalId string | null
live bool
logoFileId number(int) | null
logoFileUrl string | null
name string | null
operationalHqCity string | null
operationalHqCountryCode string | null
publishedAt string(rfc3339) | null
unpublishedAt string(rfc3339) | null
updatedAt string(rfc3339)
url string | null
urls array(Url) Website URLs associated with this advisor
webUrl string | null Deprecated: Use url
yearFounded number(int) | null
Description

Type reference

Type
AdvisorAlias ⎯
Properties
Name Type Description
id number(int)
advisorId number(int)
alias string
order number(int)
Description

Type reference

Type
AdvisorAssetClient ⎯
Properties
Name Type Description
assetDescription string | null
assetFte number(float) | null
assetFteRange string | null
assetFteYear number(int) | null
assetId number(int)
assetLogoFileUrl string | null
assetName string
dealCount number(int)
dealIds array(number(int))
lastDeal Deal
Description

Type reference

Type
AdvisorCountryCodeCount ⎯
Properties
Name Type Description
count number(int)
countryCode string
Description

Type reference

Type
AdvisorDealListItem ⎯
Properties
Name Type Description
id number(int) Unique identifier for the deal.
advised string(DealAdvisorAdvised)
advisedOn array(string(AdvisoryActivity))
advisorId number(int) | null
advisorIds array(number(int)) Identifiers for the advisors involved in the deal.
announcementDate string Date when the deal was announced, formatted as YYYY-MM.
announcementDateMonth number(int) | null Month when the deal was announced.
announcementDateYear number(int) | null Year when the deal was announced.
asset string | null The target asset involved in the deal.
assetLogoFileUrl string | null URL of the logo file for the asset.
bidderAssetIds array(number(int)) ID of bidders that are Asset objects. Can be used to filter deals where a known asset was a bidder.
bidderFundIds array(number(int)) ID of the the linked investor fund associated.
bidderInvestorIds array(number(int)) Analogous to BidderAssetIds, but for Investor objects.
bidderLogoFileUrls array(string) Only relevant for internal use.
bidderReasons array(string(DealReason)) All known DealReasons of bidders. Can be used for filtering deals by reasoning.
bidderSharePcts array(number(float)) All known percentage stakes acquired by buyers. Useful for filtering.
bidderShares array(string(DealSideShare)) All known types of shares acquired by buyers. Can be used for filtering deals by type of stake acquired.
bidderStrategyIds array(number(int)) ID of the the linked investor strategies associated.
buyerAdvisorIds array(number(int)) IDs of advisors who advised the buyers.
buyerAssetIds array(number(int)) ID of buyers that are Asset objects. Can be used to filter deals where a known asset was a buyer.
buyerAssetNames array(string) Only relevant for internal use. Use BuyersInfo instead.
buyerFundIds array(number(int)) ID of the the linked investor fund associated.
buyerInvestorIds array(number(int)) Analogous to BuyerAssetIds, but for Investor objects.
buyerInvestorNames array(string) Only relevant for internal use. Use BuyersInfo instead.
buyerLeadingParties array(bool) Only relevant for internal use. Use BuyersInfo instead.
buyerLinkedIds array(number(int)) Only relevant for internal use. Use BuyersInfo instead.
buyerLogoFileUrls array(string) Only relevant for internal use.
buyerNames array(string) Only relevant for internal use. Use BuyersInfo instead.
buyerReasons array(string(DealReason)) All known DealReasons of buyers. Can be used for filtering deals by reasoning. For a full overview of buyer info, see BuyersInfo instead.
buyerSharePcts array(number(float)) All known percentage stakes acquired by buyers. Useful for filtering. For a full overview of buyer info, see BuyersInfo instead.
buyerShares array(string(DealSideShare)) All known types of shares acquired by buyers. Can be used for filtering deals by type of stake acquired. For a full overview of buyer info, see BuyersInfo instead.
buyerStrategyIds array(number(int)) ID of the the linked investor strategies associated.
buyerTypes array(string(DealSideType)) Only relevant for internal use. Use BuyersInfo instead.
buyers number(int) Deprecated: will be removed
buyersInfo array(DealSummarySide)
countryCode string | null ISO-2 code indicating the HQ country of the target asset.
currency string | null Currency of the deal facts.
dealStatus string(DealStatus) Status of the deal's progress, if it has not (yet) been completed.
dealType string(DealType) | null() Deprecated. Will be removed from the API.
division string | null Division of the target asset involved in the deal.
ebit number(float) | null Earnings before interest and taxes of the target company.
ebitEur number(float) | null EBIT of the target company in EUR.
ebitYear number(int) | null Year of the EBIT data.
ebitda number(float) | null Earnings before interest, taxes, depreciation, and amortization of the target company.
ebitdaEur number(float) | null EBITDA of the target company in EUR.
ebitdaYear number(int) | null Year of the EBITDA data.
equity number(float) | null Equity value of the target company.
equityEur number(float) | null Equity value of the target company in EUR.
equityYear number(int) | null Year of the equity value data.
ev number(float) | null Enterprise value of the target company as determined in the deal.
evEbitMultiple number(float) | null Enterprise value to EBIT multiple.
evEbitMultipleYear number(int) | null Year of the EV to EBIT multiple data.
evEbitdaMultiple number(float) | null Enterprise value to EBITDA multiple.
evEbitdaMultipleYear number(int) | null Year of the EV to EBITDA multiple data.
evEur number(float) | null Enterprise value of the target company in EUR.
evRevenueMultiple number(float) | null Enterprise value to revenue multiple.
evRevenueMultipleYear number(int) | null Year of the EV to revenue multiple data.
evTotalAssetsMultiple number(float) | null Enterprise value to total assets multiple.
evTotalAssetsMultipleYear number(int) | null Year of the EV to total assets multiple data.
evYear number(int) | null Year of the enterprise value data.
fte number(float) | null Number of full-time employees of the target company.
fteYear number(int) | null Year of the full-time employee count.
fundingRoundAmountRaised number(float) | null Amount raised in the funding round.
fundingRoundAmountRaisedEur number(float) | null Amount raised in the funding round in EUR.
fundingRoundAmountRaisedYear number(int) | null Deprecated: Use publication year instead.
fundingRoundPostMoneyValuation number(float) | null Post-money valuation for the funding round.
fundingRoundPostMoneyValuationEur number(float) | null Post-money valuation for the funding round in EUR.
fundingRoundPostMoneyValuationYear number(int) | null Year of the post-money valuation data.
fundingRoundPreMoneyValuation number(float) | null Pre-money valuation for the funding round.
fundingRoundPreMoneyValuationEur number(float) | null Pre-money valuation for the funding round in EUR.
fundingRoundPreMoneyValuationYear number(int) | null Year of the pre-money valuation data.
fundingRoundType string(DealFundingRoundType) | null() Type of the funding round, such as Series A, B, C, etc.
gainProUrl string URL to the deal page on Gain.pro.
highlightedBuyerDivision string | null Division of the highlighted buyer.
highlightedBuyerId number(int) | null Identifier for the highlighted (most notable) buyer.
highlightedBuyerName string | null Name of the highlighted buyer.
highlightedBuyerReason string(DealReason) | null() Reason for the highlighted buyer's involvement in the deal.
highlightedBuyerRegion string | null ISO-2 code indicating the HQ country of the highlighted buyer.
highlightedBuyerShare string(DealSideShare) | null() Share of the highlighted buyer in the deal.
highlightedBuyerSharePct number(float) | null Percentage share acquired by the highlighted buyer in the deal.
highlightedBuyerType string(DealSideType) | null() Type of the highlighted buyer, such as investor or asset.
highlightedSellerDivision string | null See equivalent buyers field.
highlightedSellerId number(int) | null See equivalent buyers field.
highlightedSellerName string | null See equivalent buyers field.
highlightedSellerReason string(DealReason) | null() See equivalent buyers field.
highlightedSellerRegion string | null See equivalent buyers field.
highlightedSellerShare string(DealSideShare) | null() See equivalent buyers field.
highlightedSellerSharePct number(float) | null See equivalent buyers field.
highlightedSellerType string(DealSideType) | null() See equivalent buyers field.
investorIds array(number(int)) Identifiers for the investors involved in the deal.
linkedAssetDescription string | null Description of the linked asset.
linkedAssetId number(int) | null Identifier for the linked asset associated with the deal.
linkedAssetUrl string | null Url of the linked asset associated with the deal.
live bool True if the deal is currently published on Gain.pro.
publicationDate string(rfc3339) | null The date when the deal was published on Gain.pro.
reasons array(string(DealReason)) Aggregation of reasons for involvement of all deal sides. See individual deal buyers and sellers.
region string | null ISO-2 code indicating the HQ country of the target asset.
revenue number(float) | null Revenue of the target company.
revenueEur number(float) | null Revenue of the target company in EUR.
revenueYear number(int) | null Year of the revenue data.
sector string | null Sector of the target asset.
sellerAdvisorIds array(number(int)) IDs of advisors who advised the sellers.
sellerAssetIds array(number(int)) See equivalent buyers field.
sellerAssetNames array(string) Only relevant for internal use. Use SellersInfo instead.
sellerFundIds array(number(int)) See equivalent buyers field.
sellerInvestorIds array(number(int)) See equivalent buyers field.
sellerInvestorNames array(string) Only relevant for internal use. Use SellersInfo instead.
sellerLeadingParties array(bool) Only relevant for internal use. Use SellersInfo instead.
sellerLinkedIds array(number(int)) Only relevant for internal use. Use SellersInfo instead.
sellerLogoFileUrls array(string) See equivalent buyers field.
sellerNames array(string) Only relevant for internal use. Use SellersInfo instead.
sellerReasons array(string(DealReason)) See equivalent buyers field.
sellerSharePcts array(number(float)) See equivalent buyers field.
sellerShares array(string(DealSideShare)) See equivalent buyers field.
sellerStrategyIds array(number(int)) See equivalent buyers field.
sellerTypes array(string(DealSideType)) Only relevant for internal use. Use SellersInfo instead.
sellers number(int) Deprecated: will be removed
sellersInfo array(DealSummarySide)
subsector string | null Subsector of the target asset.
tagIds array(number(int)) Identifiers for the tags applied to the deal target.
tags array(string) Tags applied to the deal target.
totalAssets number(float) | null Total assets of the target company.
totalAssetsEur number(float) | null Total assets of the target company in EUR.
totalAssetsYear number(int) | null Year of the total assets data.
type string Type of deal object. Automated deals were sourced without human curation.
webUrl string Deprecated: no longer maintained
Description

Type reference

Type
AdvisorDealsByTypeAndYear ⎯
Properties
Name Type Description
count number(int)
groupValue string
year number(int)
Description

Type reference

Type
AdvisorDealsList ⎯
Properties
Name Type Description
args ListArgs
counts ListCounts
items array(AdvisorDealListItem)
Description

Type reference

Type
AdvisorFteMeasurement ⎯
Properties
Name Type Description
id number(int)
advisorId number(int)
determinedAt string(rfc3339)
employeeCount number(float)
Description

Type reference

Type
AdvisorInvestorClient ⎯
Properties
Name Type Description
assets array(DealAdvisorAsset)
assetsCount number(int)
dealCount number(int)
dealEbitdasEur array(number(float))
dealIds array(number(int))
investorId number(int)
investorLogoFileUrl string | null
investorName string
lastDealDate string(rfc3339) | null
Description

Type reference

Type
AdvisorList ⎯
Properties
Name Type Description
args ListArgs
counts ListCounts
items array(AdvisorListItem)
Description

Type reference

Type
AdvisorListItem ⎯
Properties
Name Type Description
id number(int)
advisoryActivities array(string(AdvisoryActivity))
aliases array(string) Alternative names for the company.
coreFocus string(AdvisoryActivity) | null()
dealAdvisedOn array(string(AdvisoryActivity))
dealCount number(int)
dealCountAdvisedBuyers number(int)
dealCountAdvisedSellers number(int)
dealCountAdvisedUnknown number(int)
dealCountFiltered number(int)
dealEbitdaMedianEur number(float) | null
dealEbitdasEur array(number(float))
dealIds array(number(int))
dealRegions array(string) HQ Country of the assets that are being advised on
dealSectors array(string)
dealSubsectors array(string)
deals array(AdvisorSummaryAdvisedDeal) Deals that the advisor has advised on in the last 5 years.
founders string | null Founders of the advisor.
fte number(float) | null Latest available measurement of full-time equivalent (FTE) employees
fteRange string | null
fteRangeCategory number(int) | null
gainProUrl string URL to the advisor's page on Gain.pro.
linkedInUrl string | null URL to the advisor's LinkedIn profile.
live bool
logoFileId number(int) | null
logoFileUrl string | null
name string Name of the advisor.
operationalHqCity string | null City of the advisor's operational headquarters.
operationalHqCountryCode string | null Country code of the advisor's operational headquarters.
publishedAt string(rfc3339)
url string | null URL to the advisor's website.
webUrl string | null Deprecated: use url instead.
yearFounded number(int) | null Year the advisor was founded.
Description

Type reference

Type
AdvisorSubsectorCount ⎯
Properties
Name Type Description
count number(int)
subsector string
Description

Type reference

Type
AdvisorSummary ⎯
Properties
Name Type Description
id number(int)
advisoryActivities array(string(AdvisoryActivity))
aliases array(string) Alternative names for the company.
coreFocus string(AdvisoryActivity) | null()
dealAdvisedOn array(string(AdvisoryActivity))
dealCount number(int)
dealCountAdvisedBuyers number(int)
dealCountAdvisedSellers number(int)
dealCountAdvisedUnknown number(int)
dealEbitdaMedianEur number(float) | null
dealEbitdasEur array(number(float))
dealIds array(number(int))
dealRegions array(string) HQ Country of the assets that are being advised on
dealSectors array(string)
dealSubsectors array(string)
deals array(AdvisorSummaryAdvisedDeal) Deals that the advisor has advised on in the last 5 years.
founders string | null Founders of the advisor.
fte number(float) | null Latest available measurement of full-time equivalent (FTE) employees
fteRange string | null
fteRangeCategory number(int) | null
gainProUrl string URL to the advisor's page on Gain.pro.
linkedInUrl string | null URL to the advisor's LinkedIn profile.
live bool
logoFileId number(int) | null
logoFileUrl string | null
name string Name of the advisor.
operationalHqCity string | null City of the advisor's operational headquarters.
operationalHqCountryCode string | null Country code of the advisor's operational headquarters.
publishedAt string(rfc3339)
url string | null URL to the advisor's website.
webUrl string | null Deprecated: use url instead.
yearFounded number(int) | null Year the advisor was founded.
Description

Type reference

Type
AdvisorSummaryAdvisedDeal ⎯
Properties
Name Type Description
advisoryActivities array(string(AdvisoryActivity)) What the advisor advised on in this deal.
dealId number(int) ID of the deal.
party string(DealAdvisorAdvised) The party that the advisor advised on.
Description

Type reference

Type
AdvisoryActivityCount ⎯
Properties
Name Type Description
advisedOnAndAdvised string
count number(int)
Description

Type reference

Type
AnnualReport ⎯
Properties
Name Type Description
id number(int)
amendment bool
bookYearEnd string(rfc3339)
bookYearStart string(rfc3339) | null
comment string
companyName string | null
createdAt string(rfc3339) | null
description string
files array(AnnualReportFile)
financialResults array(AnnualReportFinancialResult)
isReadyToParse bool
items array(AnnualReportItem)
legalEntityId number(int)
parseError string | null
parsedAt string(rfc3339) | null
parserVersion number(int) | null
publicationDate string(rfc3339) | null
revisionDate string(rfc3339) | null
type string
Description

Type reference

Type
AnnualReportDownloadURLs ⎯
Properties
Name Type Description
fileURL string
Description

Type reference

Type
AnnualReportFile ⎯
Properties
Name Type Description
id number(int)
automatedDownload bool
createdAt string(rfc3339)
documentId string | null
fileId number(int) | null
fileId number(int)
filename string
format string
internal bool
language string | null
processedAt string(rfc3339) | null
processedBy string | null
processingError string | null
processorVersion string | null
transactionId string | null internal use only
type string | null
Description

Type reference

Type
AnnualReportFinancialResult ⎯
Properties
Name Type Description
id number(int)
annualReportId number(int)
capex number(float) | null
capital number(float) | null
cash number(float) | null
debt number(float) | null
ebit number(float) | null
ebitda number(float) | null
fte number(float) | null
grossMargin number(float) | null
inventory number(float) | null
netDebt number(float) | null
payables number(float) | null
receivables number(float) | null
revenue number(float) | null
totalAssets number(float) | null
year number(int)
Description

Type reference

Type
AnnualReportItem ⎯
Properties
Name Type Description
id number(int)
fields array(AnnualReportItemField)
fragmentId string
issue string | null
source string
title string
type string
Description

Type reference

Type
AnnualReportItemField ⎯
Properties
Name Type Description
id number(int)
bool bool | null
code string
date Date | null
fragmentId string
issue string | null
text string | null
title string
type string
value number(float) | null
Description

Type reference

Type
Article ⎯
Properties
Name Type Description
id number(int)
body string | null
category string(ArticleCategory) | null()
date string(rfc3339)
highlightedAssetId number(int) | null
highlightedIndustryId number(int) | null
highlightedInvestorId number(int) | null
largeImageFileId number(int) | null
largeImageFileUrl string | null
largeImageFilename string | null
linkedAssets array(ArticleAsset)
linkedDealId number(int) | null
linkedIndustries array(ArticleIndustry)
linkedInvestors array(ArticleInvestor)
published bool
regions array(string)
sector string | null
smallImageFileId number(int) | null
smallImageFileUrl string | null
smallImageFilename string | null
subsector string | null
title string | null
type string(ArticleType)
Description

Type reference

Type
ArticleAsset ⎯
Properties
Name Type Description
id number(int)
articleId number(int)
assetId number(int)
order number(int)
Description

Type reference

Type
ArticleIndustry ⎯
Properties
Name Type Description
id number(int)
articleId number(int)
industryId number(int)
order number(int)
Description

Type reference

Type
ArticleInvestor ⎯
Properties
Name Type Description
id number(int)
articleId number(int)
investorId number(int)
order number(int)
Description

Type reference

Type
ArticleList ⎯
Properties
Name Type Description
args ListArgs
counts ListCounts
items array(ArticleListItem)
Description

Type reference

Type
ArticleListItem ⎯
Properties
Name Type Description
id number(int)
body string | null
category string | null
date string(rfc3339)
highlightedAssetId number(int) | null
highlightedAssetLogoFileUrl string | null
highlightedAssetName string | null
highlightedAssetRegion string | null
highlightedIndustryId number(int) | null
highlightedInvestorId number(int) | null
largeImageFileId number(int) | null
largeImageFileUrl string | null
linkedAssetIds array(number(int))
linkedAssetLogoFileUrls array(string)
linkedAssetNames array(string)
linkedAssetRegions array(string)
linkedDealId number(int) | null
linkedInvestorBuyerIds array(number(int))
linkedInvestorBuyerNames array(string)
linkedInvestorSellerIds array(number(int))
linkedInvestorSellerNames array(string)
regions array(string)
sector string | null
smallImageFileId number(int) | null
smallImageFileUrl string | null
subsector string | null
title string | null
type string
week number(int)
year number(int)
Description

Type reference

Type
Asset ⎯
Properties
Name Type Description
id number(int)
aliases array(AssetAlias) Alternative names for the company.
annualReports array(AssetAnnualReport) Annual report filings of the company and their data.
competitors array(AssetCompetitor) Information of key competitors of this company.
cons array(AssetCon) Qualitative assessment of key risks associated with investing in this company.
createdAt string(rfc3339) Original creation date of the asset.
dealCapitalizations array(AssetDealCapitalization) Capitalization data of the asset.
description AssetDescription | null Short- and long-form descriptions of the company's business model and history.
enableAiEstimates bool Only relevant for internal use.
excelFiles array(AssetExcelFile) Only relevant for internal use.
financialFootnotes array(AssetFinancialFootnote) Important remarks regarding the financial results, e.g. if industry-specific EBITDA alternatives are used.
financialLatests AssetLatestFinancials | null Latest financial results of the company.
financialPredictions array(AssetFinancialPrediction) Various predictions about the asset, such as future EBITDA and Enterprise Value, as estimated by Gain.pro's predictive models.
financialResults array(AssetFinancialResult) Full financial results of the asset by year.
financialsAt string(rfc3339) | null Last date when the asset's financial results were updated.
fteMeasurements array(AssetFteMeasurement) Recurring measurements of employee counts.
generalInfo AssetGeneralInfo | null Miscellaneous key info about the company.
legalEntities array(AssetLegalEntity) Legal entity registrations of the company and their data.
listedSecurities array(AssetListedSecurity) Listed securities (traded equity instruments) linked to the asset.
live bool True if the asset profile is actively maintained.
managers array(PersonExperience) Information of key people associated with this company.
market AssetMarket | null Info about the market the company operates in and its competition.
nextDeal AssetNextDealPrediction | null Year of the next expected deal, as estimated by Gain.pro's predictive model.
profileInConversion bool Only relevant for internal use.
profileLive bool False if the asset profile is currently being updated.
profileType string(AssetProfileType) Type of asset profile. Automated asset profiles are fully generated by GenAI models.
pros array(AssetPro) Qualitative assessment of key reasons to invest in this company.
publishedAt string(rfc3339) | null Only relevant for internal use.
rating AssetRating | null Standardized, quantitative assessment of the company on various key aspects.
segmentation AssetSegmentation | null Segment-based (e.g. by business unit) breakdown of a company's business activities.
shareholders array(AssetShareholder) Information of investors associated with the company.
sources array(AssetSource) Sources used to put together information about the company.
subsidiaryPath array(number(int)) | null Only relevant for internal use.
tags array(AssetTag) Keywords assigned to the company, such as its most important products and services.
unpublishedAt string(rfc3339) | null Only relevant for internal use.
updatedAt string(rfc3339) | null Last update of the asset.
urls array(Url) Website URLs associated with this company
Description

Type reference

Type
AssetAdvisor ⎯
Properties
Name Type Description
advisorId number(int)
advisorLogoFileUrl string | null
advisorName string
dealCount number(int)
dealIds array(number(int))
lastDeal Deal
lastDealAdvised string(DealAdvisorAdvised)
lastDealAdvisedOn array(string(AdvisoryActivity))
Description

Type reference

Type
AssetAlias ⎯
Properties
Name Type Description
id number(int)
alias string Alternative name for an asset.
assetId number(int)
order number(int)
Description

Type reference

Type
AssetAnnualReport ⎯
Properties
Name Type Description
annualReportFileId number(int)
financials bool True if the annual report was used to determine the asset's financials.
order number(int)
Description

Type reference

Type
AssetChart ⎯
Properties
Name Type Description
id number(int)
assetSegmentationId number(int)
by string
items array(AssetChartItem)
of string
order number(int)
periodFrom number(int) | null
periodTo number(int) | null
Description

Type reference

Type
AssetChartItem ⎯
Properties
Name Type Description
id number(int)
assetChartId number(int)
cagr number(float) | null
order number(int)
shareFrom number(float) | null
sharePct number(float) | null
shareTo number(float) | null
title string
Description

Type reference

Type
AssetCompetitor ⎯
Properties
Name Type Description
assetId number(int)
category string | null
competitorAssetId number(int)
createdAt string(rfc3339) | null
keyDifferentiators string | null
order number(int) Deprecated: no longer maintained
relevance number(float)
sharedValueProposition string | null
Description

Type reference

Type
AssetCon ⎯
Properties
Name Type Description
id number(int)
assetId number(int)
order number(int)
text string Qualitative assessment of a key risk associated with investing in this company.
Description

Type reference

Type
AssetDealCapitalization ⎯
Properties
Name Type Description
id number(int)
assetId number(int)
conversionMultiple number(float) | null Conversion multiple of the shares in the deal
conversionPrice number(float) | null Conversion price of the shares in the deal, in unit of local currency
dealId number(int) | null
dividendCumulative string(AssetDealCapitalizationTernary) Indicates if the dividends are cumulative
dividendRate number(float) | null Dividend rate of the shares, as a decimal (e.g., 0.05 for 5%)
dividendRights string(AssetDealCapitalizationTernary)
liquidationMultiple number(float) | null
liquidationParticipation string(AssetDealCapitalizationTernary)
liquidationPrice number(float) | null Liquidation price of the shares in the deal in unit of local currency
liquidationSeniority string(LiquidationSeniority)
moneyRaised DealFactFloat | null Money raised in the deal, in millions of currency unit
nsharesAuthorizedPreferred number(int) | null Number of shares authorized for preferred stock
originalIssuePrice number(float) | null Issue price of the shares in the deal in unit of local currency
pctOwnership number(float) | null Percentage ownership of the deal
stock string Stock type of the shares in the deal
votingRights string(AssetDealCapitalizationTernary) Indicates if the shares have voting rights
Description

Type reference

Type
AssetDealCapitalizationListItem ⎯
Properties
Name Type Description
id number(int)
announcementDate Date | null
assetId number(int)
conversionMultiple number(float) | null Conversion multiple of the shares in the deal
conversionPrice number(float) | null Conversion price of the shares in the deal, in unit of local currency
currency string | null
dealId number(int) | null
dividendCumulative string(AssetDealCapitalizationTernary) Indicates if the dividends are cumulative
dividendRate number(float) | null Dividend rate of the shares, as a decimal (e.g., 0.05 for 5%)
dividendRights string(AssetDealCapitalizationTernary)
fundingRoundPostMoneyValuation DealFactFloat | null
fundingRoundPreMoneyValuation DealFactFloat | null
highlightedBuyerId number(int) | null
liquidationMultiple number(float) | null
liquidationParticipation string(AssetDealCapitalizationTernary)
liquidationPrice number(float) | null Liquidation price of the shares in the deal in unit of local currency
liquidationSeniority string(LiquidationSeniority)
moneyRaised DealFactFloat | null Money raised in the deal, in millions of currency unit
nsharesAuthorizedPreferred number(int) | null Number of shares authorized for preferred stock
originalIssuePrice number(float) | null Issue price of the shares in the deal in unit of local currency
pctOwnership number(float) | null Percentage ownership of the deal
stock string Stock type of the shares in the deal
votingRights string(AssetDealCapitalizationTernary) Indicates if the shares have voting rights
Description

Type reference

Type
AssetDescription ⎯
Properties
Name Type Description
assetId number(int) Unique identifier for the asset.
atAGlance string Complete overview of the asset's business activities', with an emphasis on business model and key details.
esg string Environmental, Social, and Governance (ESG) information.
furtherInformation string Additional details about the asset, such as customer base and focus areas.
history string Historical background of the asset's ownership.
medium string | null Two-sentence description of the asset's main business activities and customer segments.
short string Brief description (tagline) of the asset's main business activity.
Description

Type reference

Type
AssetExcelFile ⎯
Properties
Name Type Description
id number(int)
assetId number(int)
comment string No longer maintained
fileDataType string(FileDataType)
importedCharts bool No longer maintained
importedFinancials bool No longer maintained
linkedAt string(rfc3339)
Description

Type reference

Type
AssetFinancialFootnote ⎯
Properties
Name Type Description
id number(int)
assetId number(int)
order number(int)
text string
Description

Type reference

Type
AssetFinancialPrediction ⎯
Properties
Name Type Description
id number(int)
assetId number(int)
debtMultiple number(float) Forecasted Debt/EBITDA (leverage ratio), as estimated by Gain.pro's predictive model.
debtQuantum number(float) Forecasted debt that could be used in a buyout, based on predicted leverage ratio.
details AssetFinancialPredictionDetails | null Only relevant for internal use.
ebitda number(float) Forecasted EBITDA for the year, as estimated by Gain.pro's predictive model.
enterpriseValue number(float) Forecasted EV based on EBITDA and EV/EBITDA multiple.
equityTicket number(float) Equity ticket required for a buyout, based on EV and debt quantum predictions.
multiple number(float) Forecasted EV/EBITDA multiple, as estimated by Gain.pro's predictive model.
year number(int)
Description

Type reference

Type
AssetFinancialPredictionDetails ⎯
Properties
Name Type Description
assetFinancialPredictionId number(int)
debtMultipleCeiling number(float)
debtMultipleCushion number(float)
debtMultipleFloor number(float)
debtMultipleResilienceMax number(float) | null
debtQuantumEbitda number(float)
debtQuantumMultiple number(float)
ebitdaBase number(float)
ebitdaGrowthPct number(float)
ebitdaYear number(int)
equityTicketDebt number(float)
equityTicketEv number(float)
evEbitda number(float)
evMultiple number(float)
multipleCashConversionCorrection number(float)
multipleGrowthCorrection number(float)
multipleMarketBase number(float)
multipleMax number(float)
multipleMin number(float)
multipleOutlierCapCorrection number(float)
multipleProfileCorrection number(float)
multipleProfitabilityCorrection number(float)
multipleResilienceCorrection number(float)
multipleResultNotRounded number(float)
multipleSectorCorrection number(float)
multipleSizeCorrection number(float)
multipleThinBusinessModelCorrection number(float)
Description

Type reference

Type
AssetFinancialResult ⎯
Properties
Name Type Description
id number(int)
assetId number(int)
capex FinancialResultAmount | null
capital FinancialResultAmount | null
cash FinancialResultAmount | null
cashConversionCycle FinancialResultAmount | null Only available for listed companies.
consolidatedNetIncome FinancialResultAmount | null Only available for listed companies.
consolidatedNetIncomeYoyGrowthPct number(float) | null Year-on-year growth percentage of consolidated net income.
currentLiabilities FinancialResultAmount | null
debt FinancialResultAmount | null
earningsPerShare FinancialResultAmount | null Only available for listed companies.
earningsPerShareYoyGrowthPct number(float) | null Year-on-year growth percentage of EPS.
ebit FinancialResultAmount | null
ebitda FinancialResultAmount | null
ebitdaMinusCapex number(float) | null
freeCashFlow FinancialResultAmount | null Only available for listed companies.
freeCashFlowYoyGrowthPct number(float) | null Year-on-year growth percentage of FCF.
fte FinancialResultAmount | null Full-time equivalent (FTE) employees as reported in company filings.
fteGrowthPct FinancialResultAmount | null Year-on-year growth percentage of FTEs.
grossMargin FinancialResultAmount | null
inventory FinancialResultAmount | null
isForecast bool True if these are future forecasts. Only applies to listed companies.
netDebt FinancialResultAmount | null
netDebtEbitdaRatio number(float) | null
payables FinancialResultAmount | null
periodicity string(FinancialResultPeriodicityType) Time period that the figures span.
receivables FinancialResultAmount | null
returnOnAssets number(float) | null
returnOnCapitalEmployed number(float) | null
returnOnEquity number(float) | null
revenue FinancialResultAmount | null
revenueFteRatio number(int) | null
revenueYoyGrowthPct number(float) | null Year-on-year growth percentage of revenue.
totalAssets FinancialResultAmount | null
totalEquity FinancialResultAmount | null
year number(int)
Description

Type reference

Type
AssetFteMeasurement ⎯
Properties
Name Type Description
id number(int)
assetId number(int)
determinedAt string(rfc3339)
employeeCount number(float)
Description

Type reference

Type
AssetGeneralInfo ⎯
Properties
Name Type Description
assetId number(int) Unique identifier for the asset
businessActivity array(string(AssetBusinessActivityType)) Business activities of the asset.
capitalizationExcelFileId number(int) | null Only relevant for internal use.
capitalizationExcelFileUrl string | null Only relevant for internal use.
currency string | null Currency in which the asset's financials are reported.
customerBase array(string(AssetCustomerBaseType)) Customer base types of the asset.
esgOutperformer bool Indicates if the asset is an ESG outperformer compared to its industry peers
excelFileId number(int) | null No longer maintained.
excelFileName string | null No longer maintained.
excelFileVersion string | null No longer maintained.
financialsExcelFileId number(int) | null Only relevant for internal use.
financialsExcelFileName string | null Only relevant for internal use.
fte number(float) | null Latest available measurement of full-time equivalent (FTE) employees.
fteRange string | null Range of the number of full-time equivalent employees
fteYear number(int) | null Year for which the FTE count is relevant
headquarters string ISO-2 country code for the headquarters of the asset
headquartersAddress Address | null Details of the headquarters address. See type definition.
headquartersAddressId number(int) | null Identifier for the headquarters address
lastDealMonth number(int) | null Month of the last deal involving the asset
lastDealYear number(int) | null Year of the last deal involving the asset
linkedinExternalId string | null External ID for the asset on LinkedIn
logoFileId number(int) | null Identifier for the logo file
logoFileUrl string | null URL for the logo file
logoFilename string | null Filename of the logo file
name string Name of the asset
ownership string(AssetOwnershipType) Ownership type of the asset.
ownershipIsVerified bool Ownership verification status. Can only be false when profile_type = 'automated'
pricePositioning string(AssetPricePositioningType) | null() Price positioning of the asset.
salesChannel array(string(AssetSalesChannelType)) Sales channels used by the asset.
sector string Sector in which the asset operates, e.g. TMT
subsector string Subsector in which the asset operates, e.g. Technology
totalFunding number(float) | null Total funding amount for the asset
totalFundingCurrency string | null Currency of the total funding amount
url string | null Website URL of the asset.
webUrl string | null Deprecated: Use url
yearFounded number(int) | null Year the asset was founded
Description

Type reference

Type
AssetLatestFinancials ⎯
Properties
Name Type Description
assetId number(int) Identifier for the asset. These are the latest available results for each financial item. See AssetFinancialResult for more info on individual fields.
capex FinancialLatestResultAmount | null
capital FinancialLatestResultAmount | null
cash FinancialLatestResultAmount | null
cashConversionCycle FinancialLatestResultAmount | null
consolidatedNetIncome FinancialLatestResultAmount | null
debt FinancialLatestResultAmount | null
earningsPerShare FinancialLatestResultAmount | null
ebit FinancialLatestResultAmount | null
ebitda FinancialLatestResultAmount | null
freeCashFlow FinancialLatestResultAmount | null
fte FinancialLatestResultAmount | null
grossMargin FinancialLatestResultAmount | null
inventory FinancialLatestResultAmount | null
netDebt FinancialLatestResultAmount | null
payables FinancialLatestResultAmount | null
receivables FinancialLatestResultAmount | null
revenue FinancialLatestResultAmount | null
totalAssets FinancialLatestResultAmount | null
Description

Type reference

Type
AssetLegalEntity ⎯
Properties
Name Type Description
id number(int)
assetId number(int)
financials bool True if the legal entity was used to determine the asset's financials.
financialsUntilYear number(int) | null The legal entity was used to determine the asset's financials up to and including this year.
isAutomatedAsset bool Only relevant for internal use.
legalEntityId number(int)
order number(int)
Description

Type reference

Type
AssetList ⎯
Properties
Name Type Description
args ListArgs
counts ListCounts
items array(AssetListItem)
Description

Type reference

Type
AssetListItem ⎯
Properties
Name Type Description
id number(int)
addOnDealCountL3Y number(int) | null The number of add-ons done by the company in the last 3 years
addOnDealCountL5Y number(int) | null The number of add-ons done by the company in the last 5 years
advisorIds array(number(int)) IDs of advisors associated with the asset
aliases array(string) Alternative names for the company.
assetLive bool True if the asset profile is actively maintained.
businessActivity array(string(AssetBusinessActivityType)) Business activities of the asset.
businessDescription string | null Complete overview of the asset's business activities', with an emphasis on business model and key details.
capex number(float) | null Latest reported capital expenditure in millions.
capexEur number(float) | null Capital expenditure in Euros.
capexResults array(number(float)) All known capital expenditures (Capex) results.
capexYear number(int) | null Year of latest capital expenditure.
capexYears array(number(int)) Years corresponding to all known capital expenditures (Capex) results.
capital number(float) | null Latest reported capital in millions.
capitalEur number(float) | null Capital in Euros.
capitalResults array(number(float)) All known net working capital (inventory + receivables - payables) results.
capitalYear number(int) | null Year of latest capital.
capitalYears array(number(int)) Years corresponding to all known capital results.
cash number(float) | null Latest reported cash in millions.
cashConversionCycle number(float) | null Latest reported cash conversion cycle.
cashConversionCycleResults array(number(float)) All known cash conversion cycle results.
cashConversionCycleYear number(int) | null Year of latest cash conversion cycle.
cashConversionCycleYears array(number(int)) Years corresponding to all known cash conversion cycle results.
cashEur number(float) | null Cash in Euros.
cashResults array(number(float)) All known cash results.
cashYear number(int) | null Year of latest cash.
cashYears array(number(int)) Years corresponding to all known cash results.
ceoAge number(int) | null Age of the CEO
ceoName string | null Name of the CEO
ceoTenure number(int) | null Duration of the CEO in years
competitorAssetIds array(number(int)) asset competitors
competitorCategory string | null Only relevant for internal use.
cons array(string) Cons on investing on the asset
consolidatedNetIncome number(float) | null Latest reported consolidated net income in millions.
consolidatedNetIncomeEur number(float) | null Consolidated net income in Euros.
consolidatedNetIncomeResults array(number(float)) All known consolidated net income results.
consolidatedNetIncomeYear number(int) | null Year of latest consolidated net income.
consolidatedNetIncomeYears array(number(int)) Years corresponding to all known consolidated net income results.
currency string | null Currency in which the asset's financials are reported
currencyToEur number(float) | null Conversion rate from the asset's currency to EUR. These are updated monthly.
customFields object
customerBase array(string(AssetCustomerBaseType)) Customer base types of the asset.
debt number(float) | null Latest reported debt in millions.
debtEur number(float) | null Debt in Euros.
debtResults array(number(float)) All known interest-bearing debt results.
debtYear number(int) | null Year of latest debt.
debtYears array(number(int)) Years corresponding to all known debt results.
description string | null Brief description (tagline) of the asset's main activity.
domain string | null Deprecated: Will be removed
earningsPerShare number(float) | null Latest reported earnings per share.
earningsPerShareEur number(float) | null Earnings per share in Euros.
earningsPerShareResults array(number(float)) All known earnings per share (EPS) results.
earningsPerShareYear number(int) | null Year of latest earnings per share.
earningsPerShareYears array(number(int)) Years corresponding to all known earnings per share (EPS) results.
ebit number(float) | null Latest reported EBIT in millions.
ebitCagrPctThreeYears number(float) | null The compound annual growth rate (CAGR) of EBIT over the past three years.
ebitCagrPctTwoYears number(float) | null The compound annual growth rate (CAGR) of EBIT over the past two years.
ebitEur number(float) | null EBIT in Euros.
ebitGrowthPctOneYear number(float) | null The percentage growth in EBIT over one year.
ebitPctRevenue number(float) | null EBIT as % of revenue in latest year.
ebitPctRevenueResults array(number(float)) All EBIT as percentage of revenue results.
ebitPctRevenueYears array(number(int)) Years of all EBIT as percentage of revenue results.
ebitResults array(number(float)) All known EBIT results.
ebitYear number(int) | null Year of latest EBIT.
ebitYears array(number(int)) Years corresponding to all known EBIT results.
ebitda number(float) | null Latest reported EBITDA in millions.
ebitdaCagrPctThreeYears number(float) | null The compound annual growth rate (CAGR) of EBITDA over the past three years.
ebitdaCagrPctTwoYears number(float) | null The compound annual growth rate (CAGR) of EBITDA over the past two years.
ebitdaEur number(float) | null EBITDA in Euros.
ebitdaGrowthPctOneYear number(float) | null The percentage growth in EBITDA over one year.
ebitdaIsAiGenerated bool Indicator if revenue is AI-generated.
ebitdaMinusCapex number(float) | null EBITDA less capital expenditures. Approximation of Free Cash Flow after all operating expenses and investments
ebitdaMinusCapexEur number(float) | null EBITDA minus Capex in EUR
ebitdaMinusCapexYear number(int) | null Year of the reported EBITDA minus Capex
ebitdaPctRevenue number(float) | null Latest reported EBITDA margin, as a percentage of revenue.
ebitdaPctRevenueResults array(number(float)) All EBITDA as percentage of revenue results.
ebitdaPctRevenueWithAiGenerated number(float) | null EbitdaPctRevenue if it is not null, else may be an AI-generated value.
ebitdaPctRevenueYears array(number(int)) Years of all EBITDA as percentage of revenue results.
ebitdaResults array(number(float)) All known EBITDA results.
ebitdaWithAiGenerated number(float) | null Same as Ebitda if it is not null, else may be an AI-generated value.
ebitdaWithAiGeneratedEur number(float) | null Same as RevenueWithAiGenerated, but converted to Euros.
ebitdaYear number(int) | null Year of latest EBITDA.
ebitdaYears array(number(int)) Years corresponding to all known EBITDA results.
enterpriseValue number(float) | null Enterprise value, derived from market capitalization and reported financials. Expressed in millions of the original currency.
enterpriseValueEbitRatio number(float) | null Ratio of Enterprise Value to Ebit as of the most recent financial report date.
enterpriseValueEbitRatioCurrentFiscalYear number(float) | null Ratio of the current Enterprise value to Current Fiscal Year forecasted Ebit
enterpriseValueEbitRatioFiscalYear number(int) | null Fiscal year of the most recent financial report used for Enterprise Value Ebitda ratio.
enterpriseValueEbitRatioFiscalYearQuarter number(int) | null Fiscal year quarter of the most recent financial report used for Enterprise Value Ebitda ratio.
enterpriseValueEbitRatioLastFiscalYear number(float) | null Ratio of the current Enterprise value to last fiscal year Ebit
enterpriseValueEbitRatioLastTwelveMonths number(float) | null Ratio of the current Enterprise value to Last Twelve Months Ebit
enterpriseValueEbitRatioNextFiscalYear number(float) | null Ratio of the current Enterprise value to Next Fiscal Year forecasted Ebit
enterpriseValueEbitRatioNextTwelveMonths number(float) | null Ratio of the current Enterprise value to Next Twelve Months Ebit
enterpriseValueEbitdaMinusCapexRatio number(float) | null Ratio of Enterprise Value to Ebitda minus Capex as of the most recent financial report date.
enterpriseValueEbitdaMinusCapexRatioFiscalYear number(int) | null Fiscal year of the most recent financial report used for Enterprise Value Ebitda minus Capex ratio.
enterpriseValueEbitdaMinusCapexRatioFiscalYearQuarter number(int) | null Fiscal year quarter of the most recent financial report used for Enterprise Value Ebitda minus Capex ratio.
enterpriseValueEbitdaRatio number(float) | null Ratio of Enterprise Value to Ebitda as of the most recent financial report date.
enterpriseValueEbitdaRatioCurrentFiscalYear number(float) | null Ratio of the current Enterprise value to Current Fiscal Year forecasted Ebitda
enterpriseValueEbitdaRatioFiscalYear number(int) | null Fiscal year of the most recent financial report used for Enterprise Value Ebitda ratio.
enterpriseValueEbitdaRatioFiscalYearQuarter number(int) | null Fiscal year quarter of the most recent financial report used for Enterprise Value Ebitda ratio.
enterpriseValueEbitdaRatioLastFiscalYear number(float) | null Ratio of the current Enterprise value to last fiscal year Ebitda
enterpriseValueEbitdaRatioLastTwelveMonths number(float) | null Ratio of the current Enterprise value to Last Twelve Months Ebitda
enterpriseValueEbitdaRatioNextFiscalYear number(float) | null Ratio of the current Enterprise value to Next Fiscal Year forecasted Ebitda
enterpriseValueEbitdaRatioNextTwelveMonths number(float) | null Ratio of the current Enterprise value to Next Twelve Months Ebitda
enterpriseValueEur number(float) | null Enterprise value, derived from market capitalization and reported financials. Expressed in millions of Euros.
enterpriseValueFiscalYear number(int) | null Fiscal year of the most recent financial report used for Enterprise Value.
enterpriseValueFiscalYearQuarter number(int) | null Fiscal year quarter of the most recent financial report used for Enterprise Value
enterpriseValueFreeCashFlowRatio number(float) | null Ratio of Enterprise Value to Free Cash Flow as of the most recent financial report date.
enterpriseValueFreeCashFlowRatioFiscalYear number(int) | null Fiscal year of the most recent financial report used for Enterprise Value Free Cash Flow ratio.
enterpriseValueFreeCashFlowRatioFiscalYearQuarter number(int) | null Fiscal year quarter of the most recent financial report used for Enterprise Value Free Cash Flow ratio.
enterpriseValueInvestedCapitalRatio number(float) | null Ratio of Enterprise Value to Invested Capital as of the most recent financial report date.
enterpriseValueInvestedCapitalRatioFiscalYear number(int) | null Fiscal year of the most recent financial report used for Enterprise Value Invested Capital ratio.
enterpriseValueInvestedCapitalRatioFiscalYearQuarter number(int) | null Fiscal year quarter of the most recent financial report used for Enterprise Value Invested Capital ratio.
enterpriseValueRevenueRatio number(float) | null Ratio of Enterprise value to Revenue as of the most recent financial report date.
enterpriseValueRevenueRatioCurrentFiscalYear number(float) | null Ratio of the current Enterprise value to Current Fiscal Year forecasted Revenue
enterpriseValueRevenueRatioFiscalYear number(int) | null Fiscal year of the most recent financial report used for Enterprise Value Revenue ratio.
enterpriseValueRevenueRatioFiscalYearQuarter number(int) | null Fiscal year quarter of the most recent financial report used for Enterprise Value Revenue ratio.
enterpriseValueRevenueRatioLastFiscalYear number(float) | null Ratio of the current Enterprise value to last fiscal year Revenue
enterpriseValueRevenueRatioLastTwelveMonths number(float) | null Ratio of the current Enterprise value to Last Twelve Months Revenue
enterpriseValueRevenueRatioNextFiscalYear number(float) | null Ratio of the current Enterprise value to Next Fiscal Year forecasted Revenue
enterpriseValueRevenueRatioNextTwelveMonths number(float) | null Ratio of the current Enterprise value to Next Twelve Months Revenue
esg string | null Environmental, Social, and Governance (ESG) information.
esgOutperformer bool Indicates if the asset is an ESG outperformer compared to its industry peers
financialNotes array(string) Financial foot notes
financialResults array(AssetSummaryFinancialResult) All historical financial results.
financialsAt string(rfc3339) | null Last date when the asset's financial results were updated.
freeCashFlow number(float) | null Latest reported free cash flow in millions.
freeCashFlowEur number(float) | null Free cash flow in Euros.
freeCashFlowResults array(number(float)) All known free cash flow (FCF) results.
freeCashFlowYear number(int) | null Year of latest free cash flow.
freeCashFlowYears array(number(int)) Years corresponding to all known free cash flow (FCF) results.
fte number(float) | null Latest available measurement of full-time equivalent (FTE) employees.
fteCagrPctThreeYears number(float) | null The compound annual growth rate (CAGR) of full-time equivalent employees (FTE) over the past three years.
fteCagrPctTwoYears number(float) | null The compound annual growth rate (CAGR) of full-time equivalent employees (FTE) over the past two years.
fteGrowthPctOneYear number(float) | null The percentage growth in full-time equivalent employees (FTE) over one year.
fteGrowthPctSixMonths number(float) | null The percentage growth in full-time equivalent employees (FTE) over six months.
fteGrowthPctThreeMonths number(float) | null The percentage growth in full-time equivalent employees (FTE) over three months.
fteRange string | null Employee size range as reported by the company. Note that this field is self-reported by the company and need not correspond to the Fte measurement.
fteRangeCategory number(int) | null Numerical representation of employee size ranges (e.g. 3 for '11-50') for easier filtering.
fteResults array(number(float)) All known full-time equivalent (FTE) employee results.
fteYear number(int) | null Year of the latest available measurement of full-time equivalent (FTE) employees.
fteYears array(number(int)) Years corresponding to all known full-time equivalent (FTE) employee results.
ftsHeadline string | null Only relevant for internal use.
ftsRelevance number(float) | null Only relevant for internal use.
fundIds array(number(int)) IDs of the investor fund associated with the asset
fundNames array(string) Names of the investor fund associated with the asset
gainProUrl string The URL to the asset's page on Gain.pro.
grossMargin number(float) | null Latest reported gross margin in millions.
grossMarginCagrPctThreeYears number(float) | null The compound annual growth rate (CAGR) of gross margin over the past three years.
grossMarginCagrPctTwoYears number(float) | null The compound annual growth rate (CAGR) of gross margin over the past two years.
grossMarginEur number(float) | null Gross Margin in Euros.
grossMarginGrowthPctOneYear number(float) | null The percentage growth in gross margin over one year.
grossMarginPctRevenue number(float) | null Gross Margin as % of revenue in latest year.
grossMarginPctRevenueResults array(number(float)) All gross margin as percentage of revenue results.
grossMarginPctRevenueYears array(number(int)) Years of all gross margin as percentage of revenue results.
grossMarginResults array(number(float)) All known gross margin results.
grossMarginYear number(int) | null Year of latest gross margin.
grossMarginYears array(number(int)) Years corresponding to all known gross margin results.
growthMetrics array(GrowthMetric) Growth metrics for different periods
headquartersCity string | null City of the headquarters
headquartersCountryCode string | null ISO-2 country code for the headquarters. Slightly more accurate, but less frequently available than field region
headquartersFormattedAddress string | null Formatted address of the headquarters
headquartersRegion string | null Region (e.g. state or province) of the headquarters
headquartersWgs84LngLat Point | null Geographical coordinates of the headquarters in WGS84 format
inventory number(float) | null Latest reported inventory in millions.
inventoryEur number(float) | null Inventory in Euros.
inventoryResults array(number(float)) All known inventory results.
inventoryYear number(int) | null Year of latest inventory.
inventoryYears array(number(int)) Years corresponding to all known inventory results.
investors array(AssetSummaryInvestor) Investors that have a stake in the asset
keyDifferentiators string | null Only relevant for internal use.
lastDealMonth number(int) | null Month of the last platform involving the asset, in which the asset's ownership changed meaningfully. May differ from the last deal involving the asset
lastDealYear number(int) | null Year of the last platform involving the asset, in which the asset's ownership changed meaningfully. May differ from the last deal involving the asset
latestDealPostMoneyValuationEur number(float) | null The post-money valuation in EUR of the most recent deal
latestDealPostMoneyValuationYear number(int) | null The year of the post-money valuation of the most recent deal
latestDealPreMoneyValuationEur number(float) | null The pre-money valuation in EUR of the most recent deal
latestDealPreMoneyValuationYear number(int) | null The year of the pre-money valuation of the most recent deal
latestDealRoundSizeEur number(float) | null The size of the most recent funding round involving the asset, measured in EUR millions
latestDealRoundType string(DealFundingRoundType) | null() Type of the latest funding round involving the asset, such as Seed, Series B, Venture, etc.
latestDealRoundYear number(int) | null The year of the most recent funding round involving the asset
latestIndustryRatingEnvironmental number(float) | null Environmental risk rating of the latest industry report that includes the asset
latestIndustryRatingOverall number(float) | null Overall ESG rating of the latest industry report that includes the asset
latestIndustryRatingSocial number(float) | null Social risk rating of the latest industry report that includes the asset
legalEntities array(AssetSummaryLegalEntity) Legal entities linked to the asset
legalEntityExternalIds array(string) External IDs (as used in the national registrar) of legal entities
legalEntityNames array(string) Names of legal entities linked to the asset
legalEntityRegions array(string) Countries where the legal entities are registered
linkedinExternalId string | null External ID for the asset on LinkedIn
logoFileId number(int) | null Only relevant for internal use.
logoFileUrl string | null Only relevant for internal use.
majorityOwnerId number(int) | null ID of the Investor that is the majority owner
majorityOwnerLogoFileUrl string | null Only relevant for internal use.
majorityOwnerName string | null Name of the majority owner
majorityStrategyId number(int) | null ID of the InvestorStrategy through which the majority investor invested in this company.
majorityStrategyName string | null Name of the InvestorStrategy through which the majority investor invested in this company.
managersLinkedInUrls array(string) LinkedIn URLs of asset managers associated with the asset
marketCapitalization number(float) | null Market capitalization, expressed in millions of the original currency
marketCapitalizationEur number(float) | null Market capitalization, expressed in millions of Euros
marketCapitalizationFiscalYear number(int) | null Fiscal year of the most recent financial report used for Market Capitalization.
marketCapitalizationFiscalYearQuarter number(int) | null Fiscal year quarter of the most recent financial report used for Market Capitalization.
motivation string | null Only relevant for internal use.
name string Name of the asset
netDebt number(float) | null Latest reported net debt in millions.
netDebtEbitdaRatio number(float) | null Ratio between net debt (i.e. net of cash) and EBITDA. Shows how many years it takes for a company to pay off its debt with EBITDA
netDebtEbitdaRatioYear number(int) | null Year of the reported net debt to EBITDA ratio
netDebtEur number(float) | null Net debt in Euros.
netDebtResults array(number(float)) All known net debt (debt less cash) results.
netDebtYear number(int) | null Year of latest net debt.
netDebtYears array(number(int)) Years corresponding to all known net debt results.
nextYearPredictedEv number(float) | null Predicted enterprise value for the next year
nextYearPredictedEvEur number(float) | null Predicted enterprise value for the next year in EUR
ownerIds array(number(int)) IDs of all owners
ownerLogoFileUrls array(string) Only relevant for internal use.
ownerNames array(string) Names of all owners
ownerShares array(string(AssetShareholderShare)) Type of stake held by each owner.
ownership string(AssetOwnershipType) | null() Type of company ownership.
ownershipIsVerified bool Ownership verification status.
payables number(float) | null Latest reported payables in millions.
payablesEur number(float) | null Payables in Euros.
payablesResults array(number(float)) All known payables results.
payablesYear number(int) | null Year of latest payables.
payablesYears array(number(int)) Years corresponding to all known payables results.
predictedExit bool Indicates if an investor exit is predicted
predictedExitEbitda number(float) | null Predicted EBITDA at the time of the investor's exit
predictedExitEbitdaEur number(float) | null Predicted EBITDA in EUR at the time of exit
predictedExitEv number(float) | null Predicted enterprise value at the time of exit
predictedExitEvEur number(float) | null Predicted enterprise value in EUR
predictedExitMultiple number(float) | null Predicted exit multiple
predictedExitYear number(int) | null Year in which the investor exit is predicted
previousExcelFileId number(int) | null Deprecated: Will be removed.
previousFactsheetFileId number(int) | null Only relevant for internal use.
previousFinancialsExcelFileId number(int) | null Only relevant for internal use.
pricePositioning string(AssetPricePositioningType) | null() Price positioning of the asset.
profileLive bool False if the asset profile is currently being updated.
profileType string(AssetProfileType) Type of asset profile. Automated asset profiles are fully generated by GenAI models.
pros array(string) Pros on investing on the asset
publishedAt string(rfc3339) | null Only relevant for internal use.
ratingBuyAndBuild number(float) | null Research team assessment based on the amount and importance of past M&A transactions
ratingContracted number(float) | null Research team assessment of revenue visibility based on the revenue generation model
ratingConversion number(float) | null Based on a 5-year average of (CAPEX-based) cash conversion, excluding one-offs, most notably covid-19
ratingEbitda number(float) | null Based on a 5-year (adjusted) EBITDA margin average, excluding one-offs, most notably covid-19
ratingGrossMargin number(float) | null Based on a 5-year average, excluding one-offs, most notably covid-19
ratingGrowth number(float) | null Based on a 5-year revenue CAGR, excluding one-offs, most notably covid-19
ratingLeader number(float) | null Research team assessment based on the competitive position factoring in geographic reach and competitive landscape
ratingMultinational number(float) | null Research team assessment based on % of revenue generated domestically vs. internationally
ratingNonCyclical number(float) | null Research team assessment of business cyclicality based on exposure to economic and business cycles
ratingOrganicGrowth number(float) | null Based on a 5-year revenue CAGR, excluding the reported or estimated revenue of acquired/divested companies
ratingOverall number(float) | null Average of all ratings
receivables number(float) | null Latest reported receivables in millions.
receivablesEur number(float) | null Receivables in Euros.
receivablesResults array(number(float)) All known receivables results.
receivablesYear number(int) | null Year of latest receivables.
receivablesYears array(number(int)) Years corresponding to all known receivables results.
region string | null ISO-2 country code for the headquarters of the asset. More frequently available than field headquarters_country_code
relevanceRank number(int) Only relevant for internal use.
returnOnAssets number(float) | null Ratio percentage between Net Income and Total Assets year average
returnOnAssetsYear number(int) | null Year of the reported Return on Assets
returnOnCapitalEmployed number(float) | null Ratio percentage between EBIT and Capital Employed year average
returnOnCapitalEmployedYear number(int) | null Year of the reported Return on Capital Employed
returnOnEquity number(float) | null Ratio percentage between Net Income and Total Equity year average
returnOnEquityYear number(int) | null Year of the reported Return on Equity
revenue number(float) | null Latest reported revenue in millions. Does not include AI-generated values.
revenueCagrPctThreeYears number(float) | null The compound annual growth rate (CAGR) of revenue over the past three years.
revenueCagrPctTwoYears number(float) | null The compound annual growth rate (CAGR) of revenue over the past two years.
revenueEur number(float) | null Same as Revenue, but converted to Euros.
revenueFteRatio number(int) | null Ratio between revenue and FTE
revenueFteRatioEur number(int) | null Revenue per FTE in EUR
revenueFteRatioYear number(int) | null Year of the reported revenue per FTE
revenueGrowthPctOneYear number(float) | null The percentage growth in revenue over one year.
revenueIsAiGenerated bool Indicator if revenue is AI-generated.
revenueResults array(number(float)) All known revenue results.
revenueWithAiGenerated number(float) | null Same as Revenue if it is not null, else may be an AI-generated value.
revenueWithAiGeneratedEur number(float) | null Same as RevenueWithAiGenerated, but converted to Euros.
revenueYear number(int) | null Year of latest revenue.
revenueYears array(number(int)) Years corresponding to all known revenue results.
salesChannel array(string(AssetSalesChannelType)) Sales channels used by the asset.
sector string | null Sector in which the asset operates, e.g. TMT
sharedValueProposition string | null Only relevant for internal use.
sources array(Source) Listed sources linked to the asset
strategyIds array(number(int)) IDs of the investor strategies associated with the asset
strategyNames array(string) Names of the investor strategies associated with the asset
subsector string | null Subsector in which the asset operates, e.g. Technology
subsidiaryAssetIds array(number(int)) Direct subsidiaries (child) of this asset
subsidiaryPath array(number(int)) | null Only relevant for internal use.
tagIds array(number(int)) Only relevant for internal use.
tags array(string) Keywords assigned to the company, such as its most important products and services.
totalAssets number(float) | null Latest reported total assets in millions.
totalAssetsEur number(float) | null Total assets in Euros.
totalAssetsResults array(number(float)) All known total assets results.
totalAssetsYear number(int) | null Year of latest total assets.
totalAssetsYears array(number(int)) Years corresponding to all known total assets results.
totalDealFundingRaisedEur number(float) | null The total funding raised across all deals in EUR millions
updatedAt string(rfc3339) | null Last update of the asset.
url string | null Website URL of the asset
valuationRatios array(AssetSummaryValuationRatio) Valuation ratios for different periods
viewOnValuation bool Deprecated. No longer actively maintained.
webUrl string | null Deprecated: Please use url
yearFounded number(int) | null Year the asset was founded
Description

Type reference

Type
AssetListedSecurity ⎯
Properties
Name Type Description
id number(int)
assetId number(int)
isPrimary bool
listedSecurityId number(int)
Description

Type reference

Type
AssetMarket ⎯
Properties
Name Type Description
assetId number(int) The unique identifier for the asset. Except Competition, fields in this object are no longer actively maintained.
cagr number(float) | null
cagrEnd number(int) | null
cagrMedian number(float) | null
cagrSource string | null
cagrStart number(int) | null
competition string Description of the asset's competitive position.
size string
trends string
Description

Type reference

Type
AssetNextDealPrediction ⎯
Properties
Name Type Description
assetId number(int)
viewOnValuation bool Deprecated. No longer actively maintained.
year number(int) Next year in which the asset's ownership will change, as estimated by Gain.pro's predictive model.
Description

Type reference

Type
AssetOwnershipCount ⎯
Properties
Name Type Description
count number(int)
type string(AssetOwnershipType)
Description

Type reference

Type
AssetPro ⎯
Properties
Name Type Description
id number(int)
assetId number(int)
order number(int)
text string Qualitative assessment of a key reason to invest in this company.
Description

Type reference

Type
AssetRating ⎯
Properties
Name Type Description
assetId number(int)
buyAndBuild number(float) | null Research team assessment based on the amount and importance of past M&A transactions
contracted number(float) | null Research team assessment of revenue visibility based on the revenue generation model
conversion number(float) | null Based on a 5-year average of (CAPEX-based) cash conversion, excluding one-offs, most notably covid-19
ebitda number(float) | null Based on a 5-year (adjusted) EBITDA margin average, excluding one-offs, most notably covid-19
grossMargin number(float) | null Based on a 5-year average, excluding one-offs, most notably covid-19
growth number(float) | null Based on a 5-year revenue CAGR, excluding one-offs, most notably covid-19
leader number(float) | null Research team assessment based on the competitive position factoring in geographic reach and competitive landscape
multinational number(float) | null Research team assessment based on % of revenue generated domestically vs. internationally
nonCyclical number(float) | null Research team assessment of business cyclicality based on exposure to economic and business cycles
organicGrowth number(float) | null Based on a 5-year revenue CAGR, excluding the reported or estimated revenue of acquired/divested companies
overall number(float) | null Overall assessment based on all criteria
Description

Type reference

Type
AssetSegment ⎯
Properties
Name Type Description
id number(int) The unique identifier for the asset segment.
assetSegmentationId number(int) The identifier linking this segment to its parent asset segmentation.
description string A detailed description of the asset segment, including its characteristics and main features.
order number(int)
subtitle string Additional context or information about the asset segment, e.g. a list of products or services of a business unit.
title string The title of the asset segment, e.g. the name of a business unit.
Description

Type reference

Type
AssetSegmentation ⎯
Properties
Name Type Description
assetId number(int) The unique identifier for the asset.
charts array(AssetChart) Key metrics for visualizing a segment's development, e.g. growth metrics of the revenue generated by a business unit.
segments array(AssetSegment) A list of segments associated with the asset, including details such as titles, descriptions, and divestment status.
subtitle string The subtitle providing additional information about the asset segmentation.
title string The title of the asset segmentation, e.g. 'Business Units' if the segmentation is a breakdown of the company's business units'.
Description

Type reference

Type
AssetShareholder ⎯
Properties
Name Type Description
id number(int)
assetId number(int)
fundConfidence string(InvestorFundConfidence) | null() Confidence level of the fund.
fundId number(int) | null Identifier for the InvestorFund object linked to this shareholder.
investorId number(int) Identifier for the Investor object linked to this shareholder.
isCurrentInvestor bool Whether this shareholder is the current investor.
order number(int)
share string(AssetShareholderShare) Type of stake held by the shareholder.
strategyId number(int) | null Identifier for the InvestorStrategy object linked to this shareholder.
Description

Type reference

Type
AssetSource ⎯
Properties
Name Type Description
id number(int)
assetId number(int)
background bool True if this source was used in determining the asset's ownership and deal history.
business bool True if this source was used in determining the asset's business model.
financials bool True if this source was used in determining the asset's financials.
language string | null
order number(int)
publicationMonth number(int) | null
publicationYear number(int) | null
publisher string | null
title string
url string | null URL where the source can be found.
Description

Type reference

Type
AssetSummary ⎯
Properties
Name Type Description
id number(int)
addOnDealCountL3Y number(int) | null The number of add-ons done by the company in the last 3 years
addOnDealCountL5Y number(int) | null The number of add-ons done by the company in the last 5 years
advisorIds array(number(int)) IDs of advisors associated with the asset
aliases array(string) Alternative names for the company.
assetLive bool True if the asset profile is actively maintained.
businessActivity array(string(AssetBusinessActivityType)) Business activities of the asset.
businessDescription string | null Complete overview of the asset's business activities', with an emphasis on business model and key details.
capex number(float) | null Latest reported capital expenditure in millions.
capexEur number(float) | null Capital expenditure in Euros.
capexResults array(number(float)) All known capital expenditures (Capex) results.
capexYear number(int) | null Year of latest capital expenditure.
capexYears array(number(int)) Years corresponding to all known capital expenditures (Capex) results.
capital number(float) | null Latest reported capital in millions.
capitalEur number(float) | null Capital in Euros.
capitalResults array(number(float)) All known net working capital (inventory + receivables - payables) results.
capitalYear number(int) | null Year of latest capital.
capitalYears array(number(int)) Years corresponding to all known capital results.
cash number(float) | null Latest reported cash in millions.
cashConversionCycle number(float) | null Latest reported cash conversion cycle.
cashConversionCycleResults array(number(float)) All known cash conversion cycle results.
cashConversionCycleYear number(int) | null Year of latest cash conversion cycle.
cashConversionCycleYears array(number(int)) Years corresponding to all known cash conversion cycle results.
cashEur number(float) | null Cash in Euros.
cashResults array(number(float)) All known cash results.
cashYear number(int) | null Year of latest cash.
cashYears array(number(int)) Years corresponding to all known cash results.
ceoAge number(int) | null Age of the CEO
ceoName string | null Name of the CEO
ceoTenure number(int) | null Duration of the CEO in years
competitorAssetIds array(number(int)) asset competitors
cons array(string) Cons on investing on the asset
consolidatedNetIncome number(float) | null Latest reported consolidated net income in millions.
consolidatedNetIncomeEur number(float) | null Consolidated net income in Euros.
consolidatedNetIncomeResults array(number(float)) All known consolidated net income results.
consolidatedNetIncomeYear number(int) | null Year of latest consolidated net income.
consolidatedNetIncomeYears array(number(int)) Years corresponding to all known consolidated net income results.
currency string | null Currency in which the asset's financials are reported
currencyToEur number(float) | null Conversion rate from the asset's currency to EUR. These are updated monthly.
customerBase array(string(AssetCustomerBaseType)) Customer base types of the asset.
debt number(float) | null Latest reported debt in millions.
debtEur number(float) | null Debt in Euros.
debtResults array(number(float)) All known interest-bearing debt results.
debtYear number(int) | null Year of latest debt.
debtYears array(number(int)) Years corresponding to all known debt results.
description string | null Brief description (tagline) of the asset's main activity.
domain string | null Deprecated: Will be removed
earningsPerShare number(float) | null Latest reported earnings per share.
earningsPerShareEur number(float) | null Earnings per share in Euros.
earningsPerShareResults array(number(float)) All known earnings per share (EPS) results.
earningsPerShareYear number(int) | null Year of latest earnings per share.
earningsPerShareYears array(number(int)) Years corresponding to all known earnings per share (EPS) results.
ebit number(float) | null Latest reported EBIT in millions.
ebitCagrPctThreeYears number(float) | null The compound annual growth rate (CAGR) of EBIT over the past three years.
ebitCagrPctTwoYears number(float) | null The compound annual growth rate (CAGR) of EBIT over the past two years.
ebitEur number(float) | null EBIT in Euros.
ebitGrowthPctOneYear number(float) | null The percentage growth in EBIT over one year.
ebitPctRevenue number(float) | null EBIT as % of revenue in latest year.
ebitPctRevenueResults array(number(float)) All EBIT as percentage of revenue results.
ebitPctRevenueYears array(number(int)) Years of all EBIT as percentage of revenue results.
ebitResults array(number(float)) All known EBIT results.
ebitYear number(int) | null Year of latest EBIT.
ebitYears array(number(int)) Years corresponding to all known EBIT results.
ebitda number(float) | null Latest reported EBITDA in millions.
ebitdaCagrPctThreeYears number(float) | null The compound annual growth rate (CAGR) of EBITDA over the past three years.
ebitdaCagrPctTwoYears number(float) | null The compound annual growth rate (CAGR) of EBITDA over the past two years.
ebitdaEur number(float) | null EBITDA in Euros.
ebitdaGrowthPctOneYear number(float) | null The percentage growth in EBITDA over one year.
ebitdaIsAiGenerated bool Indicator if revenue is AI-generated.
ebitdaMinusCapex number(float) | null EBITDA less capital expenditures. Approximation of Free Cash Flow after all operating expenses and investments
ebitdaMinusCapexEur number(float) | null EBITDA minus Capex in EUR
ebitdaMinusCapexYear number(int) | null Year of the reported EBITDA minus Capex
ebitdaPctRevenue number(float) | null Latest reported EBITDA margin, as a percentage of revenue.
ebitdaPctRevenueResults array(number(float)) All EBITDA as percentage of revenue results.
ebitdaPctRevenueWithAiGenerated number(float) | null EbitdaPctRevenue if it is not null, else may be an AI-generated value.
ebitdaPctRevenueYears array(number(int)) Years of all EBITDA as percentage of revenue results.
ebitdaResults array(number(float)) All known EBITDA results.
ebitdaWithAiGenerated number(float) | null Same as Ebitda if it is not null, else may be an AI-generated value.
ebitdaWithAiGeneratedEur number(float) | null Same as RevenueWithAiGenerated, but converted to Euros.
ebitdaYear number(int) | null Year of latest EBITDA.
ebitdaYears array(number(int)) Years corresponding to all known EBITDA results.
enterpriseValue number(float) | null Enterprise value, derived from market capitalization and reported financials. Expressed in millions of the original currency.
enterpriseValueEbitRatio number(float) | null Ratio of Enterprise Value to Ebit as of the most recent financial report date.
enterpriseValueEbitRatioCurrentFiscalYear number(float) | null Ratio of the current Enterprise value to Current Fiscal Year forecasted Ebit
enterpriseValueEbitRatioFiscalYear number(int) | null Fiscal year of the most recent financial report used for Enterprise Value Ebitda ratio.
enterpriseValueEbitRatioFiscalYearQuarter number(int) | null Fiscal year quarter of the most recent financial report used for Enterprise Value Ebitda ratio.
enterpriseValueEbitRatioLastFiscalYear number(float) | null Ratio of the current Enterprise value to last fiscal year Ebit
enterpriseValueEbitRatioLastTwelveMonths number(float) | null Ratio of the current Enterprise value to Last Twelve Months Ebit
enterpriseValueEbitRatioNextFiscalYear number(float) | null Ratio of the current Enterprise value to Next Fiscal Year forecasted Ebit
enterpriseValueEbitRatioNextTwelveMonths number(float) | null Ratio of the current Enterprise value to Next Twelve Months Ebit
enterpriseValueEbitdaMinusCapexRatio number(float) | null Ratio of Enterprise Value to Ebitda minus Capex as of the most recent financial report date.
enterpriseValueEbitdaMinusCapexRatioFiscalYear number(int) | null Fiscal year of the most recent financial report used for Enterprise Value Ebitda minus Capex ratio.
enterpriseValueEbitdaMinusCapexRatioFiscalYearQuarter number(int) | null Fiscal year quarter of the most recent financial report used for Enterprise Value Ebitda minus Capex ratio.
enterpriseValueEbitdaRatio number(float) | null Ratio of Enterprise Value to Ebitda as of the most recent financial report date.
enterpriseValueEbitdaRatioCurrentFiscalYear number(float) | null Ratio of the current Enterprise value to Current Fiscal Year forecasted Ebitda
enterpriseValueEbitdaRatioFiscalYear number(int) | null Fiscal year of the most recent financial report used for Enterprise Value Ebitda ratio.
enterpriseValueEbitdaRatioFiscalYearQuarter number(int) | null Fiscal year quarter of the most recent financial report used for Enterprise Value Ebitda ratio.
enterpriseValueEbitdaRatioLastFiscalYear number(float) | null Ratio of the current Enterprise value to last fiscal year Ebitda
enterpriseValueEbitdaRatioLastTwelveMonths number(float) | null Ratio of the current Enterprise value to Last Twelve Months Ebitda
enterpriseValueEbitdaRatioNextFiscalYear number(float) | null Ratio of the current Enterprise value to Next Fiscal Year forecasted Ebitda
enterpriseValueEbitdaRatioNextTwelveMonths number(float) | null Ratio of the current Enterprise value to Next Twelve Months Ebitda
enterpriseValueEur number(float) | null Enterprise value, derived from market capitalization and reported financials. Expressed in millions of Euros.
enterpriseValueFiscalYear number(int) | null Fiscal year of the most recent financial report used for Enterprise Value.
enterpriseValueFiscalYearQuarter number(int) | null Fiscal year quarter of the most recent financial report used for Enterprise Value
enterpriseValueFreeCashFlowRatio number(float) | null Ratio of Enterprise Value to Free Cash Flow as of the most recent financial report date.
enterpriseValueFreeCashFlowRatioFiscalYear number(int) | null Fiscal year of the most recent financial report used for Enterprise Value Free Cash Flow ratio.
enterpriseValueFreeCashFlowRatioFiscalYearQuarter number(int) | null Fiscal year quarter of the most recent financial report used for Enterprise Value Free Cash Flow ratio.
enterpriseValueInvestedCapitalRatio number(float) | null Ratio of Enterprise Value to Invested Capital as of the most recent financial report date.
enterpriseValueInvestedCapitalRatioFiscalYear number(int) | null Fiscal year of the most recent financial report used for Enterprise Value Invested Capital ratio.
enterpriseValueInvestedCapitalRatioFiscalYearQuarter number(int) | null Fiscal year quarter of the most recent financial report used for Enterprise Value Invested Capital ratio.
enterpriseValueRevenueRatio number(float) | null Ratio of Enterprise value to Revenue as of the most recent financial report date.
enterpriseValueRevenueRatioCurrentFiscalYear number(float) | null Ratio of the current Enterprise value to Current Fiscal Year forecasted Revenue
enterpriseValueRevenueRatioFiscalYear number(int) | null Fiscal year of the most recent financial report used for Enterprise Value Revenue ratio.
enterpriseValueRevenueRatioFiscalYearQuarter number(int) | null Fiscal year quarter of the most recent financial report used for Enterprise Value Revenue ratio.
enterpriseValueRevenueRatioLastFiscalYear number(float) | null Ratio of the current Enterprise value to last fiscal year Revenue
enterpriseValueRevenueRatioLastTwelveMonths number(float) | null Ratio of the current Enterprise value to Last Twelve Months Revenue
enterpriseValueRevenueRatioNextFiscalYear number(float) | null Ratio of the current Enterprise value to Next Fiscal Year forecasted Revenue
enterpriseValueRevenueRatioNextTwelveMonths number(float) | null Ratio of the current Enterprise value to Next Twelve Months Revenue
esg string | null Environmental, Social, and Governance (ESG) information.
esgOutperformer bool Indicates if the asset is an ESG outperformer compared to its industry peers
financialNotes array(string) Financial foot notes
financialResults array(AssetSummaryFinancialResult) All historical financial results.
financialsAt string(rfc3339) | null Last date when the asset's financial results were updated.
freeCashFlow number(float) | null Latest reported free cash flow in millions.
freeCashFlowEur number(float) | null Free cash flow in Euros.
freeCashFlowResults array(number(float)) All known free cash flow (FCF) results.
freeCashFlowYear number(int) | null Year of latest free cash flow.
freeCashFlowYears array(number(int)) Years corresponding to all known free cash flow (FCF) results.
fte number(float) | null Latest available measurement of full-time equivalent (FTE) employees.
fteCagrPctThreeYears number(float) | null The compound annual growth rate (CAGR) of full-time equivalent employees (FTE) over the past three years.
fteCagrPctTwoYears number(float) | null The compound annual growth rate (CAGR) of full-time equivalent employees (FTE) over the past two years.
fteGrowthPctOneYear number(float) | null The percentage growth in full-time equivalent employees (FTE) over one year.
fteGrowthPctSixMonths number(float) | null The percentage growth in full-time equivalent employees (FTE) over six months.
fteGrowthPctThreeMonths number(float) | null The percentage growth in full-time equivalent employees (FTE) over three months.
fteRange string | null Employee size range as reported by the company. Note that this field is self-reported by the company and need not correspond to the Fte measurement.
fteRangeCategory number(int) | null Numerical representation of employee size ranges (e.g. 3 for '11-50') for easier filtering.
fteResults array(number(float)) All known full-time equivalent (FTE) employee results.
fteYear number(int) | null Year of the latest available measurement of full-time equivalent (FTE) employees.
fteYears array(number(int)) Years corresponding to all known full-time equivalent (FTE) employee results.
fundIds array(number(int)) IDs of the investor fund associated with the asset
fundNames array(string) Names of the investor fund associated with the asset
gainProUrl string The URL to the asset's page on Gain.pro.
grossMargin number(float) | null Latest reported gross margin in millions.
grossMarginCagrPctThreeYears number(float) | null The compound annual growth rate (CAGR) of gross margin over the past three years.
grossMarginCagrPctTwoYears number(float) | null The compound annual growth rate (CAGR) of gross margin over the past two years.
grossMarginEur number(float) | null Gross Margin in Euros.
grossMarginGrowthPctOneYear number(float) | null The percentage growth in gross margin over one year.
grossMarginPctRevenue number(float) | null Gross Margin as % of revenue in latest year.
grossMarginPctRevenueResults array(number(float)) All gross margin as percentage of revenue results.
grossMarginPctRevenueYears array(number(int)) Years of all gross margin as percentage of revenue results.
grossMarginResults array(number(float)) All known gross margin results.
grossMarginYear number(int) | null Year of latest gross margin.
grossMarginYears array(number(int)) Years corresponding to all known gross margin results.
growthMetrics array(GrowthMetric) Growth metrics for different periods
headquartersCity string | null City of the headquarters
headquartersCountryCode string | null ISO-2 country code for the headquarters. Slightly more accurate, but less frequently available than field region
headquartersFormattedAddress string | null Formatted address of the headquarters
headquartersRegion string | null Region (e.g. state or province) of the headquarters
headquartersWgs84LngLat Point | null Geographical coordinates of the headquarters in WGS84 format
inventory number(float) | null Latest reported inventory in millions.
inventoryEur number(float) | null Inventory in Euros.
inventoryResults array(number(float)) All known inventory results.
inventoryYear number(int) | null Year of latest inventory.
inventoryYears array(number(int)) Years corresponding to all known inventory results.
investors array(AssetSummaryInvestor) Investors that have a stake in the asset
lastDealMonth number(int) | null Month of the last platform involving the asset, in which the asset's ownership changed meaningfully. May differ from the last deal involving the asset
lastDealYear number(int) | null Year of the last platform involving the asset, in which the asset's ownership changed meaningfully. May differ from the last deal involving the asset
latestDealPostMoneyValuationEur number(float) | null The post-money valuation in EUR of the most recent deal
latestDealPostMoneyValuationYear number(int) | null The year of the post-money valuation of the most recent deal
latestDealPreMoneyValuationEur number(float) | null The pre-money valuation in EUR of the most recent deal
latestDealPreMoneyValuationYear number(int) | null The year of the pre-money valuation of the most recent deal
latestDealRoundSizeEur number(float) | null The size of the most recent funding round involving the asset, measured in EUR millions
latestDealRoundType string(DealFundingRoundType) | null() Type of the latest funding round involving the asset, such as Seed, Series B, Venture, etc.
latestDealRoundYear number(int) | null The year of the most recent funding round involving the asset
latestIndustryRatingEnvironmental number(float) | null Environmental risk rating of the latest industry report that includes the asset
latestIndustryRatingOverall number(float) | null Overall ESG rating of the latest industry report that includes the asset
latestIndustryRatingSocial number(float) | null Social risk rating of the latest industry report that includes the asset
legalEntities array(AssetSummaryLegalEntity) Legal entities linked to the asset
legalEntityExternalIds array(string) External IDs (as used in the national registrar) of legal entities
legalEntityNames array(string) Names of legal entities linked to the asset
legalEntityRegions array(string) Countries where the legal entities are registered
linkedinExternalId string | null External ID for the asset on LinkedIn
logoFileId number(int) | null Only relevant for internal use.
logoFileUrl string | null Only relevant for internal use.
majorityOwnerId number(int) | null ID of the Investor that is the majority owner
majorityOwnerLogoFileUrl string | null Only relevant for internal use.
majorityOwnerName string | null Name of the majority owner
majorityStrategyId number(int) | null ID of the InvestorStrategy through which the majority investor invested in this company.
majorityStrategyName string | null Name of the InvestorStrategy through which the majority investor invested in this company.
managersLinkedInUrls array(string) LinkedIn URLs of asset managers associated with the asset
marketCapitalization number(float) | null Market capitalization, expressed in millions of the original currency
marketCapitalizationEur number(float) | null Market capitalization, expressed in millions of Euros
marketCapitalizationFiscalYear number(int) | null Fiscal year of the most recent financial report used for Market Capitalization.
marketCapitalizationFiscalYearQuarter number(int) | null Fiscal year quarter of the most recent financial report used for Market Capitalization.
name string Name of the asset
netDebt number(float) | null Latest reported net debt in millions.
netDebtEbitdaRatio number(float) | null Ratio between net debt (i.e. net of cash) and EBITDA. Shows how many years it takes for a company to pay off its debt with EBITDA
netDebtEbitdaRatioYear number(int) | null Year of the reported net debt to EBITDA ratio
netDebtEur number(float) | null Net debt in Euros.
netDebtResults array(number(float)) All known net debt (debt less cash) results.
netDebtYear number(int) | null Year of latest net debt.
netDebtYears array(number(int)) Years corresponding to all known net debt results.
nextYearPredictedEv number(float) | null Predicted enterprise value for the next year
nextYearPredictedEvEur number(float) | null Predicted enterprise value for the next year in EUR
ownerIds array(number(int)) IDs of all owners
ownerLogoFileUrls array(string) Only relevant for internal use.
ownerNames array(string) Names of all owners
ownerShares array(string(AssetShareholderShare)) Type of stake held by each owner.
ownership string(AssetOwnershipType) | null() Type of company ownership.
ownershipIsVerified bool Ownership verification status.
payables number(float) | null Latest reported payables in millions.
payablesEur number(float) | null Payables in Euros.
payablesResults array(number(float)) All known payables results.
payablesYear number(int) | null Year of latest payables.
payablesYears array(number(int)) Years corresponding to all known payables results.
predictedExit bool Indicates if an investor exit is predicted
predictedExitEbitda number(float) | null Predicted EBITDA at the time of the investor's exit
predictedExitEbitdaEur number(float) | null Predicted EBITDA in EUR at the time of exit
predictedExitEv number(float) | null Predicted enterprise value at the time of exit
predictedExitEvEur number(float) | null Predicted enterprise value in EUR
predictedExitMultiple number(float) | null Predicted exit multiple
predictedExitYear number(int) | null Year in which the investor exit is predicted
previousExcelFileId number(int) | null Deprecated: Will be removed.
previousFactsheetFileId number(int) | null Only relevant for internal use.
previousFinancialsExcelFileId number(int) | null Only relevant for internal use.
pricePositioning string(AssetPricePositioningType) | null() Price positioning of the asset.
profileLive bool False if the asset profile is currently being updated.
profileType string(AssetProfileType) Type of asset profile. Automated asset profiles are fully generated by GenAI models.
pros array(string) Pros on investing on the asset
publishedAt string(rfc3339) | null Only relevant for internal use.
ratingBuyAndBuild number(float) | null Research team assessment based on the amount and importance of past M&A transactions
ratingContracted number(float) | null Research team assessment of revenue visibility based on the revenue generation model
ratingConversion number(float) | null Based on a 5-year average of (CAPEX-based) cash conversion, excluding one-offs, most notably covid-19
ratingEbitda number(float) | null Based on a 5-year (adjusted) EBITDA margin average, excluding one-offs, most notably covid-19
ratingGrossMargin number(float) | null Based on a 5-year average, excluding one-offs, most notably covid-19
ratingGrowth number(float) | null Based on a 5-year revenue CAGR, excluding one-offs, most notably covid-19
ratingLeader number(float) | null Research team assessment based on the competitive position factoring in geographic reach and competitive landscape
ratingMultinational number(float) | null Research team assessment based on % of revenue generated domestically vs. internationally
ratingNonCyclical number(float) | null Research team assessment of business cyclicality based on exposure to economic and business cycles
ratingOrganicGrowth number(float) | null Based on a 5-year revenue CAGR, excluding the reported or estimated revenue of acquired/divested companies
ratingOverall number(float) | null Average of all ratings
receivables number(float) | null Latest reported receivables in millions.
receivablesEur number(float) | null Receivables in Euros.
receivablesResults array(number(float)) All known receivables results.
receivablesYear number(int) | null Year of latest receivables.
receivablesYears array(number(int)) Years corresponding to all known receivables results.
region string | null ISO-2 country code for the headquarters of the asset. More frequently available than field headquarters_country_code
returnOnAssets number(float) | null Ratio percentage between Net Income and Total Assets year average
returnOnAssetsYear number(int) | null Year of the reported Return on Assets
returnOnCapitalEmployed number(float) | null Ratio percentage between EBIT and Capital Employed year average
returnOnCapitalEmployedYear number(int) | null Year of the reported Return on Capital Employed
returnOnEquity number(float) | null Ratio percentage between Net Income and Total Equity year average
returnOnEquityYear number(int) | null Year of the reported Return on Equity
revenue number(float) | null Latest reported revenue in millions. Does not include AI-generated values.
revenueCagrPctThreeYears number(float) | null The compound annual growth rate (CAGR) of revenue over the past three years.
revenueCagrPctTwoYears number(float) | null The compound annual growth rate (CAGR) of revenue over the past two years.
revenueEur number(float) | null Same as Revenue, but converted to Euros.
revenueFteRatio number(int) | null Ratio between revenue and FTE
revenueFteRatioEur number(int) | null Revenue per FTE in EUR
revenueFteRatioYear number(int) | null Year of the reported revenue per FTE
revenueGrowthPctOneYear number(float) | null The percentage growth in revenue over one year.
revenueIsAiGenerated bool Indicator if revenue is AI-generated.
revenueResults array(number(float)) All known revenue results.
revenueWithAiGenerated number(float) | null Same as Revenue if it is not null, else may be an AI-generated value.
revenueWithAiGeneratedEur number(float) | null Same as RevenueWithAiGenerated, but converted to Euros.
revenueYear number(int) | null Year of latest revenue.
revenueYears array(number(int)) Years corresponding to all known revenue results.
salesChannel array(string(AssetSalesChannelType)) Sales channels used by the asset.
sector string | null Sector in which the asset operates, e.g. TMT
sources array(Source) Listed sources linked to the asset
strategyIds array(number(int)) IDs of the investor strategies associated with the asset
strategyNames array(string) Names of the investor strategies associated with the asset
subsector string | null Subsector in which the asset operates, e.g. Technology
subsidiaryAssetIds array(number(int)) Direct subsidiaries (child) of this asset
subsidiaryPath array(number(int)) | null Only relevant for internal use.
tagIds array(number(int)) Only relevant for internal use.
tags array(string) Keywords assigned to the company, such as its most important products and services.
totalAssets number(float) | null Latest reported total assets in millions.
totalAssetsEur number(float) | null Total assets in Euros.
totalAssetsResults array(number(float)) All known total assets results.
totalAssetsYear number(int) | null Year of latest total assets.
totalAssetsYears array(number(int)) Years corresponding to all known total assets results.
totalDealFundingRaisedEur number(float) | null The total funding raised across all deals in EUR millions
updatedAt string(rfc3339) | null Last update of the asset.
url string | null Website URL of the asset
valuationRatios array(AssetSummaryValuationRatio) Valuation ratios for different periods
viewOnValuation bool Deprecated. No longer actively maintained.
webUrl string | null Deprecated: Please use url
yearFounded number(int) | null Year the asset was founded
Description

Type reference

Type
AssetSummaryFinancialResult ⎯
Properties
Name Type Description
capex number(float) | null Reported capital expenditure in millions.
capexType string | null Source type for Capex.
capital number(float) | null Reported capital in millions.
capitalType string | null Source type for Capital.
cash number(float) | null Reported cash in millions.
cashConversionCycle number(float) | null Reported cash conversion cycle.
cashConversionCycleType string | null Source type for Cash Conversion Cycle.
cashType string | null Source type for Cash.
consolidatedNetIncome number(float) | null Reported consolidated net income in millions.
consolidatedNetIncomeType string | null Source type for Consolidated Net Income.
debt number(float) | null Reported debt in millions.
debtType string | null Source type for Debt.
earningsPerShare number(float) | null Reported earnings per share.
earningsPerShareType string | null Source type for Earnings Per Share.
ebit number(float) | null Reported EBIT in millions.
ebitType string | null Source type for EBIT.
ebitda number(float) | null Reported EBITDA in millions.
ebitdaType string | null Source type for EBITDA.
freeCashFlow number(float) | null Reported free cash flow in millions.
freeCashFlowType string | null Source type for Free Cash Flow.
fte number(float) | null Full-time equivalent (FTE) employees as reported in company filings.
fteType string | null Source type for FTE.
grossMargin number(float) | null Reported gross margin in millions.
grossMarginType string | null Source type for Gross Margin.
inventory number(float) | null Reported inventory in millions.
inventoryType string | null Source type for Inventory.
isForecast bool True if these are future forecasts. Only applies to listed companies.
netDebt number(float) | null Reported net debt in millions.
netDebtType string | null Source type for Net Debt.
payables number(float) | null Reported payables in millions.
payablesType string | null Source type for Payables.
periodicity string(FinancialResultPeriodicityType) Time period that the figures span.
receivables number(float) | null Reported receivables in millions.
receivablesType string | null Source type for Receivables.
revenue number(float) | null Reported revenue in millions.
revenueType string | null Source type for Revenue.
totalAssets number(float) | null Reported total assets in millions.
totalAssetsType string | null Source type for Total Assets.
year number(int) Year of the financial result.
Description

Type reference

Type
AssetSummaryInvestor ⎯
Properties
Name Type Description
id number(int)
fundId number(int) | null ID of the investor fund through which the investor invested in this company.
fundName string | null Name of the investor fund through which the investor invested in this company.
name string Name of the investor
share string(AssetShareholderShare) Type of stake held by the investor.
strategyId number(int) | null ID of the investor strategy through which the investor invested in this company.
strategyName string | null Name of the investor strategy through which the investor invested in this company.
Description

Type reference

Type
AssetSummaryLegalEntity ⎯
Properties
Name Type Description
externalId string External IDs (as used in the national registrar) of legal entities
latestBookYearEnd string(rfc3339) | null Closing date of the legal entity's latest annual report
name string Name of the legal entity
region string Country where the legal entity is registered
Description

Type reference

Type
AssetSummaryValuationRatio ⎯
Properties
Name Type Description
enterpriseValueEbitRatio number(float) | null Enterprise value to EBIT ratio.
enterpriseValueEbitdaMinusCapexRatio number(float) | null Enterprise Value EBITDA minus Capex ratio.
enterpriseValueEbitdaRatio number(float) | null Enterprise value to EBITDA ratio.
enterpriseValueFreeCashFlowRatio number(float) | null Enterprise Value to Free Cash Flow ratio.
enterpriseValueInvestedCapitalRatio number(float) | null Enterprise Value to Invested Capital ratio.
enterpriseValueRevenueRatio number(float) | null Enterprise value to Revenue ratio.
period string(AssetSummaryValuationPeriod) The period for which the valuation ratios are calculated.
Description

Type reference

Type
AssetTag ⎯
Properties
Name Type Description
id number(int)
assetId number(int)
tag string The keyword assigned to the asset.
tagId number(int) Identifier of the Tag object.
Description

Type reference

Type
AssociatedTag ⎯
Properties
Name Type Description
id number(int)
assetCount number(int)
name string
Description

Type reference

Type
BeamerPost ⎯
Properties
Name Type Description
id number(int)
autoOpen bool
boostedAnnouncement string
category string
date string
dueDate string
editionDate string
feedbackEnabled bool
filter string
filterUrl string
pinned bool
published bool
reactionsEnabled bool
showInStandalone bool
showInWidget bool
translations array(beamerTranslation)
Description

Type reference

Type
BookmarkAssetRatings ⎯
Properties
Name Type Description
buyAndBuild number(float) | null
contracted number(float) | null
conversion number(float) | null
ebitda number(float) | null
environmental number(float) | null
grossMargin number(float) | null
growth number(float) | null
leader number(float) | null
multinational number(float) | null
nonCyclical number(float) | null
organicGrowth number(float) | null
overall number(float) | null
social number(float) | null
Description

Type reference

Type
BookmarkList ⎯
Properties
Name Type Description
id number(int)
createdAt string(rfc3339)
currency string
exchangeRate number(float)
filters array(Filter)
search string | null
title string
type string(BookmarkListType)
updatedAt string(rfc3339)
Description

Type reference

Type
BookmarkListItem ⎯
Properties
Name Type Description
id number(int)
createdAt string(rfc3339)
currency string
exchangeRate number(float)
excludedObjectIds array(number(int))
filters array(Filter)
includedObjectIds array(number(int))
lastViewedAt string(rfc3339) | null
search string | null
title string
totalCount number(int)
type string(BookmarkListType)
updatedAt string(rfc3339)
updatedCount number(int) Number of items with new financials since last visit
userCount number(int)
Description

Type reference

Type
BookmarkListList ⎯
Properties
Name Type Description
args ListArgs
counts ListCounts
items array(BookmarkListItem)
Description

Type reference

Type
ConferenceEditionExhibitorSummary ⎯
Properties
Name Type Description
advisorId number(int) | null ID of the advisor exhibiting at the conference. If null, no matching gain.pro advisor was found for the exhibitor's URL.
assetId number(int) | null ID of the company exhibiting at the conference. If null, no matching gain.pro asset was found for the exhibitor's URL.
investorId number(int) | null ID of the investor exhibiting at the conference. If null, no matching gain.pro investor was found for the exhibitor's URL.
name string Name of the company that is exhibiting at the conference.
url string | null The URL to the company's website.
Description

Type reference

Type
ConferenceEditionList ⎯
Properties
Name Type Description
args ListArgs
counts ListCounts
items array(ConferenceEditionListItem)
Description

Type reference

Type
ConferenceEditionListItem ⎯
Properties
Name Type Description
id number(int) The unique identifier for the conference edition.
conferenceId number(int) | null
domain string | null The domain of the URL to the conference's website.
endDate string(rfc3339) The end date of the conference edition.
exhibitorAdvisorIds array(number(int))
exhibitorAssetIds array(number(int))
exhibitorInvestorIds array(number(int))
exhibitorTagAssetCount array(number(int))
exhibitorTagIds array(number(int))
exhibitorTagRatios array(number(float))
exhibitorTags array(string) The tags that are most common among assets linked to the conference edition.
exhibitors array(ConferenceEditionExhibitorSummary) The companies that are exhibiting at the conference.
exhibitorsCount number(int)
exhibitorsLinkedAdvisorsCount number(int)
exhibitorsLinkedAssetsCount number(int)
exhibitorsLinkedCount number(int)
exhibitorsLinkedInvestorsCount number(int)
exhibitorsScrapedAt string(rfc3339) | null
gainProUrl string The URL to the conference's page on Gain.pro.
live bool
logoFileId number(int) | null
logoFileUrl string | null
name string The name of the conference edition.
startDate string(rfc3339) The start date of the conference edition.
updatedAt string(rfc3339) Timestamp when the conference edition was last updated.
url string | null The URL to the conference's website.
venueCity string The city of the conference venue.
venueCountryCode string The country code of the conference venue.
venueFormattedAddress string The formatted address of the conference venue.
venueRegion string | null The region or state of the conference venue.
venueWgs84LngLat Point | null
webUrl string | null Deprecated: use url instead.
Description

Type reference

Type
ConferenceList ⎯
Properties
Name Type Description
args ListArgs
counts ListCounts
items array(ConferenceListItem)
Description

Type reference

Type
ConferenceListItem ⎯
Properties
Name Type Description
id number(int)
name string
Description

Type reference

Type
CreditList ⎯
Properties
Name Type Description
args ListArgs
counts ListCounts
items array(CreditListItem)
Description

Type reference

Type
CreditListItem ⎯
Properties
Name Type Description
id number(int)
assetDescription string | null Brief description (tagline) of the target asset's main activity.
assetEbitdaEur number(float) | null Ebitda of the associated company in EUR.
assetEbitdaWithAiGeneratedEur number(float) | null Ebitda of the associated company in EUR with AI-generated data.
assetHqCity string | null The city of the target asset.
assetHqCountryCode string | null ISO-2 country code for the headquarters of the target asset
assetId number(int) | null Id of the target asset.
assetLogoFileUrl string | null Only relevant for internal use.
assetName string | null Name of the target asset.
assetSector string | null Sector in which the target asset operates, e.g. TMT.
assetSubsector string | null Subsector in which the target asset operates, e.g. Technology.
assetTagIds array(number(int)) Only relevant for internal use.
assetTags array(string) Keywords assigned to the target asset, such as its most important products and services.
assetUrl string | null URL of the asset.
couponBps number(float) | null Coupon
dealBuyerInvestorIds array(number(int)) Deal buyer investors IDs of the target deal
dealId number(int) | null Deal ID of the target deal
debtQuantum number(float) | null Debt quantum
debtQuantumCurrency string | null Currency of the reported debt quantum.
debtQuantumCurrencyToEur number(float) | null Currency to Euro conversion rate.
debtQuantumEur number(float) | null Debt quantum in EUR
gainProUrl string The URL to the asset's page on Gain.pro.
isMatured bool True if the credit has matured. Derived from isCurrent and maturedAt.
issuedAt string(rfc3339) | null Date the credit was issued.
issuedAtIsEstimate bool True if the issuedAt date is an estimate.
lenderIds array(number(int)) IDs of linked lenders.
lenderNames array(string) Only relevant for internal use.
lenders array(LinkedLender) Lenders of the credit.
live bool
majorityInvestor string | null Majority investor name.
majorityInvestorId number(int) | null Majority investor id.
maturedAt string(rfc3339) | null Date the credit matures.
minorityInvestorIds array(number(int)) Minority investor ids.
minorityInvestors array(string) Minority investor names.
publishedAt string(rfc3339)
referenceRate string(CreditReferenceRate) | null() Reference rate of the credit.
sources array(Source) Sources for this credit.
subtype string(CreditSubtype) | null() Sub type of credit.
type string(CreditType) Type of credit.
typeAndSubtype string Concatenation of type and subtype, used for filtering.
Description

Type reference

Type
CurrencyList ⎯
Properties
Name Type Description
args ListArgs
counts ListCounts
items array(CurrencyListItem)
Description

Type reference

Type
CurrencyListItem ⎯
Properties
Name Type Description
id number(int)
allowUserSelect bool
display string(CurrencyDisplayType)
name string
symbol string
title string
toEur number(float)
updatedAt string(rfc3339) | null
Description

Type reference

Type
CustomBenchmarkingRank ⎯
Properties
Name Type Description
assetId number(int)
rank number(int)
type string
Description

Type reference

Type
CustomFieldDefinition ⎯
Properties
Name Type Description
id number(int)
createdAt string(rfc3339)
customerId number(int)
displayName string
externalId string | null
options CustomFieldOptions | null
order number(int)
source string(CustomFieldSource)
type string(CustomFieldType)
updatedAt string(rfc3339)
Description

Type reference

Type
CustomFieldOptions ⎯
Properties
Name Type Description
options array(string)
optionsAutoUpdate bool
readonly bool
Description

Type reference

Type
Date ⎯
Properties
Name Type Description
day number(int) | null
month number(int) | null
year number(int)
Description

Type reference

Type
Deal ⎯
Properties
Name Type Description
id number(int) Unique identifier for the deal.
advisors array(DealAdvisor) List of advisors involved in the deal, including details such as role, advised party, and advisor ID.
announcementDate Date | null Date when the deal was announced.
asset string | null Name of the target asset involved in the deal.
bidders array(DealBidder) List of bidders involved in the deal, including details such as name, region, and share.
businessActivities string | null Description of the business activities of the target asset.
buyers array(DealBidder) Deprecated: no longer maintained. Use Bidders instead.
countryCode string | null ISO-2 code indicating the HQ country of the target asset.
currency string | null Currency of the deal facts.
dealStatus string(DealStatus) Status of the deal's progress, if it has not (yet) been completed.
dealType string(DealType) | null() Type of the deal, if it was automatically sourced from third parties. Nil if the deal object was sourced internally.
dealroomFundingId number(int) | null External identifier for the funding round if the deal was sourced from Dealroom.co.
division string | null Division of the target asset involved in the deal.
ebit DealFactFloat | null Earnings before interest and taxes (EBIT) of the target at the time of the deal.
ebitda DealFactFloat | null Earnings before interest, taxes, depreciation, and amortization (EBITDA) of the target at the time of the deal.
equity DealFactFloat | null Equity value of the target at the time of the deal.
ev DealFactFloat | null Enterprise value (EV) of target asset at the time of the deal.
evEbitMultiple DealFactFloat | null Enterprise value to EBIT multiple, including confidence and date.
evEbitdaMultiple DealFactFloat | null Enterprise value to EBITDA multiple, including confidence and date.
evRevenueMultiple DealFactFloat | null Enterprise value to revenue multiple, including confidence and date.
evTotalAssetsMultiple DealFactFloat | null Enterprise value to total assets multiple, including confidence and date.
fte DealFactFloat | null Full-time equivalent (FTE) employee count of the target asset at the time of the deal
fundingRoundAmountRaised DealFactFloat | null Amount raised if this deal was a funding round, including confidence and date.
fundingRoundPostMoneyValuation DealFactFloat | null Post-money valuation of target if this deal was a funding round, including confidence and date.
fundingRoundPreMoneyValuation DealFactFloat | null Pre-money valuation of the target if this deal was a funding round, including confidence and date.
fundingRoundType string(DealFundingRoundType) | null() Type of the funding round, such as Series A, B, C, etc.
highlightedBuyerId number(int) | null Identifier for the highlighted (most notable) buyer involved in the deal.
highlightedSellerId number(int) | null Identifier for the highlighted seller involved in the deal.
intelligenceEntries array(DealTransactionIntelligence) Transaction intelligence texts associated with the deal.
linkedAssetId number(int) | null Identifier for the target asset. Nil if the target is not linked to an Asset object in our database.
linkedAssetTeamMembers array(DealTeamMember) List of team members associated with the target asset involved in the deal.
notes array(DealNote) Additional notes or comments related to the deal.
publicationDate string(rfc3339) | null Date when the deal information was published, in RFC 3339 format.
reasons array(string(DealReason)) Aggregation of reasons for involvement of all deal sides. See individual deal buyers and sellers.
region string | null Deprecated: no longer maintained. Use CountryCode instead.
revenue DealFactFloat | null Revenue of the target at the time of the deal.
sector string | null Sector of the target asset.
sellers array(DealSeller) List of sellers involved in the deal, including details such as name, region, and share.
sources array(DealSource) List of sources providing information about the deal, including publication details and URLs.
stages array(DealStage) Represents all the deal stages.
status string(DealItemStatus) Current status of the deal, such as 'published'.
subsector string | null Subsector of the target asset.
totalAssets DealFactFloat | null Total assets of the target at the time of the deal.
Description

Type reference

Type
DealAdvisor ⎯
Properties
Name Type Description
id number(int)
advised string(DealAdvisorAdvised)
advisedOn array(string(AdvisoryActivity))
advisorId number(int) | null
dealId number(int)
teamMembers array(DealTeamMember) List of team members that worked for the deal advisor
Description

Type reference

Type
DealAdvisorAsset ⎯
Properties
Name Type Description
id number(int) | null
logoFileUrl string | null
name string
Description

Type reference

Type
DealBidder ⎯
Properties
Name Type Description
id number(int) Unique identifier for the deal side. Only relevant for Gain.pro
advisors array(DealBidderAdvisor)
countryCode string | null ISO-2 country code of the party involved in the deal side.
dealStageId number(int) | null
displayCountryCode string | null Display country code of the deal side
displayLogoFileUrl string | null Display logo file URL of the deal side
displayName string | null Display name of the deal side
division string | null Division of the party involved in the deal side.
isBuyer bool
isExclusive bool
leadingParty bool Indicates whether the deal is the leading party in the deal.
linkedAssetId number(int) | null Identifier for the linked asset associated with the deal side.
linkedFundConfidence string(InvestorFundConfidence) | null() Confidence level of the fund.
linkedFundId number(int) | null Identifier for the linked investor strategy fund associated with the deal side.
linkedInvestorId number(int) | null Identifier for the linked investor associated with the deal side.
linkedStrategyId number(int) | null Identifier for the linked investor strategy associated with the deal side.
name string | null Name of the deal side.
notes array(DealBidderNote)
order number(int) Index in the ordering of the deal sides.
reason string(DealReason) | null() Reason for involvement in the deal, e.g. a platform deal if a buyer or a strategic exit if a seller.
region string | null Deprecated: no longer maintained. Use CountryCode instead.
share DealFactSideShare | null Details about the share acquired or sold by the deal side (e.g. majority or minority; see enum definition), including confidence and date.
sharePct DealFactFloat | null Percentage share bought or sold by the deal side, including confidence and date.
teamMembers array(DealTeamMember) List of team members that worked for the deal side, e.g. buyer or seller.
type string(DealSideType) Type of deal side, such as asset or investor.
Description

Type reference

Type
DealBidderAdvisor ⎯
Properties
Name Type Description
id number(int)
advisedOn array(string(AdvisoryActivity))
advisorId number(int) | null
dealBidderId number(int)
teamMembers array(DealTeamMember) List of team members that worked for the deal bidder advisor
Description

Type reference

Type
DealBidderNote ⎯
Properties
Name Type Description
date string(rfc3339) | null
order number(int)
text string
type string(NoteType)
Description

Type reference

Type
DealCloudItem ⎯
Properties
Name Type Description
assetId number(int)
entryId number(int)
entryListId number(int)
error string
name string
status string(DealCloudStatus)
url string
Description

Type reference

Type
DealFactFloat ⎯
Properties
Name Type Description
confidence string(DealFactConfidence)
date Date | null
value number(float)
Description

Type reference

Type
DealFactSideShare ⎯
Properties
Name Type Description
confidence string(DealFactSideShareConfidence)
date Date | null
value string(DealSideShare)
Description

Type reference

Type
DealList ⎯
Properties
Name Type Description
args ListArgs
counts ListCounts
items array(DealListItem)
Description

Type reference

Type
DealListItem ⎯
Properties
Name Type Description
id number(int) Unique identifier for the deal.
advisorIds array(number(int)) Identifiers for the advisors involved in the deal.
announcementDate string Date when the deal was announced, formatted as YYYY-MM.
announcementDateMonth number(int) | null Month when the deal was announced.
announcementDateYear number(int) | null Year when the deal was announced.
asset string | null The target asset involved in the deal.
assetGainProUrl string | null URL to the asset's page on Gain.pro.
assetLogoFileUrl string | null URL of the logo file for the asset.
assetWebUrl string | null
bidderAssetIds array(number(int)) ID of bidders that are Asset objects. Can be used to filter deals where a known asset was a bidder.
bidderFundIds array(number(int)) ID of the the linked investor fund associated.
bidderInvestorIds array(number(int)) Analogous to BidderAssetIds, but for Investor objects.
bidderLogoFileUrls array(string) Only relevant for internal use.
bidderReasons array(string(DealReason)) All known DealReasons of bidders. Can be used for filtering deals by reasoning.
bidderSharePcts array(number(float)) All known percentage stakes acquired by buyers. Useful for filtering.
bidderShares array(string(DealSideShare)) All known types of shares acquired by buyers. Can be used for filtering deals by type of stake acquired.
bidderStrategyIds array(number(int)) ID of the the linked investor strategies associated.
buyerAdvisorIds array(number(int)) IDs of advisors who advised the buyers.
buyerAssetIds array(number(int)) ID of buyers that are Asset objects. Can be used to filter deals where a known asset was a buyer.
buyerAssetNames array(string) Only relevant for internal use. Use BuyersInfo instead.
buyerFundIds array(number(int)) ID of the the linked investor fund associated.
buyerInvestorIds array(number(int)) Analogous to BuyerAssetIds, but for Investor objects.
buyerInvestorNames array(string) Only relevant for internal use. Use BuyersInfo instead.
buyerLeadingParties array(bool) Only relevant for internal use. Use BuyersInfo instead.
buyerLinkedIds array(number(int)) Only relevant for internal use. Use BuyersInfo instead.
buyerLogoFileUrls array(string) Only relevant for internal use.
buyerNames array(string) Only relevant for internal use. Use BuyersInfo instead.
buyerReasons array(string(DealReason)) All known DealReasons of buyers. Can be used for filtering deals by reasoning. For a full overview of buyer info, see BuyersInfo instead.
buyerSharePcts array(number(float)) All known percentage stakes acquired by buyers. Useful for filtering. For a full overview of buyer info, see BuyersInfo instead.
buyerShares array(string(DealSideShare)) All known types of shares acquired by buyers. Can be used for filtering deals by type of stake acquired. For a full overview of buyer info, see BuyersInfo instead.
buyerStrategyIds array(number(int)) ID of the the linked investor strategies associated.
buyerTypes array(string(DealSideType)) Only relevant for internal use. Use BuyersInfo instead.
buyers number(int) Deprecated: will be removed
buyersInfo array(DealSummarySide)
countryCode string | null ISO-2 code indicating the HQ country of the target asset.
currency string | null Currency of the deal facts.
dealStatus string(DealStatus) Status of the deal's progress, if it has not (yet) been completed.
dealType string(DealType) | null() Deprecated. Will be removed from the API.
division string | null Division of the target asset involved in the deal.
ebit number(float) | null Earnings before interest and taxes of the target company.
ebitEur number(float) | null EBIT of the target company in EUR.
ebitYear number(int) | null Year of the EBIT data.
ebitda number(float) | null Earnings before interest, taxes, depreciation, and amortization of the target company.
ebitdaEur number(float) | null EBITDA of the target company in EUR.
ebitdaYear number(int) | null Year of the EBITDA data.
equity number(float) | null Equity value of the target company.
equityEur number(float) | null Equity value of the target company in EUR.
equityYear number(int) | null Year of the equity value data.
ev number(float) | null Enterprise value of the target company as determined in the deal.
evEbitMultiple number(float) | null Enterprise value to EBIT multiple.
evEbitMultipleYear number(int) | null Year of the EV to EBIT multiple data.
evEbitdaMultiple number(float) | null Enterprise value to EBITDA multiple.
evEbitdaMultipleYear number(int) | null Year of the EV to EBITDA multiple data.
evEur number(float) | null Enterprise value of the target company in EUR.
evRevenueMultiple number(float) | null Enterprise value to revenue multiple.
evRevenueMultipleYear number(int) | null Year of the EV to revenue multiple data.
evTotalAssetsMultiple number(float) | null Enterprise value to total assets multiple.
evTotalAssetsMultipleYear number(int) | null Year of the EV to total assets multiple data.
evYear number(int) | null Year of the enterprise value data.
fte number(float) | null Number of full-time employees of the target company.
fteYear number(int) | null Year of the full-time employee count.
fundingRoundAmountRaised number(float) | null Amount raised in the funding round.
fundingRoundAmountRaisedEur number(float) | null Amount raised in the funding round in EUR.
fundingRoundAmountRaisedYear number(int) | null Deprecated: Use publication year instead.
fundingRoundPostMoneyValuation number(float) | null Post-money valuation for the funding round.
fundingRoundPostMoneyValuationEur number(float) | null Post-money valuation for the funding round in EUR.
fundingRoundPostMoneyValuationYear number(int) | null Year of the post-money valuation data.
fundingRoundPreMoneyValuation number(float) | null Pre-money valuation for the funding round.
fundingRoundPreMoneyValuationEur number(float) | null Pre-money valuation for the funding round in EUR.
fundingRoundPreMoneyValuationYear number(int) | null Year of the pre-money valuation data.
fundingRoundType string(DealFundingRoundType) | null() Type of the funding round, such as Series A, B, C, etc.
gainProUrl string URL to the deal page on Gain.pro.
gainProUrl string URL to the deal page on Gain.pro.
highlightedBuyerDivision string | null Division of the highlighted buyer.
highlightedBuyerId number(int) | null Identifier for the highlighted (most notable) buyer.
highlightedBuyerName string | null Name of the highlighted buyer.
highlightedBuyerReason string(DealReason) | null() Reason for the highlighted buyer's involvement in the deal.
highlightedBuyerRegion string | null ISO-2 code indicating the HQ country of the highlighted buyer.
highlightedBuyerShare string(DealSideShare) | null() Share of the highlighted buyer in the deal.
highlightedBuyerSharePct number(float) | null Percentage share acquired by the highlighted buyer in the deal.
highlightedBuyerType string(DealSideType) | null() Type of the highlighted buyer, such as investor or asset.
highlightedSellerDivision string | null See equivalent buyers field.
highlightedSellerId number(int) | null See equivalent buyers field.
highlightedSellerName string | null See equivalent buyers field.
highlightedSellerReason string(DealReason) | null() See equivalent buyers field.
highlightedSellerRegion string | null See equivalent buyers field.
highlightedSellerShare string(DealSideShare) | null() See equivalent buyers field.
highlightedSellerSharePct number(float) | null See equivalent buyers field.
highlightedSellerType string(DealSideType) | null() See equivalent buyers field.
investorIds array(number(int)) Identifiers for the investors involved in the deal.
linkedAssetDescription string | null Description of the linked asset.
linkedAssetId number(int) | null Identifier for the linked asset associated with the deal.
linkedAssetUrl string | null Url of the linked asset associated with the deal.
live bool True if the deal is currently published on Gain.pro.
publicationDate string(rfc3339) | null The date when the deal was published on Gain.pro.
reasons array(string(DealReason)) Aggregation of reasons for involvement of all deal sides. See individual deal buyers and sellers.
region string | null ISO-2 code indicating the HQ country of the target asset.
revenue number(float) | null Revenue of the target company.
revenueEur number(float) | null Revenue of the target company in EUR.
revenueYear number(int) | null Year of the revenue data.
sector string | null Sector of the target asset.
sellerAdvisorIds array(number(int)) IDs of advisors who advised the sellers.
sellerAssetIds array(number(int)) See equivalent buyers field.
sellerAssetNames array(string) Only relevant for internal use. Use SellersInfo instead.
sellerFundIds array(number(int)) See equivalent buyers field.
sellerInvestorIds array(number(int)) See equivalent buyers field.
sellerInvestorNames array(string) Only relevant for internal use. Use SellersInfo instead.
sellerLeadingParties array(bool) Only relevant for internal use. Use SellersInfo instead.
sellerLinkedIds array(number(int)) Only relevant for internal use. Use SellersInfo instead.
sellerLogoFileUrls array(string) See equivalent buyers field.
sellerNames array(string) Only relevant for internal use. Use SellersInfo instead.
sellerReasons array(string(DealReason)) See equivalent buyers field.
sellerSharePcts array(number(float)) See equivalent buyers field.
sellerShares array(string(DealSideShare)) See equivalent buyers field.
sellerStrategyIds array(number(int)) See equivalent buyers field.
sellerTypes array(string(DealSideType)) Only relevant for internal use. Use SellersInfo instead.
sellers number(int) Deprecated: will be removed
sellersInfo array(DealSummarySide)
subsector string | null Subsector of the target asset.
tagIds array(number(int)) Identifiers for the tags applied to the deal target.
tags array(string) Tags applied to the deal target.
totalAssets number(float) | null Total assets of the target company.
totalAssetsEur number(float) | null Total assets of the target company in EUR.
totalAssetsYear number(int) | null Year of the total assets data.
type string Type of deal object. Automated deals were sourced without human curation.
webUrl string
Description

Type reference

Type
DealNote ⎯
Properties
Name Type Description
order number(int)
text string
Description

Type reference

Type
DealSeller ⎯
Properties
Name Type Description
id number(int) Unique identifier for the deal side. Only relevant for Gain.pro
countryCode string | null ISO-2 country code of the party involved in the deal side.
displayCountryCode string | null Display country code of the deal side
displayLogoFileUrl string | null Display logo file URL of the deal side
displayName string | null Display name of the deal side
division string | null Division of the party involved in the deal side.
leadingParty bool Indicates whether the deal is the leading party in the deal.
linkedAssetId number(int) | null Identifier for the linked asset associated with the deal side.
linkedFundConfidence string(InvestorFundConfidence) | null() Confidence level of the fund.
linkedFundId number(int) | null Identifier for the linked investor strategy fund associated with the deal side.
linkedInvestorId number(int) | null Identifier for the linked investor associated with the deal side.
linkedStrategyId number(int) | null Identifier for the linked investor strategy associated with the deal side.
name string | null Name of the deal side.
order number(int) Index in the ordering of the deal sides.
reason string(DealReason) | null() Reason for involvement in the deal, e.g. a platform deal if a buyer or a strategic exit if a seller.
region string | null Deprecated: no longer maintained. Use CountryCode instead.
share DealFactSideShare | null Details about the share acquired or sold by the deal side (e.g. majority or minority; see enum definition), including confidence and date.
sharePct DealFactFloat | null Percentage share bought or sold by the deal side, including confidence and date.
teamMembers array(DealTeamMember) List of team members that worked for the deal side, e.g. buyer or seller.
type string(DealSideType) Type of deal side, such as asset or investor.
Description

Type reference

Type
DealSource ⎯
Properties
Name Type Description
language string | null
order number(int)
publicationMonth number(int) | null
publicationYear number(int) | null
publisher string | null
title string
url string | null
Description

Type reference

Type
DealStage ⎯
Properties
Name Type Description
id number(int) Unique identifier for the deal stage. Only relevant for Gain.pro
date string(rfc3339) | null Stage date
relevanceOrder number(int) Uses to order deal stages. Only relevant for Gain.pro
type string(DealStageType) Type of the deal stage
Description

Type reference

Type
DealSummarySide ⎯
Properties
Name Type Description
leadingParty bool True if the buyer or seller was a leading party in the deal.
linkedId number(int) | null ID of the linked object. May point to an Asset or Investor, depending on Type.
name string | null Name of the buyer or seller.
reason string(DealReason) | null() Reason for buying or selling a stake.
share DealFactSideShare | null Share bought or sold by the party.
sharePct DealFactFloat | null Percentage stake bought or sold by the party.
type string(DealSideType) Type of the buyer or seller.
Description

Type reference

Type
DealTeamMember ⎯
Properties
Name Type Description
id number(int)
createdAt string(rfc3339)
dealAdvisorId number(int) | null
dealBidderAdvisorId number(int) | null
dealBidderId number(int) | null
dealId number(int) | null
dealSellerId number(int) | null
personId number(int)
position string(TeamMemberPosition) | null()
status string(TeamMemberStatus)
updatedAt string(rfc3339)
Description

Type reference

Type
DealTeamMemberList ⎯
Properties
Name Type Description
args ListArgs
counts ListCounts
items array(DealTeamMemberListItem)
Description

Type reference

Type
DealTeamMemberListItem ⎯
Properties
Name Type Description
id number(int)
createdAt string(rfc3339)
dealAdvisorId number(int) | null
dealBidderAdvisorId number(int) | null
dealBidderId number(int) | null
dealId number(int) | null
dealSellerId number(int) | null
person Person
personId number(int)
position string(TeamMemberPosition) | null()
status string(TeamMemberStatus)
updatedAt string(rfc3339)
Description

Type reference

Type
DealTransactionIntelligence ⎯
Properties
Name Type Description
date string(rfc3339) | null
order number(int)
text string
Description

Type reference

Type
DealsPerTypeByYear ⎯
Properties
Name Type Description
dealCount number(int)
type string
year number(int)
Description

Type reference

Type
ExportBenchmarkingChartConfig ⎯
Properties
Name Type Description
groupByLabel string
includeRankingColumn bool
sizeLabel string
xaxis string
yaxis string
Description

Type reference

Type
Filter ⎯
Properties
Name Type Description
field string
operator string
value any
Description

Type reference

Type
FinancialLatestResultAmount ⎯
Properties
Name Type Description
amount number(float)
amountType string(FinancialResultAmountType) Confidence level of the amount.
pctRevenue number(float) | null Amount as a percentage of revenue.
year number(int)
Description

Type reference

Type
FinancialResultAmount ⎯
Properties
Name Type Description
amount number(float)
amountType string(FinancialResultAmountType) Confidence level of the amount.
pctRevenue number(float) | null Amount as a percentage of revenue.
Description

Type reference

Type
GeoJSON ⎯
Properties
Name Type Description
coordinates array(array(array(array(number(float)))))
type string
Description

Type reference

Type
GeoPolygon ⎯
Properties
Name Type Description
id number(int)
city string | null
country string
countryCode string
county string | null
formatted string
geoJson GeoJSON
geom MultiPolygon | null
lat number(float)
lng number(float)
name string | null
nameEn string | null
placeId string
placeIdBoundary string
postcode string | null
state string | null
stateCode string | null
suburb string | null
Description

Type reference

Type
GetAuthenticationTypeResponse ⎯
Properties
Name Type Description
type string(AuthenticationType)
url string
Description

Type reference

Type
GetCityByPlaceIdResponse ⎯
Properties
Name Type Description
city string
countryCode string
region string | null
Description

Type reference

Type
GetEmailAddressResult ⎯
Properties
Name Type Description
confidence number(int)
email string
Description

Type reference

Type
GetGetBookmarkListUrlImportTaskStateResult ⎯
Properties
Name Type Description
id number(int)
bookmarkListId number(int)
completedAt string(rfc3339) | null
createdAt string(rfc3339)
customerId number(int)
duplicateMatchCount number(int)
hasError bool
resultFileUrl string | null
updatedAt string(rfc3339)
urlsChecked number(int)
urlsMatched number(int)
urlsTotal number(int)
Description

Type reference

Type
GetLonLatByPlaceIdResponse ⎯
Properties
Name Type Description
lat number(float)
lng number(float)
Description

Type reference

Type
GlobalUltimateOwner ⎯
Properties
Name Type Description
id number(int)
linkedLegalEntityId number(int) | null
linkedLegalEntityName string | null
linkedLegalEntityRegion string | null
name string
region string
subsidiaries array(GlobalUltimateOwnerSubsidiary)
Description

Type reference

Type
GlobalUltimateOwnerSubsidiary ⎯
Properties
Name Type Description
ebitdaEur number(float) | null
ebitdaYear number(int) | null
legalEntityId number(int)
name string
region string
revenueEur number(float) | null
revenueYear number(int) | null
Description

Type reference

Type
GrowthMetric ⎯
Properties
Name Type Description
ebitGrowth number(float) | null | undefined The percentage growth in EBIT over this period.
ebitdaGrowth number(float) | null | undefined The percentage growth in EBITDA over this period.
fteGrowth number(float) | null | undefined The percentage growth in full-time equivalent employees (FTE) over this period.
grossMarginGrowth number(float) | null | undefined The percentage growth in gross margin over this period.
period string The period for which the growth metric is calculated. Not all growth metrics are available for all periods.
revenueGrowth number(float) | null | undefined The percentage growth in revenue over this period.
Description

Type reference

Type
Industry ⎯
Properties
Name Type Description
id number(int)
assets array(IndustryAsset)
charts array(IndustryChart)
cons array(IndustryCon)
deals IndustryDeals | null
factSheetFileCreatedAt string(rfc3339) | null
factSheetFileId number(int) | null
generalInfo IndustryGeneralInfo | null
keyTakeaways array(IndustryKeyTakeaway)
market IndustryMarket | null
outlook IndustryOutlook | null
pros array(IndustryPro)
publicationDate string(rfc3339) | null
sources array(IndustrySource)
status string(IndustryStatus)
Description

Type reference

Type
IndustryAsset ⎯
Properties
Name Type Description
assetId number(int)
order number(int)
segmentId number(int) | null
Description

Type reference

Type
IndustryChart ⎯
Properties
Name Type Description
fileId number(int) | null
fileUrl string | null
filename string | null
order number(int)
type string(IndustryChartType) | null()
Description

Type reference

Type
IndustryCon ⎯
Properties
Name Type Description
order number(int)
text string
Description

Type reference

Type
IndustryDeals ⎯
Properties
Name Type Description
assetAvailability string | null
recentMAndA string | null
Description

Type reference

Type
IndustryGeneralInfo ⎯
Properties
Name Type Description
coverImageFileId number(int) | null
coverImageFileUrl string | null
coverImageFilename string | null
date string(rfc3339) | null
emailImageFileId number(int) | null
emailImageFileUrl string | null
emailImageFilename string | null
largeImageFileId number(int) | null
largeImageFileUrl string | null
largeImageFilename string | null
regions array(string)
scope string | null
sector string | null
smallImageFileId number(int) | null
smallImageFileUrl string | null
smallImageFilename string | null
subsector string | null
tags array(string)
title string
Description

Type reference

Type
IndustryKeyTakeaway ⎯
Properties
Name Type Description
order number(int)
text string
Description

Type reference

Type
IndustryList ⎯
Properties
Name Type Description
args ListArgs
counts ListCounts
items array(IndustryListItem)
Description

Type reference

Type
IndustryListItem ⎯
Properties
Name Type Description
id number(int)
date string(rfc3339) | null
largeImageFileId number(int) | null
largeImageFileUrl string | null
linkedAssetIds array(number(int))
linkedAssetsTotal number(int)
publicationDate string(rfc3339) | null
ratingMedianEbitda number(float) | null
ratingMedianEnvironmental number(float) | null
ratingMedianOrganicGrowth number(float) | null
ratingMedianOverall number(float) | null
ratingMedianSocial number(float) | null
regions array(string)
scope string | null
sector string | null
smallImageFileId number(int) | null
smallImageFileUrl string | null
subsector string | null
title string | null
Description

Type reference

Type
IndustryMarket ⎯
Properties
Name Type Description
definition string | null
esg string | null
segments array(IndustryMarketSegment)
structure string | null
Description

Type reference

Type
IndustryMarketSegment ⎯
Properties
Name Type Description
id number(int)
name string
order number(int)
ratingEnvironmental number(float) | null
ratingOverall number(float) | null
ratingSocial number(float) | null
text string
Description

Type reference

Type
IndustryMarketSegmentList ⎯
Properties
Name Type Description
args ListArgs
counts ListCounts
items array(IndustryMarketSegmentListItem)
Description

Type reference

Type
IndustryMarketSegmentListItem ⎯
Properties
Name Type Description
id number(int)
dealCount number(int)
industryDate string(rfc3339) | null
industryId number(int)
industryPublicationDate string(rfc3339) | null
industryRegions array(string)
industryScope string | null
industrySmallImageFileUrl string | null
industryStatus string(IndustryStatus)
industrySubsector string | null
industryTitle string | null
linkedAssetIds array(number(int))
linkedAssetsTotal number(int)
name string | null
ratingEnvironmental number(float) | null
ratingMedianBuyAndBuild number(float) | null
ratingMedianContracted number(float) | null
ratingMedianConversion number(float) | null
ratingMedianEbitda number(float) | null
ratingMedianGrossMargin number(float) | null
ratingMedianGrowth number(float) | null
ratingMedianLeader number(float) | null
ratingMedianMultinational number(float) | null
ratingMedianNonCyclical number(float) | null
ratingMedianOrganicGrowth number(float) | null
ratingOverall number(float) | null
ratingSocial number(float) | null
text string | null
totalRevenueEur number(float) | null
Description

Type reference

Type
IndustryOutlook ⎯
Properties
Name Type Description
negativeDrivers array(IndustryOutlookNegativeDriver)
positiveDrivers array(IndustryOutlookPositiveDriver)
sizeAndGrowth array(IndustryOutlookSizeAndGrowth)
Description

Type reference

Type
IndustryOutlookNegativeDriver ⎯
Properties
Name Type Description
order number(int)
text string
Description

Type reference

Type
IndustryOutlookPositiveDriver ⎯
Properties
Name Type Description
order number(int)
text string
Description

Type reference

Type
IndustryOutlookSizeAndGrowth ⎯
Properties
Name Type Description
order number(int)
text string
Description

Type reference

Type
IndustryPro ⎯
Properties
Name Type Description
order number(int)
text string
Description

Type reference

Type
IndustrySegmentDealByYear ⎯
Properties
Name Type Description
dealCount number(int)
industryMarketSegmentId number(int)
industryMarketSegmentName string
medianEvEbitMultiple number(float) | null
medianEvEbitdaMultiple number(float) | null
medianEvRevenueMultiple number(float) | null
medianEvTotalAssetsMultiple number(float) | null
year number(int)
Description

Type reference

Type
IndustrySource ⎯
Properties
Name Type Description
assessment bool | null
deals bool | null
esg bool | null
language string | null
order number(int)
outlook bool | null
publicationMonth number(int) | null
publicationYear number(int) | null
publisher string | null
segment bool | null
title string | null
url string | null
Description

Type reference

Type
Investor ⎯
Properties
Name Type Description
id number(int)
aliases array(InvestorAlias)
createdAt string(rfc3339)
description string | null
dryPowderMaxEur number(float) | null
dryPowderMinEur number(float) | null
flagshipFundId number(int) | null
foundedBy string | null
fte number(float) | null
fteMeasurements array(InvestorFteMeasurement)
funds array(InvestorFund)
fundsRaisedLastFiveYears number(float) | null
latestFundId number(int) | null
linkedInUrl string | null
linkedinExternalId string | null
live bool Deprecated. Will be removed from the API.
liveFundSizeEur number(float) | null
liveFundsCount number(int)
logoFileId number(int) | null
logoFileUrl string | null
logoFilename string | null
name string
onlyIncludeCurated bool
operationalHqAddress Address | null Details of the headquarters address. See type definition.
operationalHqAddressId number(int) | null Identifier for the headquarters address
operationalHqCity string | null
operationalHqCountryCode string | null ISO-2 country code for the headquarters of the investor
publicationDate string(rfc3339) | null
shortName string | null
status string(InvestorStatus)
strategies array(InvestorStrategy)
unpublishedAt string(rfc3339) | null
updatedAt string(rfc3339)
url string | null Website URL of the investor
urls array(Url) Website URLs associated with this investor
yearFounded number(int) | null
Description

Type reference

Type
InvestorAlias ⎯
Properties
Name Type Description
id number(int)
alias string
investorId number(int)
order number(int)
Description

Type reference

Type
InvestorAssetRatings ⎯
Properties
Name Type Description
buyAndBuild number(float) | null
contracted number(float) | null
conversion number(float) | null
ebitda number(float) | null
environmental number(float) | null
grossMargin number(float) | null
growth number(float) | null
leader number(float) | null
multinational number(float) | null
nonCyclical number(float) | null
organicGrowth number(float) | null
overall number(float) | null
social number(float) | null
Description

Type reference

Type
InvestorAssetsCountryCodeCount ⎯
Properties
Name Type Description
count number(int)
countryCode string
Description

Type reference

Type
InvestorAssetsSubsectorCount ⎯
Properties
Name Type Description
count number(int)
subsector string
Description

Type reference

Type
InvestorDealsPerTypeByYear ⎯
Properties
Name Type Description
dealCount number(int)
type string
year number(int)
Description

Type reference

Type
InvestorFteMeasurement ⎯
Properties
Name Type Description
id number(int)
determinedAt string(rfc3339)
employeeCount number(float)
investorId number(int)
Description

Type reference

Type
InvestorFund ⎯
Properties
Name Type Description
id number(int)
continuationFund bool
currency string
dpi number(float) | null
dpiDate string(rfc3339) | null
dryPowderMax number(float) | null
dryPowderMin number(float) | null
finalCloseDate Date | null
firstCloseDate Date | null
firstCloseSize number(float) | null
firstCloseSizeEur number(float) | null
fundSize number(float) | null
fundSizeEur number(float) | null
fundraisingStatus string(InvestorFundFundraisingStatus) | null()
grossIrr number(float) | null
grossIrrDate string(rfc3339) | null
hardCapSize number(float) | null
hardCapSizeEur number(float) | null
investorId number(int)
investorStrategyId number(int) | null
launchDate Date | null
moic number(float) | null
moicDate string(rfc3339) | null
name string
netIrr number(float) | null
netIrrDate string(rfc3339) | null
notes array(InvestorFundNote)
order number(int)
rvpi number(float) | null
rvpiDate string(rfc3339) | null
singleDealFund bool
source string
targetFundSize number(float) | null
targetFundSizeEur number(float) | null
tvpi number(float) | null
tvpiDate string(rfc3339) | null
twr number(float) | null
twrDate string(rfc3339) | null
vintageDate Date | null
Description

Type reference

Type
InvestorFundList ⎯
Properties
Name Type Description
args ListArgs
counts ListCounts
items array(InvestorFundListItem)
Description

Type reference

Type
InvestorFundListItem ⎯
Properties
Name Type Description
id number(int) Unique identifier of the fund
assetEbitdaMedian number(float) | null Median EBITDA value of the fund's assets in original currency
assetEbitdaMedianEur number(float) | null Median EBITDA value of the fund's assets in EUR
assetEbitdas array(number(float)) EBITDA values of the fund's assets in original currency
assetEbitdasEur array(number(float)) EBITDA values of the fund's assets in EUR
assetIds array(number(int)) Identifiers of the fund's assets
assetRegions array(string) Regions targeted by the fund's assets
assetSectors array(string) Sectors targeted by the fund's assets
assetSubsectors array(string) Subsectors targeted by the fund's assets
assetsFiltered number(int)
assetsMedianMarketSegmentRatingEnvironmental number(float) | null Median environmental rating of the assets
assetsMedianMarketSegmentRatingOverall number(float) | null Median overall market segment rating of the assets
assetsMedianMarketSegmentRatingSocial number(float) | null Median social rating of the assets
assetsTotal number(int) Total number of assets in the fund
currency string | null Currency of the fund
currencyToEur number(float) | null Conversion rate from currency to EUR
dealsAddOnsTotalLastFiveYears number(int) | null Number of add-on deals in the last five years
dealsEntriesTotalLastFiveYears number(int) | null Number of entry deals in the last five years
dealsExitTotalLastFiveYears number(int) | null Number of exits in the last five years
dealsTotalLastFiveYears number(int) | null Total number of deals in the last five years
dpi number(float) | null Distributions to Paid-In (DPI) ratio of the fund
dpiDate string(rfc3339) | null Date when DPI was measured
dryPowderMaxEur number(float) | null Maximum available dry powder in EUR
dryPowderMinEur number(float) | null Minimum available dry powder in EUR
finalCloseDate string | null Final close date of the fund
finalCloseDay number(int) | null Day of final close of the fund
finalCloseMonth number(int) | null Month of final close of the fund
finalCloseYear number(int) | null Year of final close of the fund
firstCloseDate string | null First close date of the fund
firstCloseDay number(int) | null Day of first close of the fund
firstCloseMonth number(int) | null Month of first close of the fund
firstCloseSize number(float) | null First close size of the fund
firstCloseSizeEur number(float) | null First close size of the fund in EUR
firstCloseYear number(int) | null Year of first close of the fund
fundSize number(float) | null Current size of the fund
fundSizeEur number(float) | null Current size of the fund in EUR
fundraisingStatus string(InvestorFundFundraisingStatus) | null() Current fundraising status of the fund
grossIrr number(float) | null Gross Internal Rate of Return (IRR) of the fund
grossIrrDate string(rfc3339) | null Date when Gross IRR was measured
hardCapSize number(float) | null Hard cap size of the fund
hardCapSizeEur number(float) | null Hard cap size of the fund in EUR
investorId number(int) Unique identifier of the linked investor
investorLogoFileId number(int) | null File ID of the investor's logo
investorLogoFileUrl string | null URL of the investor's logo file
investorName string Name of the linked investor
launchDate string | null Launch date of the fund
launchDay number(int) | null Day of fund launch
launchMonth number(int) | null Month of fund launch
launchYear number(int) | null Year of fund launch
moic number(float) | null Multiple on Invested Capital (MOIC) of the fund
moicDate string(rfc3339) | null Date when MOIC was measured
name string Name of the fund
netIrr number(float) | null Net Internal Rate of Return (IRR) of the fund
netIrrDate string(rfc3339) | null Date when Net IRR was measured
rvpi number(float) | null Residual Value to Paid-In (RVPI) ratio of the fund
rvpiDate string(rfc3339) | null Date when RVPI was measured
strategyClassifications array(string(InvestorStrategyClassification)) List of strategy classifications
strategyId number(int) | null Unique identifier of the investment strategy
strategyName string | null Name of the investment strategy
targetFundSize number(float) | null Target size of the fund
targetFundSizeEur number(float) | null Target size of the fund in EUR
tvpi number(float) | null Total Value to Paid-In (TVPI) ratio of the fund
tvpiDate string(rfc3339) | null Date when TVPI was measured
twr number(float) | null Time-Weighted Return (TWR) of the fund
twrDate string(rfc3339) | null Date when TWR was measured
vintageDate string | null Vintage date representing the year of fund inception
vintageDay number(int) | null Day component of the vintage date
vintageMonth number(int) | null Month component of the vintage date
vintageYear number(int) | null Year component of the vintage date
Description

Type reference

Type
InvestorFundNote ⎯
Properties
Name Type Description
order number(int)
text string
Description

Type reference

Type
InvestorFundTotals ⎯
Properties
Name Type Description
dryPowderMaxEur number(float) | null
dryPowderMinEur number(float) | null
fundsRaisedLastFiveYearsEur number(float) | null
liveFundSizeEur number(float) | null
Description

Type reference

Type
InvestorFundraising ⎯
Properties
Name Type Description
fundSizeEur number(float)
year number(int)
Description

Type reference

Type
InvestorList ⎯
Properties
Name Type Description
args ListArgs
counts ListCounts
items array(InvestorListItem)
Description

Type reference

Type
InvestorListItem ⎯
Properties
Name Type Description
id number(int)
advisorIds array(number(int)) IDs of advisors that advised the buy-side in deals in which the investor was a buyer, or the sell-side in deals in which the investor was a seller.
aliases array(string)
assetEbitdaMedian number(float) | null
assetEbitdaMedianEur number(float) | null
assetEbitdas array(number(float))
assetEbitdasEur array(number(float))
assetIds array(number(int)) IDs of assets in the investor's portfolio.'
assetRegions array(string)
assetSectors array(string)
assetSubsectors array(string)
assetTagIds array(number(int))
assetTags array(string)
assetsFiltered number(int)
assetsMedianMarketSegmentRatingEnvironmental number(float) | null
assetsMedianMarketSegmentRatingOverall number(float) | null
assetsMedianMarketSegmentRatingSocial number(float) | null
assetsTotal number(int) Total number of assets in the investor's portfolio.'
dealsAddOnsTotalLastFiveYears number(int) | null
dealsEntriesTotalLastFiveYears number(int) | null
dealsExitTotalLastFiveYears number(int) | null
dealsTotalLastFiveYears number(int) | null
dryPowderMaxEur number(float) | null Estimated maximum dry powder in millions EUR.
dryPowderMinEur number(float) | null Estimated minimum dry powder in millions EUR.
flagshipFundCurrency string | null
flagshipFundCurrencyToEur number(float) | null
flagshipFundFirstCloseSizeEur number(float) | null
flagshipFundHardCapSizeEur number(float) | null
flagshipFundId number(int) | null ID of the investor's flagship fund.
flagshipFundName string | null
flagshipFundSize number(float) | null
flagshipFundSizeEur number(float) | null
flagshipFundTargetSizeEur number(float) | null
flagshipFundVintageDate string | null
flagshipFundVintageMonth number(int) | null
flagshipFundVintageYear number(int) | null
fte number(float) | null Latest available measurement of full-time equivalent (FTE) employees.
fteRange string | null
fteRangeCategory number(int) | null
fundsRaisedLastFiveYears number(float) | null Amount of funding raised by the investor in the last 5 years, measured in millions of original currency.
fundsRaisedLastFiveYearsEur number(float) | null Amount of funding raised by the investor in the last 5 years, measured in millions EUR.
gainProUrl string The URL to the investor's page on Gain.pro.
gainProUrl string URL to the investor's page on Gain.pro.
live bool Deprecated. Will be removed from the API.
liveFundSizeEur number(float) | null
liveFundsCount number(int) | null
logoFileId number(int) | null
logoFileUrl string | null
name string
onlyIncludeCurated bool Deprecated. Will be removed from the API.
operationalHqCity string | null City of the headquarters
operationalHqCountryCode string | null ISO-2 country code for the headquarters. Slightly more accurate, but less frequently available than field region
operationalHqFormattedAddress string | null Formatted address of the headquarters
operationalHqRegion string | null Region (e.g. state or province) of the headquarters
operationalHqWgs84LngLat Point | null Geographical coordinates of the headquarters in WGS84 format
publicationDate string(rfc3339) | null
shortName string | null
status string(InvestorStatus)
url string | null URL to the investor's website.
webUrl string Deprecated: use gainProUrl instead.
yearFounded number(int) | null Founding year of the investor.
Description

Type reference

Type
InvestorManagerAssetListItem ⎯
Properties
Name Type Description
id number(int)
logoFileUrl string
name string
region string | null
sector string | null
subsector string | null
Description

Type reference

Type
InvestorManagerList ⎯
Properties
Name Type Description
args ListArgs
counts ListCounts
items array(InvestorManagerListItem)
Description

Type reference

Type
InvestorManagerListItem ⎯
Properties
Name Type Description
id number(int)
assetCount number(int) | null
assetIds array(number(int))
assets array(InvestorManagerAssetListItem)
firstName string
fullName string
investorId number(int)
lastName string
linkedInUrl string | null
personId number(int)
regions array(string)
sectors array(string)
subsectors array(string)
Description

Type reference

Type
InvestorOwnershipCount ⎯
Properties
Name Type Description
count number(int)
share string
Description

Type reference

Type
InvestorStrategy ⎯
Properties
Name Type Description
id number(int)
currency string | null
description string
dryPowderMaxEur number(float) | null
dryPowderMinEur number(float) | null
ebitdaRangeMax number(float) | null
ebitdaRangeMin number(float) | null
evRangeMax number(float) | null
evRangeMin number(float) | null
funds array(InvestorFund)
fundsRaisedLastFiveYearsEur number(float) | null
investmentTicketSizeMax number(float) | null
investmentTicketSizeMin number(float) | null
investorId number(int)
latestFundId number(int) | null
name string
order number(int)
preferredEquityStakeMaxPct number(float) | null
preferredEquityStakeMinPct number(float) | null
preferredStake string(InvestorStrategyPreferredStake)
primaryClassification string(InvestorStrategyClassification) | null()
revenueRangeMax number(float) | null
revenueRangeMin number(float) | null
secondaryClassification string(InvestorStrategyClassification) | null()
source string | null
tertiaryClassification string(InvestorStrategyClassification) | null()
Description

Type reference

Type
InvestorStrategyClassificationCount ⎯
Properties
Name Type Description
classification string
count number(int)
Description

Type reference

Type
InvestorStrategyList ⎯
Properties
Name Type Description
args ListArgs
counts ListCounts
items array(InvestorStrategyListItem)
Description

Type reference

Type
InvestorStrategyListItem ⎯
Properties
Name Type Description
id number(int) The ID of the strategy
assetEbitdaEurMedian number(float) | null Deprecated: use assetEbitdaMedianEur instead
assetEbitdaMedian number(float) | null Median EBITDA of assets
assetEbitdaMedianEur number(float) | null Median EBITDA of assets in EUR
assetEbitdas array(number(float)) List of EBITDA values of assets
assetEbitdasEur array(number(float)) List of EBITDA values of assets in EUR
assetIds array(number(int)) Internal IDs of assets linked to the strategy
assetRegions array(string) Regions targeted for assets
assetSectors array(string) Sectors targeted for assets
assetSubsectors array(string) Subsectors targeted for assets
assetsFiltered number(int)
assetsMedianMarketSegmentRatingEnvironmental number(float) | null Median environmental market segment rating of assets
assetsMedianMarketSegmentRatingOverall number(float) | null Median overall market segment rating of assets
assetsMedianMarketSegmentRatingSocial number(float) | null Median social market segment rating of assets
assetsTotal number(int) Total number of assets linked to the strategy
classifications array(string(InvestorStrategyClassification)) Classifications assigned to the strategy
currency string | null Currency used for financial fields
currencyToEur number(float) | null Conversion rate from currency to EUR
dealsAddOnsTotalLastFiveYears number(int) | null Total number of add-on deals in the last 5 years
dealsEntriesTotalLastFiveYears number(int) | null Total number of entries in the last 5 years
dealsExitTotalLastFiveYears number(int) | null Total number of exits in the last 5 years
dealsTotalLastFiveYears number(int) | null Total number of deals in the last 5 years
dryPowderMaxEur number(float) | null Maximum available dry powder in EUR
dryPowderMinEur number(float) | null Minimum available dry powder in EUR
ebitdaRangeMax number(float) | null Maximum EBITDA targeted
ebitdaRangeMaxEur number(float) | null Maximum EBITDA targeted in EUR
ebitdaRangeMin number(float) | null Minimum EBITDA targeted
ebitdaRangeMinEur number(float) | null Minimum EBITDA targeted in EUR
evRangeMax number(float) | null Maximum Enterprise Value targeted
evRangeMaxEur number(float) | null Maximum Enterprise Value targeted in EUR
evRangeMin number(float) | null Minimum Enterprise Value targeted
evRangeMinEur number(float) | null Minimum Enterprise Value targeted in EUR
fundsRaisedLastFiveYearsEur number(float) | null Funds raised in the last 5 years (EUR)
gainProUrl string URL to the investor strategy's page on Gain.pro.
investmentTicketSizeMax number(float) | null Maximum investment ticket size
investmentTicketSizeMaxEur number(float) | null Maximum investment ticket size in EUR
investmentTicketSizeMin number(float) | null Minimum investment ticket size
investmentTicketSizeMinEur number(float) | null Minimum investment ticket size in EUR
investorId number(int) The ID of the investor linked to this strategy
investorLogoFileId number(int) | null File ID of the investor logo in the storage
investorLogoFileUrl string | null URL of the investor logo image
investorName string Name of the investor
latestFundCurrency string | null Currency of the latest fund
latestFundFirstCloseSizeEur number(float) | null First close size of the latest fund in EUR
latestFundHardCapSizeEur number(float) | null Hard cap size of the latest fund in EUR
latestFundId number(int) | null ID of the latest fund
latestFundName string | null Name of the latest fund
latestFundSize number(float) | null Size of the latest fund
latestFundSizeEur number(float) | null Size of the latest fund in EUR
latestFundTargetSizeEur number(float) | null Target size of the latest fund in EUR
latestFundVintageDate string | null Vintage date of the latest fund
latestFundVintageDateDay number(int) | null Vintage date day
latestFundVintageDateMonth number(int) | null Vintage date month
latestFundVintageDateYear number(int) | null Vintage date year
preferredEquityStakeMaxPct number(float) | null Maximum preferred equity stake percentage
preferredEquityStakeMinPct number(float) | null Minimum preferred equity stake percentage
preferredStake string(InvestorStrategyPreferredStake) Preferred stake type or details
revenueRangeMax number(float) | null Maximum revenue targeted
revenueRangeMaxEur number(float) | null Maximum revenue targeted in EUR
revenueRangeMin number(float) | null Minimum revenue targeted
revenueRangeMinEur number(float) | null Minimum revenue targeted in EUR
strategyName string Name of the strategy
webUrl string Deprecated: use gainProUrl instead.
Description

Type reference

Type
InvestorSummary ⎯
Properties
Name Type Description
id number(int)
advisorIds array(number(int)) IDs of advisors that advised the buy-side in deals in which the investor was a buyer, or the sell-side in deals in which the investor was a seller.
aliases array(string)
assetEbitdaMedian number(float) | null
assetEbitdaMedianEur number(float) | null
assetEbitdas array(number(float))
assetEbitdasEur array(number(float))
assetIds array(number(int)) IDs of assets in the investor's portfolio.'
assetRegions array(string)
assetSectors array(string)
assetSubsectors array(string)
assetTagIds array(number(int))
assetTags array(string)
assetsMedianMarketSegmentRatingEnvironmental number(float) | null
assetsMedianMarketSegmentRatingOverall number(float) | null
assetsMedianMarketSegmentRatingSocial number(float) | null
assetsTotal number(int) Total number of assets in the investor's portfolio.'
dealsAddOnsTotalLastFiveYears number(int) | null
dealsEntriesTotalLastFiveYears number(int) | null
dealsExitTotalLastFiveYears number(int) | null
dealsTotalLastFiveYears number(int) | null
dryPowderMaxEur number(float) | null Estimated maximum dry powder in millions EUR.
dryPowderMinEur number(float) | null Estimated minimum dry powder in millions EUR.
flagshipFundCurrency string | null
flagshipFundCurrencyToEur number(float) | null
flagshipFundFirstCloseSizeEur number(float) | null
flagshipFundHardCapSizeEur number(float) | null
flagshipFundId number(int) | null ID of the investor's flagship fund.
flagshipFundName string | null
flagshipFundSize number(float) | null
flagshipFundSizeEur number(float) | null
flagshipFundTargetSizeEur number(float) | null
flagshipFundVintageDate string | null
flagshipFundVintageMonth number(int) | null
flagshipFundVintageYear number(int) | null
fte number(float) | null Latest available measurement of full-time equivalent (FTE) employees.
fteRange string | null
fteRangeCategory number(int) | null
fundsRaisedLastFiveYears number(float) | null Amount of funding raised by the investor in the last 5 years, measured in millions of original currency.
fundsRaisedLastFiveYearsEur number(float) | null Amount of funding raised by the investor in the last 5 years, measured in millions EUR.
gainProUrl string URL to the investor's page on Gain.pro.
live bool Deprecated. Will be removed from the API.
liveFundSizeEur number(float) | null
liveFundsCount number(int) | null
logoFileId number(int) | null
logoFileUrl string | null
name string
onlyIncludeCurated bool Deprecated. Will be removed from the API.
operationalHqCity string | null City of the headquarters
operationalHqCountryCode string | null ISO-2 country code for the headquarters. Slightly more accurate, but less frequently available than field region
operationalHqFormattedAddress string | null Formatted address of the headquarters
operationalHqRegion string | null Region (e.g. state or province) of the headquarters
operationalHqWgs84LngLat Point | null Geographical coordinates of the headquarters in WGS84 format
publicationDate string(rfc3339) | null
shortName string | null
status string(InvestorStatus)
url string | null URL to the investor's website.
yearFounded number(int) | null Founding year of the investor.
Description

Type reference

Type
LegalEntity ⎯
Properties
Name Type Description
id number(int)
annualReports array(AnnualReport)
annualReportsCheckedAt string(rfc3339) | null Only relevant for internal use.
assets array(AssetLegalEntity)
automaticallyCreated bool Only relevant for internal use.
countryCode string | null ISO 3166-1 alpha-2 country code.
createdAt string(rfc3339) | null Only relevant for internal use.
currency string Currency in which the entity's financials are reported.
externalId string ID as found at the national register (e.g. Companies House).
financialLatests LegalEntityLatestFinancials | null
financialResults array(LegalEntityFinancialResult)
financialsUpdatedAt string(rfc3339) | null Only relevant for internal use.
globalUltimateOwnerId number(int) | null
legalEntityShareholders array(LegalEntityShareholder)
listOfShareholders array(ListOfShareholders) Only relevant for internal use.
name string Name as registered at the national register.
nameYear number(int) Year in which the Name was determined.
previousNames array(string) Names previously registered at the national register.
rating LegalEntityRating | null
region string Deprecated: Use CountryCode
sectorCodes array(LegalEntitySectorCode)
shouldCheckFinancials bool Only relevant for internal use.
uRLs array(LegalEntityUrl) Deprecated: Use urls
urls array(Url) Website URLs associated with this entity
Description

Type reference

Type
LegalEntityFinancialResult ⎯
Properties
Name Type Description
id number(int)
balanceFromAnnualReportId number(int) | null
capex number(float) | null
capexFromAnnualReportId number(int) | null
capital number(float) | null
cash number(float) | null
cashFlowFromAnnualReportId number(int) | null
debt number(float) | null
ebit number(float) | null
ebitPctRevenue number(float) | null
ebitda number(float) | null
ebitdaPctRevenue number(float) | null
fte number(float) | null
fteGrowthPct number(float) | null
grossMargin number(float) | null
grossMarginPctRevenue number(float) | null
inventory number(float) | null
legalEntityId number(int)
netDebt number(float) | null
notesOperatingProfitUKFromAnnualReportId number(int) | null
payables number(float) | null
profitAndLossFromAnnualReportId number(int) | null
receivables number(float) | null
revenue number(float) | null
revenueYoyGrowthPct number(float) | null
totalAssets number(float) | null
year number(int)
Description

Type reference

Type
LegalEntityLatestFinancials ⎯
Properties
Name Type Description
ebitda number(float) | null
ebitdaAvg number(float) | null
ebitdaPctRevenue number(float) | null
ebitdaPctRevenueAvg number(float) | null
ebitdaPctRevenueResults array(number(float))
ebitdaPctRevenueYears array(number(int))
ebitdaResults array(number(float))
ebitdaYear number(int) | null
ebitdaYears array(number(int))
fte number(float) | null
fteResults array(number(float))
fteYear number(int) | null
fteYears array(number(int))
grossMargin number(float) | null
grossMarginResults array(number(float))
grossMarginYear number(int) | null
grossMarginYears array(number(int))
legalEntityId number(int)
revenue number(float) | null
revenueResults array(number(float))
revenueYear number(int) | null
revenueYears array(number(int))
revenueYoyGrowthPctMax number(float) | null
revenueYoyGrowthPctMin number(float) | null
Description

Type reference

Type
LegalEntityList ⎯
Properties
Name Type Description
args ListArgs
counts ListCounts
items array(LegalEntityListItem)
Description

Type reference

Type
LegalEntityListItem ⎯
Properties
Name Type Description
id number(int)
annualReportsCheckedAt string(rfc3339) | null
assetIds array(number(int))
assetNames array(string)
assetUrls array(string) Deprecated: No longer actively maintained.
currency string
ebitda number(float) | null
ebitdaAvg number(float) | null
ebitdaAvgEur number(float) | null
ebitdaEur number(float) | null
ebitdaPctRevenue number(float) | null
ebitdaPctRevenueAvg number(float) | null
ebitdaPctRevenueResults array(number(float))
ebitdaPctRevenueYears array(number(int))
ebitdaResults array(number(float))
ebitdaYear number(int) | null
ebitdaYears array(number(int))
externalId string
financialsUpdatedAt string(rfc3339) | null
fte number(float) | null
fteResults array(number(float))
fteYear number(int) | null
fteYears array(number(int))
grossMargin number(float) | null
grossMarginEur number(float) | null
grossMarginResults array(number(float))
grossMarginYear number(int) | null
grossMarginYears array(number(int))
name string
nameYear number(int)
previousNames array(string)
ratingConversion number(float) | null
ratingEbitda number(float) | null
ratingGrossMargin number(float) | null
ratingGrowth number(float) | null
ratingOverall number(float) | null
region string
revenue number(float) | null
revenueEur number(float) | null
revenueResults array(number(float))
revenueYear number(int) | null
revenueYears array(number(int))
revenueYoyGrowthPctMax number(float) | null
revenueYoyGrowthPctMin number(float) | null
sector string
subsector string
tagIds array(number(int))
tags array(string)
webUrl string Deprecated: No longer actively maintained.
Description

Type reference

Type
LegalEntityRating ⎯
Properties
Name Type Description
conversion number(float) | null
ebitda number(float) | null
grossMargin number(float) | null
growth number(float) | null
legalEntityId number(int)
overall number(float) | null
Description

Type reference

Type
LegalEntitySectorCode ⎯
Properties
Name Type Description
id number(int)
legalEntityId number(int)
order number(int)
sectorCodeId number(int)
Description

Type reference

Type
LegalEntityShareholder ⎯
Properties
Name Type Description
id number(int)
confirmedOn string(rfc3339) | null
countryCode string | null
legalEntityId number(int)
linkedLegalEntityId number(int) | null
name string
percentageShareExact number(float) | null
percentageShareMax number(float) | null
percentageShareMin number(float) | null
region string Deprecated, use CountryCode instead
shareholderExternalId string
type string(LegalEntityShareholderType)
Description

Type reference

Type
LegalEntityTreeNode ⎯
Properties
Name Type Description
countryCode string | null
externalId string
legalEntityId number(int)
name string
parentId number(int) | null
Description

Type reference

Type
LegalEntityUrl ⎯
Properties
Name Type Description
id number(int)
checkedAt string(rfc3339) | null
domain string
legalEntityId number(int)
method string(LegalEntityUrlMethod)
order number(int)
source string(LegalEntityUrlSource)
uRL string
Description

Type reference

Type
Lender ⎯
Properties
Name Type Description
id number(int)
aliases array(LenderAlias)
createdAt string(rfc3339)
credits array(LenderCredit) List of credits linked to this lender.
linkedInExternalId number(int) | null
live bool
logoFileId number(int)
logoFileUrl string
name string
operationalHqCity string
operationalHqCountryCode string
publishedAt string(rfc3339) | null
type string(LenderType)
unpublishedAt string(rfc3339) | null
updatedAt string(rfc3339)
urls array(Url) URLs associated with this lender
yearFounded number(int) | null
Description

Type reference

Type
LenderAlias ⎯
Properties
Name Type Description
id number(int)
alias string
lenderId number(int)
order number(int)
Description

Type reference

Type
LenderAssetList ⎯
Properties
Name Type Description
args ListLenderAssetsArgs
counts ListCounts
items array(LenderAssetListItem)
Description

Type reference

Type
LenderAssetListItem ⎯
Properties
Name Type Description
assetCreditCount number(int)
assetDescription string | null
assetFte number(float) | null
assetFteRange string | null
assetFteYear number(int) | null
assetId number(int) | null
assetLogoFileUrl string | null
assetName string
creditAvgCouponBps number(float) | null
creditMostRecentDealMonth number(int) | null
creditMostRecentDealYear number(int) | null
creditTotalDebtQuantumEur number(float) | null
Description

Type reference

Type
LenderCredit ⎯
Properties
Name Type Description
id number(int)
creditId number(int)
lenderId number(int)
order number(int)
Description

Type reference

Type
LenderCreditCountPerYear ⎯
Properties
Name Type Description
count number(int)
year number(int)
Description

Type reference

Type
LenderCreditCountryCodeCount ⎯
Properties
Name Type Description
count number(int)
countryCode string
Description

Type reference

Type
LenderCreditSubsectorCount ⎯
Properties
Name Type Description
count number(int)
subsector string
Description

Type reference

Type
LenderCreditTypeAndSubtypeCount ⎯
Properties
Name Type Description
count number(int)
typeAndSubtype string
Description

Type reference

Type
LenderInvestorAsset ⎯
Properties
Name Type Description
id number(int)
logoFileUrl string | null
name string
Description

Type reference

Type
LenderInvestorList ⎯
Properties
Name Type Description
args ListLenderInvestorsArgs
counts ListCounts
items array(LenderInvestorListItem)
Description

Type reference

Type
LenderInvestorListItem ⎯
Properties
Name Type Description
assetCount number(int)
creditCount number(int)
investorId number(int)
investorLogoFileUrl string | null
investorName string
latestDealMonth number(int) | null
latestDealYear number(int) | null
linkedAssets array(LenderInvestorAsset)
medianDebtQuantumEur number(float) | null
totalDebtQuantumEur number(float) | null
Description

Type reference

Type
LenderList ⎯
Properties
Name Type Description
args ListArgs
counts ListCounts
items array(LenderListItem)
Description

Type reference

Type
LenderListItem ⎯
Properties
Name Type Description
id number(int)
assetMedianDebtQuantumEur number(float) | null Median credit debt quantum per company in EUR.
assetMedianEbitdaEur number(float) | null Median EBITDA in EUR of linked credit target assets.
assetRegions array(string) Headquarters of linked credit target assets.
assetSectors array(string) Sectors of linked credit target assets.
assetSubsectors array(string) Subsectors of linked credit target assets.
assetTagIds array(number(int)) Tags of linked credit target assets.
creditAverageCouponBps number(float) | null Average coupon rate in percent.
creditCount number(int) Number of credits issued by this lender.
creditLastIssuedAt string(rfc3339) | null Last time a credit was issued by this lender.
creditTotalDebtQuantumEur number(float) | null Total debt quantum in EUR.
creditTypeAndSubtypes array(string) Types and substypes of credits issued by this lender.
credits array(LinkedCredit)
creditsFiltered number(int)
filteredAssetMedianDebtQuantumEur number(float) | null
filteredAssetMedianEbitdaEur number(float) | null
filteredCreditAverageCouponBps number(float) | null
filteredCreditLastIssuedAt string(rfc3339) | null
filteredCreditTotalDebtQuantumEur number(float) | null
filteredCreditTypeAndSubtypes array(string)
gainProUrl string URL to the lender's page on Gain.pro.
linkedInUrl string | null Url of the website associated with this lender.
live bool
logoFileUrl string
name string Name of the lender.
operationalHqCity string | null City where the lender's headquarters is located.
operationalHqCountryCode string | null Country code of the lender's operational headquarters.
publishedAt string(rfc3339)
type string(LenderType) Type of the lender.
url string | null Url of the website associated with this lender.
yearFounded number(int) | null The year the lender was founded.
Description

Type reference

Type
LenderSummary ⎯
Properties
Name Type Description
id number(int)
assetMedianDebtQuantumEur number(float) | null Median credit debt quantum per company in EUR.
assetMedianEbitdaEur number(float) | null Median EBITDA in EUR of linked credit target assets.
assetRegions array(string) Headquarters of linked credit target assets.
assetSectors array(string) Sectors of linked credit target assets.
assetSubsectors array(string) Subsectors of linked credit target assets.
assetTagIds array(number(int)) Tags of linked credit target assets.
creditAverageCouponBps number(float) | null Average coupon rate in percent.
creditCount number(int) Number of credits issued by this lender.
creditLastIssuedAt string(rfc3339) | null Last time a credit was issued by this lender.
creditTotalDebtQuantumEur number(float) | null Total debt quantum in EUR.
creditTypeAndSubtypes array(string) Types and substypes of credits issued by this lender.
gainProUrl string URL to the lender's page on Gain.pro.
linkedInUrl string | null Url of the website associated with this lender.
live bool
logoFileUrl string
name string Name of the lender.
operationalHqCity string | null City where the lender's headquarters is located.
operationalHqCountryCode string | null Country code of the lender's operational headquarters.
publishedAt string(rfc3339)
type string(LenderType) Type of the lender.
url string | null Url of the website associated with this lender.
yearFounded number(int) | null The year the lender was founded.
Description

Type reference

Type
LinkedCredit ⎯
Properties
Name Type Description
assetId number(int) | null
assetLogoFileUrl string | null
assetName string | null
creditId number(int)
Description

Type reference

Type
LinkedLender ⎯
Properties
Name Type Description
id number(int)
logoFileUrl string
name string
Description

Type reference

Type
LinkedProfile ⎯
Properties
Name Type Description
id number(int)
advisorId number(int) | null
assetId number(int) | null
globalLogoFileId number(int) | null
globalName string
investorId number(int) | null
lenderId number(int) | null
Description

Type reference

Type
LinkedProfileItem ⎯
Properties
Name Type Description
advisor AdvisorSummary | null
asset AssetSummary | null
investor InvestorSummary | null
lender LenderSummary | null
Description

Type reference

Type
ListArgs ⎯
Properties
Name Type Description
filter array(Filter) A filter field must match with a property from the returned list item type. The value must match the type of the corresponding property and can be wrapped in an array to create an or clause of multiple values for the given filter. When combing multiple filters the results will match all of the given filters
limit number(int)
page number(int)
prompt string Only relevant for internal use.
promptObjectIds array(number(int)) Only relevant for internal use.
search string
sort array(string) The sort field must match with a property from the returned list item type. The results will be ordered in ascending order by default, prefix the field with a dash to order in descending order. Multiple sort fields will sort the results by the given combination.
Description

Type reference

Type
ListCounts ⎯
Properties
Name Type Description
filtered number(int)
total number(int)
Description

Type reference

Type
ListLenderAssetsArgs ⎯
Properties
Name Type Description
filter array(Filter) A filter field must match with a property from the returned list item type. The value must match the type of the corresponding property and can be wrapped in an array to create an or clause of multiple values for the given filter. When combing multiple filters the results will match all of the given filters
lenderId number(int)
limit number(int)
page number(int)
prompt string Only relevant for internal use.
promptObjectIds array(number(int)) Only relevant for internal use.
search string
sort array(string) The sort field must match with a property from the returned list item type. The results will be ordered in ascending order by default, prefix the field with a dash to order in descending order. Multiple sort fields will sort the results by the given combination.
Description

Type reference

Type
ListLenderInvestorsArgs ⎯
Properties
Name Type Description
filter array(Filter) A filter field must match with a property from the returned list item type. The value must match the type of the corresponding property and can be wrapped in an array to create an or clause of multiple values for the given filter. When combing multiple filters the results will match all of the given filters
lenderId number(int)
limit number(int)
page number(int)
prompt string Only relevant for internal use.
promptObjectIds array(number(int)) Only relevant for internal use.
search string
sort array(string) The sort field must match with a property from the returned list item type. The results will be ordered in ascending order by default, prefix the field with a dash to order in descending order. Multiple sort fields will sort the results by the given combination.
Description

Type reference

Type
ListOfShareholders ⎯
Properties
Name Type Description
id number(int)
checkedAt string(rfc3339)
documentDate string(rfc3339) | null
fileId number(int) | null
legalEntityId number(int)
Description

Type reference

Type
ListedSecurityBrokerRecommendation ⎯
Properties
Name Type Description
id number(int)
buyCount number(int)
endDate string(rfc3339)
holdCount number(int)
listedSecurityId number(int)
periodicity string(BrokerRecommendationPeriodicity)
sellCount number(int)
startDate string(rfc3339)
Description

Type reference

Type
ListedSecurityChartData ⎯
Properties
Name Type Description
brokerRecommendation array(ListedSecurityBrokerRecommendation)
sharePrice array(ListedSecurityPrice)
Description

Type reference

Type
ListedSecurityList ⎯
Properties
Name Type Description
args ListArgs
counts ListCounts
items array(ListedSecurityListItem)
Description

Type reference

Type
ListedSecurityListItem ⎯
Properties
Name Type Description
id number(int)
name string | null
tradingCurrency string | null
Description

Type reference

Type
ListedSecurityPrice ⎯
Properties
Name Type Description
id number(int)
date string(rfc3339)
listedSecurityId number(int)
price number(float)
Description

Type reference

Type
ListedSecurityValuationMetrics ⎯
Properties
Name Type Description
enterpriseValue number(float) | null
enterpriseValueEbitdaRatioLastTwelveMonths number(float) | null
enterpriseValueRevenueRatioLastTwelveMonths number(float) | null
marketCap number(float) | null
sharePrice number(float) | null
targetPrice number(float) | null
Description

Type reference

Type
ListedSecurityValuationRatios ⎯
Properties
Name Type Description
id number(int)
enterpriseValueEbitRatio number(float) | null
enterpriseValueEbitdaMinusCapexRatio number(float) | null
enterpriseValueEbitdaRatio number(float) | null
enterpriseValueFreeCashFlowRatio number(float) | null
enterpriseValueInvestedCapitalRatio number(float) | null
enterpriseValueRevenueRatio number(float) | null
financialResultFiscalEndDate string(rfc3339)
financialResultFiscalQuarter number(int)
financialResultFiscalYear number(int)
financialResultPeriodicity string(FinancialResultPeriodicityType)
listedSecurityValuationId number(int)
Description

Type reference

Type
MultiPolygon ⎯
Properties
Name Type Description
Description

Type reference

Type
NewsArticleList ⎯
Properties
Name Type Description
args ListArgs
counts ListCounts
items array(NewsArticleListItem)
Description

Type reference

Type
NewsArticleListItem ⎯
Properties
Name Type Description
id number(int)
body string
eventMonth number(int)
eventYear number(int)
headline string
linkedAnnualReportFileId number(int) | null
linkedAssetId number(int) | null
linkedDealId number(int) | null
logoFileUrl string | null
publishedAt string(rfc3339)
type string(NewsArticleType)
year number(int) | null
Description

Type reference

Type
Person ⎯
Properties
Name Type Description
id number(int)
birthYear number(int) | null
createdAt string(rfc3339)
firstName string
investorId number(int) | null Deprecated: will be removed in the future
lastName string
linkedInUrl string | null
linkedinConnectionsCount number(int) | null
linkedinPersonId string | null Deprecated: will be removed in the future
live bool
locationRegion string | null
nationality string | null
publishedAt string(rfc3339) | null
unpublishedAt string(rfc3339) | null
updatedAt string(rfc3339)
Description

Type reference

Type
PersonExperience ⎯
Properties
Name Type Description
id number(int) Unique identifier for the person experience
advisorId number(int) | null The advisor linked to the person experience
assetId number(int) | null The asset linked to the person experience
createdAt string(rfc3339)
employedCountryCode string | null ISO 3166-2 country code where the person is based on
endDay number(int) | null Day the person ended working in the position
endMonth number(int) | null Month the person ended working in the position
endYear number(int) | null Year the person ended working in the position
investorId number(int) | null The investor linked to the person experience
lenderId number(int) | null The lender linked to the person experience
manuallyCreated bool Only relevant for internal use.
order number(int) Deprecated. No longer maintained
person Person | null Details of the person. See type definition.
personId number(int) | null Unique identifier for the person
position string | null Uncategorized position title.
positionType string(PersonExperiencePositionType) | null() Categorized position
relevanceOrder number(int) Ranking based on an position type.
startDay number(int) | null Day the person started working in the position
startMonth number(int) | null Month the person started working in the position
startYear number(int) | null Year the person started working in the position
status string(PersonExperienceStatusType) Only relevant for internal use.
unverifiedPersonExperienceId number(int) | null
updatedAt string(rfc3339)
Description

Type reference

Type
PersonList ⎯
Properties
Name Type Description
args ListArgs
counts ListCounts
items array(PersonListItem)
Description

Type reference

Type
PersonListItem ⎯
Properties
Name Type Description
id number(int)
assetCount number(int) | null
assetIds array(number(int))
assets array(PersonListItemAsset)
birthYear number(int) | null
firstName string
fullName string
investorId number(int) | null Deprecated: will be removed in the future
investorName string | null Deprecated: will be removed in the future
lastName string
linkedInUrl string | null
locationRegion string | null
nationality string | null
regions array(string)
sectors array(string)
subsectors array(string)
Description

Type reference

Type
PersonListItemAsset ⎯
Properties
Name Type Description
id number(int)
joinMonth number(int) | null
joinYear number(int) | null
logoFileUrl string
managementPosition string | null
name string
position string | null Deprecated: Use ManagementPosition instead.
region string | null Deprecated: will be removed in the future
sector string | null Deprecated: will be removed in the future
subsector string | null Deprecated: will be removed in the future
webUrl string Deprecated: will be removed in the future
Description

Type reference

Type
Point ⎯
Properties
Name Type Description
Description

Type reference

Type
RegionList ⎯
Properties
Name Type Description
args ListArgs
counts ListCounts
items array(RegionListItem)
Description

Type reference

Type
RegionListItem ⎯
Properties
Name Type Description
id number(int)
name string
title string
Description

Type reference

Type
RelatedConferenceEdition ⎯
Properties
Name Type Description
id number(int)
assets array(RelatedConferenceEditionAsset)
endDate string(rfc3339)
logoFileUrl string | null
name string
startDate string(rfc3339)
tagIds array(number(int))
tagNames array(string)
venueCity string
venueCountryCode string
Description

Type reference

Type
RelatedConferenceEditionAsset ⎯
Properties
Name Type Description
id number(int) | null
logoFileUrl string | null
name string
Description

Type reference

Type
RelatedDealAdvisor ⎯
Properties
Name Type Description
advisorId number(int)
advisorLogoFileUrl string | null
advisorName string
assets array(DealAdvisorAsset)
assetsCount number(int)
coreFocus string(AdvisoryActivity)
dealCount number(int)
dealEbitdasEur array(number(float))
dealIds array(number(int))
Description

Type reference

Type
RelatedDealAdvisorList ⎯
Properties
Name Type Description
count number(int)
items array(RelatedDealAdvisor)
Description

Type reference

Type
SalesforceItem ⎯
Properties
Name Type Description
assetId number(int)
error string
name string | null
status string(SalesforceStatus)
url string
Description

Type reference

Type
SearchResultItem ⎯
Properties
Name Type Description
id number(int)
description string | null
imageId number(int) | null
imageUrl string | null
linkedProfile LinkedProfileItem | null
matchedField string
matchedTerm string
name string
regions array(string)
score number(float)
similarity number(float)
type string(SearchItemType)
Description

Type reference

Type
Sector ⎯
Properties
Name Type Description
id number(int)
imageFileId number(int) | null
imageFileUrl string | null
imageLargeFileId number(int) | null
imageLargeFileUrl string | null
name string
title string
Description

Type reference

Type
SectorList ⎯
Properties
Name Type Description
args ListArgs
counts ListCounts
items array(Sector)
Description

Type reference

Type
SimilarAssetDealsList ⎯
Properties
Name Type Description
args ListArgs
counts ListCounts
items array(SimilarAssetDealsListItem)
Description

Type reference

Type
SimilarAssetDealsListItem ⎯
Properties
Name Type Description
id number(int) Unique identifier for the deal.
advisorIds array(number(int)) Identifiers for the advisors involved in the deal.
announcementDate string Date when the deal was announced, formatted as YYYY-MM.
announcementDateMonth number(int) | null Month when the deal was announced.
announcementDateYear number(int) | null Year when the deal was announced.
asset string | null The target asset involved in the deal.
assetGainProUrl string | null URL to the asset's page on Gain.pro.
assetLogoFileUrl string | null URL of the logo file for the asset.
assetWebUrl string | null
bidderAssetIds array(number(int)) ID of bidders that are Asset objects. Can be used to filter deals where a known asset was a bidder.
bidderFundIds array(number(int)) ID of the the linked investor fund associated.
bidderInvestorIds array(number(int)) Analogous to BidderAssetIds, but for Investor objects.
bidderLogoFileUrls array(string) Only relevant for internal use.
bidderReasons array(string(DealReason)) All known DealReasons of bidders. Can be used for filtering deals by reasoning.
bidderSharePcts array(number(float)) All known percentage stakes acquired by buyers. Useful for filtering.
bidderShares array(string(DealSideShare)) All known types of shares acquired by buyers. Can be used for filtering deals by type of stake acquired.
bidderStrategyIds array(number(int)) ID of the the linked investor strategies associated.
buyerAdvisorIds array(number(int)) IDs of advisors who advised the buyers.
buyerAssetIds array(number(int)) ID of buyers that are Asset objects. Can be used to filter deals where a known asset was a buyer.
buyerAssetNames array(string) Only relevant for internal use. Use BuyersInfo instead.
buyerFundIds array(number(int)) ID of the the linked investor fund associated.
buyerInvestorIds array(number(int)) Analogous to BuyerAssetIds, but for Investor objects.
buyerInvestorNames array(string) Only relevant for internal use. Use BuyersInfo instead.
buyerLeadingParties array(bool) Only relevant for internal use. Use BuyersInfo instead.
buyerLinkedIds array(number(int)) Only relevant for internal use. Use BuyersInfo instead.
buyerLogoFileUrls array(string) Only relevant for internal use.
buyerNames array(string) Only relevant for internal use. Use BuyersInfo instead.
buyerReasons array(string(DealReason)) All known DealReasons of buyers. Can be used for filtering deals by reasoning. For a full overview of buyer info, see BuyersInfo instead.
buyerSharePcts array(number(float)) All known percentage stakes acquired by buyers. Useful for filtering. For a full overview of buyer info, see BuyersInfo instead.
buyerShares array(string(DealSideShare)) All known types of shares acquired by buyers. Can be used for filtering deals by type of stake acquired. For a full overview of buyer info, see BuyersInfo instead.
buyerStrategyIds array(number(int)) ID of the the linked investor strategies associated.
buyerTypes array(string(DealSideType)) Only relevant for internal use. Use BuyersInfo instead.
buyers number(int) Deprecated: will be removed
buyersInfo array(DealSummarySide)
countryCode string | null ISO-2 code indicating the HQ country of the target asset.
currency string | null Currency of the deal facts.
dealStatus string(DealStatus) Status of the deal's progress, if it has not (yet) been completed.
dealType string(DealType) | null() Deprecated. Will be removed from the API.
division string | null Division of the target asset involved in the deal.
ebit number(float) | null Earnings before interest and taxes of the target company.
ebitEur number(float) | null EBIT of the target company in EUR.
ebitYear number(int) | null Year of the EBIT data.
ebitda number(float) | null Earnings before interest, taxes, depreciation, and amortization of the target company.
ebitdaEur number(float) | null EBITDA of the target company in EUR.
ebitdaYear number(int) | null Year of the EBITDA data.
equity number(float) | null Equity value of the target company.
equityEur number(float) | null Equity value of the target company in EUR.
equityYear number(int) | null Year of the equity value data.
ev number(float) | null Enterprise value of the target company as determined in the deal.
evEbitMultiple number(float) | null Enterprise value to EBIT multiple.
evEbitMultipleYear number(int) | null Year of the EV to EBIT multiple data.
evEbitdaMultiple number(float) | null Enterprise value to EBITDA multiple.
evEbitdaMultipleYear number(int) | null Year of the EV to EBITDA multiple data.
evEur number(float) | null Enterprise value of the target company in EUR.
evRevenueMultiple number(float) | null Enterprise value to revenue multiple.
evRevenueMultipleYear number(int) | null Year of the EV to revenue multiple data.
evTotalAssetsMultiple number(float) | null Enterprise value to total assets multiple.
evTotalAssetsMultipleYear number(int) | null Year of the EV to total assets multiple data.
evYear number(int) | null Year of the enterprise value data.
fte number(float) | null Number of full-time employees of the target company.
fteYear number(int) | null Year of the full-time employee count.
fundingRoundAmountRaised number(float) | null Amount raised in the funding round.
fundingRoundAmountRaisedEur number(float) | null Amount raised in the funding round in EUR.
fundingRoundAmountRaisedYear number(int) | null Deprecated: Use publication year instead.
fundingRoundPostMoneyValuation number(float) | null Post-money valuation for the funding round.
fundingRoundPostMoneyValuationEur number(float) | null Post-money valuation for the funding round in EUR.
fundingRoundPostMoneyValuationYear number(int) | null Year of the post-money valuation data.
fundingRoundPreMoneyValuation number(float) | null Pre-money valuation for the funding round.
fundingRoundPreMoneyValuationEur number(float) | null Pre-money valuation for the funding round in EUR.
fundingRoundPreMoneyValuationYear number(int) | null Year of the pre-money valuation data.
fundingRoundType string(DealFundingRoundType) | null() Type of the funding round, such as Series A, B, C, etc.
gainProUrl string URL to the deal page on Gain.pro.
gainProUrl string URL to the deal page on Gain.pro.
highlightedBuyerDivision string | null Division of the highlighted buyer.
highlightedBuyerId number(int) | null Identifier for the highlighted (most notable) buyer.
highlightedBuyerName string | null Name of the highlighted buyer.
highlightedBuyerReason string(DealReason) | null() Reason for the highlighted buyer's involvement in the deal.
highlightedBuyerRegion string | null ISO-2 code indicating the HQ country of the highlighted buyer.
highlightedBuyerShare string(DealSideShare) | null() Share of the highlighted buyer in the deal.
highlightedBuyerSharePct number(float) | null Percentage share acquired by the highlighted buyer in the deal.
highlightedBuyerType string(DealSideType) | null() Type of the highlighted buyer, such as investor or asset.
highlightedSellerDivision string | null See equivalent buyers field.
highlightedSellerId number(int) | null See equivalent buyers field.
highlightedSellerName string | null See equivalent buyers field.
highlightedSellerReason string(DealReason) | null() See equivalent buyers field.
highlightedSellerRegion string | null See equivalent buyers field.
highlightedSellerShare string(DealSideShare) | null() See equivalent buyers field.
highlightedSellerSharePct number(float) | null See equivalent buyers field.
highlightedSellerType string(DealSideType) | null() See equivalent buyers field.
investorIds array(number(int)) Identifiers for the investors involved in the deal.
linkedAssetDescription string | null Description of the linked asset.
linkedAssetId number(int) | null Identifier for the linked asset associated with the deal.
linkedAssetUrl string | null Url of the linked asset associated with the deal.
live bool True if the deal is currently published on Gain.pro.
publicationDate string(rfc3339) | null The date when the deal was published on Gain.pro.
reasons array(string(DealReason)) Aggregation of reasons for involvement of all deal sides. See individual deal buyers and sellers.
region string | null ISO-2 code indicating the HQ country of the target asset.
relevanceRank number(int)
revenue number(float) | null Revenue of the target company.
revenueEur number(float) | null Revenue of the target company in EUR.
revenueYear number(int) | null Year of the revenue data.
sector string | null Sector of the target asset.
sellerAdvisorIds array(number(int)) IDs of advisors who advised the sellers.
sellerAssetIds array(number(int)) See equivalent buyers field.
sellerAssetNames array(string) Only relevant for internal use. Use SellersInfo instead.
sellerFundIds array(number(int)) See equivalent buyers field.
sellerInvestorIds array(number(int)) See equivalent buyers field.
sellerInvestorNames array(string) Only relevant for internal use. Use SellersInfo instead.
sellerLeadingParties array(bool) Only relevant for internal use. Use SellersInfo instead.
sellerLinkedIds array(number(int)) Only relevant for internal use. Use SellersInfo instead.
sellerLogoFileUrls array(string) See equivalent buyers field.
sellerNames array(string) Only relevant for internal use. Use SellersInfo instead.
sellerReasons array(string(DealReason)) See equivalent buyers field.
sellerSharePcts array(number(float)) See equivalent buyers field.
sellerShares array(string(DealSideShare)) See equivalent buyers field.
sellerStrategyIds array(number(int)) See equivalent buyers field.
sellerTypes array(string(DealSideType)) Only relevant for internal use. Use SellersInfo instead.
sellers number(int) Deprecated: will be removed
sellersInfo array(DealSummarySide)
subsector string | null Subsector of the target asset.
tagIds array(number(int)) Identifiers for the tags applied to the deal target.
tags array(string) Tags applied to the deal target.
totalAssets number(float) | null Total assets of the target company.
totalAssetsEur number(float) | null Total assets of the target company in EUR.
totalAssetsYear number(int) | null Year of the total assets data.
type string Type of deal object. Automated deals were sourced without human curation.
webUrl string
Description

Type reference

Type
Source ⎯
Properties
Name Type Description
publicationMonth number(int) | null The month the source was published
publicationYear number(int) | null The year the source was published
title string The title of the source
url string | null URL where the source can be found
usedFor array(string) Where the sources is used for. Eg. [assetFinancials, assetBusiness, assetBackground]
Description

Type reference

Type
StreamIterator ⎯
Properties
Name Type Description
Description

Type reference

Type
Subsector ⎯
Properties
Name Type Description
id number(int)
imageFileId number(int) | null
imageFileUrl string | null
imageLargeFileId number(int) | null
imageLargeFileUrl string | null
name string
sector string
title string
Description

Type reference

Type
SubsectorList ⎯
Properties
Name Type Description
args ListArgs
counts ListCounts
items array(Subsector)
Description

Type reference

Type
SuggestCityResponse ⎯
Properties
Name Type Description
description string
googlePlaceId string
Description

Type reference

Type
SuggestedTag ⎯
Properties
Name Type Description
id number(int)
assetCount number(int)
name string
Description

Type reference

Type
TagList ⎯
Properties
Name Type Description
args ListArgs
counts ListCounts
items array(TagListItem)
Description

Type reference

Type
TagListItem ⎯
Properties
Name Type Description
id number(int)
assetCount number(int)
name string
Description

Type reference

Type
TicketAttribute ⎯
Properties
Name Type Description
type string(TicketAttributeType)
value any
Description

Type reference

Type
Url ⎯
Properties
Name Type Description
id number(int)
advisorId number(int) | null The advisor this URL belongs to
assetId number(int) | null The asset this URL belongs to
domain string Full domain name, includes sub-, second- & top-level domain, e.g. www.google.com. Unique per data type
investorId number(int) | null The investor this URL belongs to
isIndexed bool If a URL is indexed, it is used in matching
isPrimary bool The primary/main URL that is shown in the app, must be unique per asset, advisor, investor or legal entity
legalEntityId number(int) | null The legal entity this URL belongs to
lenderId number(int) | null The lender this URL belongs to
url string Full URL, e.g. https://www.google.com/index.html
Description

Type reference

Type
UserAccount ⎯
Properties
Name Type Description
id number(int)
createdAt string(rfc3339)
currency string
customerId number(int)
deactivatedAt string(rfc3339) | null
deactivatedReason string
email string
emailNewsFeedEnabled bool
emailNewsFeedLastSentAt string(rfc3339) | null
emailResearchUpdates bool
emailResearchUpdatesLastSentAt string(rfc3339) | null
emailSourcingUpdates bool
emailSourcingUpdatesLastSentAt string(rfc3339) | null
failedLoginCount number(int)
firstName string
hasSoleOwnerSharedBookmarkLists bool
invitationExpired bool
invitationLink string
invitationSentAt string(rfc3339)
isApiUser bool
isSsoUser bool
lastAccessAt string(rfc3339) | null
lastFailedLogin string(rfc3339) | null
lastName string
onboardedAt string(rfc3339) | null
recommendRegions array(string)
recommendSubsectors array(string)
role string(UserRole)
status string(UserStatus)
unitSystem string(UserUnitSystem)
username string
Description

Type reference

Type
UserList ⎯
Properties
Name Type Description
args ListArgs
counts ListCounts
items array(UserListItem)
Description

Type reference

Type
UserListItem ⎯
Properties
Name Type Description
customerId number(int)
email string
firstName string
lastAccessAt string(rfc3339) | null
lastName string
role string(UserRole)
status string
userId number(int)
username string
Description

Type reference

Type
UserPermission ⎯
Properties
Name Type Description
id number(int)
addedByUserId number(int) | null
createdAt string(rfc3339)
customerId number(int)
objectId number(int)
objectType string(UserPermissionObjectType)
role string(UserPermissionRole)
updatedAt string(rfc3339)
userId number(int)
Description

Type reference

Type
UserPermissionChange ⎯
Properties
Name Type Description
role string(UserPermissionRole)
userId number(int)
Description

Type reference

Type
UserProfile ⎯
Properties
Name Type Description
id number(int)
currency string
customerId number(int)
customerLogoUrl string
customerName string
email string
emailNewsFeedEnabled bool
emailResearchUpdates bool
emailSourcingUpdates bool
featureDealCloud bool
featureDisableAi bool
featureExportAdvisorsExportsThisMonth number(int)
featureExportAdvisorsMaxExportsPerMonth number(int)
featureExportAdvisorsMaxItemsPerExport number(int)
featureExportAnnualReportMaxPerMonth number(int)
featureExportAnnualReportThisMonth number(int)
featureExportAssetsExportsThisMonth number(int)
featureExportAssetsMaxExportsPerMonth number(int)
featureExportAssetsMaxItemsPerExport number(int)
featureExportCreditsMaxExportsPerMonth number(int)
featureExportCreditsMaxItemsPerExport number(int)
featureExportCreditsThisMonth number(int)
featureExportDealsExportsThisMonth number(int)
featureExportDealsMaxExportsPerMonth number(int)
featureExportDealsMaxItemsPerExport number(int)
featureExportFactsheetMaxPerMonth number(int)
featureExportFactsheetThisMonth number(int)
featureExportFinancials bool
featureExportFinancialsMaxPerMonth number(int)
featureExportFinancialsThisMonth number(int)
featureExportIndustryMaxPerMonth number(int)
featureExportIndustryThisMonth number(int)
featureExportLendersMaxExportsPerMonth number(int)
featureExportLendersMaxItemsPerExport number(int)
featureExportLendersThisMonth number(int)
featureExportOwnersExportsThisMonth number(int)
featureExportOwnersMaxExportsPerMonth number(int)
featureExportOwnersMaxItemsPerExport number(int)
featureSalesforce bool
featureSessionTracking bool
featureSessionTrackingTimeout number(seconds)
firstName string
intercomHmac string
isSsoUser bool
lastName string
recommendRegions array(string)
recommendSubsectors array(string)
role string(UserRole)
sessionTrackingProjectCode string | null
sessionTrackingProjectCodeUpdatedAt string(rfc3339) | null
unitSystem string(UserUnitSystem)
username string
Description

Type reference

Type
UserRecentVisitDetails ⎯
Properties
Name Type Description
id number(int)
description string | null
imageId number(int) | null
imageUrl string | null
lastViewedAt string(rfc3339)
name string
objectId number(int)
objectType string(ObjectType)
regions array(string)
userId number(int)
Description

Type reference

Type
UserRecentVisitList ⎯
Properties
Name Type Description
items array(UserRecentVisitDetails)
Description

Type reference

Type
UserSessionList ⎯
Properties
Name Type Description
args ListArgs
counts ListCounts
items array(UserSessionListItem)
Description

Type reference

Type
UserSessionListItem ⎯
Properties
Name Type Description
email string
firstName string
lastName string
sessionApiCalls number(int)
sessionDuration number(seconds)
sessionLastActivityAt string(rfc3339)
sessionProjectCode string
sessionStartedAt string(rfc3339)
userId number(int)
Description

Type reference

Type
ZendeskLogin ⎯
Properties
Name Type Description
jwt string
Description

Type reference

Type
beamerTranslation ⎯
Properties
Name Type Description
category string
content string
contentHtml string
images array(string)
language string
linkText string
linkUrl string
postUrl string
title string
Description

Errors

General JSONRPC errors
Error code Description
-32700 Invalid JSON was received by the server.
-32602 Invalid method parameter(s).
-32601 The method does not exist / is not available.
-32600 The JSON sent is not a valid Request object.
Application specific errors
Error code Description
-32012 Resource not found
-32009 Maximum amount of active users reached
-32007 Resource is offline
-32006 Resource is live
-32004 Invalid resource identifier
-32003 User not authorized
-32002 Invalid password / username combination
-32001 Invalid authentication token