👋 Overview
This endpoint lets you search for companies based on a set offilters
that you specify. You can filter by any financial metric that is listed below in the Filters section.
For example, you can search for companies with revenue greater than $100 million and capital expenditure less than $10 million and receive the following response:
🚀 Getting Started
There are 3 steps for making a successful API call:- Add your API key to the header of the request as
X-API-KEY
. - Prepare a JSON body with your search criteria, including
period
,limit
, andfilters
. - Execute the API request to the /financials/search endpoint using a POST method.
period
can be one of "ttm"
(trailing twelve months), "annual"
, or "quarterly"
.
Note: filters
is required. By default, period
is "ttm"
and limit
is 100.
🔎 Filters
You can filter the search results by adding one or morefilters
.
You may specify multiple filters
to narrow down the search results.
We charge $0.01 per 10 filters per search. For example, 5 filters costs $0.01, 15 filters costs $0.02, and so on.
Each filter consists of a field
, an operator
, and a value
.
The operator
must be one of:
"eq"
(equal to)"gt"
(greater than)"gte"
(greater than or equal to)"lt"
(less than)"lte"
(less than or equal to)
value
must be a number like 1000000
.
The field
must be one of the following from the income statement, balance sheet, or cash flow statement:
💻 Examples
Authorizations
API key for authentication.
Body
application/json
An array of filter objects to apply to the search.
Minimum length:
1
The time period for the financial data.
Available options:
annual
, quarterly
, ttm
The maximum number of results to return.
Required range:
1 <= x <= 100
The field to order the results by. Use -field to order in descending order.
Available options:
ticker
, -ticker
, report_period
, -report_period
The currency of the financial data.
Available options:
USD
, EUR
, GBP
, JPY
, CHF
, AUD
, CAD
, SEK
Whether to return historical financial data.
Response
Successful search response