Introduction
Welcome to Fintent API!
You can now access Fintent’s predictive scores like CapRaise Score, M&A Score, Distress Score or Deal-Maker Scores via our RESTful API.
For any questions and to get your API Key, reach out to [email protected]
Authentication
Fintent API uses an API key for authentication. The request Authorization header should be used.
Example Request
curl -H “Authorization: $API_KEY“ … |
Note that for the remainder of this document $API_KEY will stand in place of your API key.
Predictive Signals
This section covers retrieving Predictive Signals data from the Fintent API
Data Definitions
|
Attribute |
Type |
Description |
|
domain_name |
String |
domain = unique identifier of a company across Fintent data products |
|
company_profile_url |
String |
fintent’s company profile url |
|
last_update |
String |
date the scores were last updated |
|
signal_type |
String |
signal type: CapRaise Score, M&A Score, Distress Score, Deal-Maker Scores, etc |
|
score |
Float |
summary score for the last 4 weeks |
|
score_last_3mo |
Float |
summary score for the last 3 months |
|
score_last_6mo |
Float |
summary score for the last 6 months |
|
topic_1 |
String |
topics researched by volume |
|
topic_2 |
String |
topics researched by volume |
|
topic_3 |
String |
topics researched by volume |
|
deal-maker_1 |
String |
deal-maker researching company |
|
deal-maker_2 |
String |
deal-maker researching company |
|
deal-maker_3 |
String |
deal-maker researching company |
Input Parameters
There are two parameters to control the Predictive Signals data retrieved from the API:
|
Parameter |
Type |
Required |
Description |
|
domain |
String (Repeated) |
Yes |
One or more domains to retrieve the scores for |
Retrieval Methods
Financial Intent signals can be retrieved in one of two ways covered in the following sections:
GET
A GET HTTP request can be issued with domain as a repeated query parameter.
Example Request
|
curl -XGET -H “Authorization: $API_KEY“ ‘https://fintent-api.herokuapp.com/v1/capraise/search?domain=resilia.com&domain=test.com’ |
Example Response
|
{ “company_profile_url”: “https://app.fintent.ai/companies/3425533”, “last_update”: “20260222”, “signal_type”: “CapRaise Score”, “score”: “87.45”, “score_last_3_mo”: “63.26”, “score_last_6_mo”: “41.68”, “deal-maker_1”: “blackrock.com”,“, “deal-maker_2”: “plantemoran.com”, |
POST
A POST HTTP request can be issued with domain as a repeated query parameter.
General Info
This section covers general end points + info for the API
Limits
Usage of the Predictive Signals endpoints are tracked by API key. A single request of N domains incurs the following usage:
- 1 API call
- N domains
By default accounts have the following API limits:
- 60 requests per 5 minutes
- X number of weekly domains revealed
Usage
The usage endpoint can be used to understand the current usage associated with an API key.
To understand current usage, the following request can be made.
Example Request
curl -XGET -H “Authorization: $API_KEY“ ‘https://fintent-api.herokuapp.com/usage’ |
Example Response
{ |
Health
The health endpoint can be used to understand the health of the API. If the endpoint is not accessible, the API should be considered in an unhealthy state.
Example Request
|
curl -XGET ‘https://fintent-api.herokuapp.com/health’ |
Example Response
|
{ |
Errors
All errors from the Fintent API share a common format:
Example Response
{ |