Fintent API Documentation

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 support@fintent.ai

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
date_month	String	date of the score
signal_type	String	name of the signal (CapRaise Score, M&A Score, Distress Score or Deal-Maker Scores)
rating	String	rating for the month from low to high
score	Float	score associated with the domain
change1m	Float	change in the score from last month to this month
count6m	Integer	number of times a score was issued in 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-make_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 CRS

String

Date formatted YYYYMM.

Defaults to latest month if not specified

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&dt=202209’

Example Response

{
“scores”: [
{
“domain_name”: “resilia.com”,

“date_month”: “202209”,

“signal_type”: “CapRaise Score”,

“rating”: “high”,

“score”: 60.8137,
“change1m”: 22.91,
“count6m”: 1,
“topic_1”: “capital injection”,
“topic_2”: “recapitalization”,
“topic_3”: “crowdfunding”,

“deal-maker_1”: “creditsuisse.com”,
“deal-maker_2”: “plantemoran.com”,
“deal-maker_3”: “kkr.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 unique domains tracked – according to your plan

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

{ “usage”: [ { “type”: “api”, “usage_per_period”: { “current”: 0, “max”: 60 }, “usage_period”: { “unit”: “minutes”, “value”: 5 } }, { “type”: “unique_domains”, “usage_per_period”: { “current”: 2, “max”: 100 }, “usage_period”: { “unit”: “months”, “value”: 1 } } ] }

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

{
“message”: “ok”,
“status_code”: 200
}

Errors

All errors from the Fintent API share a common format:

Example Response

{
“details”: {},
“message”: “unauthorized”,
“status_code”: 401
}

Products

Resources

New York Office

240 Kent Avenue

Brooklyn, NY 11249

sales@fintent.ai