Header
Authorization header that should be filled with your Sectors Financial API
key.
Query Parameters
A natural language query (e.g.,
"top 10 tech companies by revenue in 2023"
).
When q
is provided, all other query parameters (where
, order_by
, etc.)
are ignored, as the LLM will generate them.SQL-like conditions for advanced filtering. This parameter is ignored if
q
is present.Syntax and Operators
Syntax and Operators
- Operators:
=
,!=
,>
,>=
,<
,<=
,like
,in
. - Logic: Combine conditions with
and
andor
. - Values: Use single or double quotes for strings (e.g.,
sector = 'Technology'
), numbers directly (e.g.,market_cap > 1000000000000
), and lists for thein
operator (e.g.,tags in ['blue-chip', 'dividend']
).
Yearly and Forecast Data
Yearly and Forecast Data
Access historical or forecast data using bracket notation:
Example:
field[YYYY]
.Example:
revenue[2023] > 100000000000
or forecast_eps_growth[2025] > 0.15
.Arithmetic Expressions
Arithmetic Expressions
Perform calculations within your query on both sides of a condition.
Example:
Example:
revenue[2024] / total_assets[2024] > 0.5
or revenue[2024] > revenue[2023] * 1.2
.Available Fields
Available Fields
Refer to the extensive list of over 150 queryable fields in our data
dictionary, covering everything from financial statements and valuation
ratios to executive shareholdings and price history.
Field to sort results by (e.g.,
"market_cap"
or "revenue[2024]"
). Use a
comma-separated list for multi-level sorting. This parameter is ignored if
q
is present.Sort direction for
order_by
. Use true
for descending order. This
parameter is ignored if q
is present.The maximum number of results to return. Max value is 200. This parameter is
ignored if
q
is present.The number of results to skip for pagination. This parameter is ignored if
q
is present.Response
An array of company objects matching the query.
An object containing pagination details.
Included only for natural language queries (using the
q
parameter). This
object shows how the natural language query was translated into structured API
parameters.