API documentation

Returns the 100 most recent insider transactions. The endpoint accepts the following optional arguments:

country - Business entity's country in 2-letter ISO code format (e.g., SE).

min_amount - Minimum transaction amount in US dollars (e.g., $1000).

The response contains the following fields:

This API endpoint provides the buy/sell sentiment ratio for a specified country within the last specified number of months. The endpoint accepts the following optional arguments:

country - Business entity's country in 2-letter ISO code format (e.g., SE). If the 'country' attribute is omitted, the buy/sell ratio will be calculated for all countries.

months_ago - The number of previous months for which you are requesting data (minimum value: 1).

The response contains the following fields:

This API endpoint searches for tickers using a provided keyword. It returns the 30 closest search results. The endpoint accepts the following argument:

keyword - The 'keyword' field can contain any string or a portion of ISIN, a company name, LEI code, registration number.

The response contains an array consisting of the following fields:

Returns data about a given company/ticker. Use the UUID or slug value as a 'term' GET attribute. The data structure of the returned JSON is explained above.

Identical to the previous API endpoint, but also returns insider transactions associated with a given company. Please note that 'records' is an array of transactions and 'transactions' represent the total quantity of transactions.

The 'records' array may contain a maximum of 100 transactions. If the 'transactions' field indicates more than 100 transactions, you may pass an additional GET attribute 'page' to paginate the results.

The structure of the 'records' array is as follows:

Please give careful consideration to transactions flagged as 'long_term' = true, as they were executed by individuals known as long-term insiders within a specific company. These insiders have completed at least 10 transactions within the last 3 years.

API endpoint retrieves the historical UBSTA values, sorted by timestamp in descending order. The endpoint accepts the following argument:

isin - ISIN code.

API endpoint retrieves the most recent UBSTA value for a given company. The endpoint accepts the following argument:

isin - ISIN code.

The structure of the response is as follows:

This API endpoint searches for insiders using a provided keyword. It returns the 30 closest search results. You can use this endpoint in conjunction with the next endpoint by utilizing the 'slug' or 'uuid' attribute. The endpoint accepts the following argument:

keyword - The 'keyword' field can contain any string or a portion of a name.

The response contains the following fields:

This endpoint provides basic info about a given insider. Please utilize the 'slug' or 'uuid' attribute that you obtained from the previous endpoint.

When retrieving insider transactions through the API, kindly note that our methodology involves extensive data filtering.

term - is a UUID or slug associated with a specific insider.

The response contains the following fields:

The API endpoint below provides both insider information and transactions associated with a given insider. Please note that the total number of transactions is included in the 'transactions' field, and the API returns a maximum of 100 transactions per page. To paginate the response, simply add the GET parameter 'page'.

term - is a UUID or slug associated with a specific insider.

The response contains the following fields:

By default, the API endpoint returns the SITI index for the last 30 days. If you want to specify a particular timeframe for which you would like to retrieve the SITI value, you can include the 'start_date' and 'end_date' GET parameters in the format YYYY-mm-dd.

The response contains the following fields:

[{
"date": "2024-03-21T00:00:00.001Z",
"siti": 100,
"b_ratio": 1,
"s_ratio": 0,
"delta": 9508.01,
"total_amount": 9508.01
}]

"date" - The date for which SITI was calculated.
"siti" - The SITI index value.
"b_ratio" - The buy ratio, representing the percentage of 'buy' transactions for the given day.
"s_ratio" - The sell ratio, representing the percentage of 'sell' transactions for the given day.
"delta" - The difference between buy and sell transactions, measured in USD.
"total_amount" - The total amount of transactions within the day, measured in USD.

This API endpoint is similar to the previous one, but calculates the SITI index on a monthly basis. By default, the API endpoint returns the SITI index for the last 12 months. If you want to specify a particular timeframe for which you would like to retrieve the SITI value, you can include the 'start_date' and 'end_date' GET parameters in the format YYYY-mm-dd.

This API endpoint gives you the full list of companies in the SITI index.

The structure of the array is as follows:

This API endpoint retrieves the list of watchlists you've previously created

The response contains the following fields:

This API endpoint provides details about a specified watchlist. You should use the UUID that is visible in the previous API endpoint to identify the watchlist.

uuid - A UUID, or Universally Unique Identifier, is a 128-bit hexadecimal value that is used to uniquely identify data or entities in a system. It ensures that each watchlist has a distinct and unambiguous identifier.

The response contains the same fields as the previous one.

This API endpoint allows you to delete a specific watchlist using its UUID. The response will include a single field, 'status.' If the deletion was successful, the response will be {status: true}.

This API endpoint is used to create a new watchlist. You are required to provide at least one field, which is 'name.' Upon successful creation, the API will return the UUID of the newly created watchlist.

name - a watchlist title

companies - an array of companies you want to track, with two mandatory fields: 'name' and 'ISIN.'

This API endpoint is used to update an existing watchlist. It accepts updates to the 'name' and 'companies' fields. Upon successful update, it returns {'status': true}.