API reference

Finazon is a comprehensive financial data marketplace that enables developers to effortlessly integrate a wide variety of global datasets, including stocks, ETFs, cryptocurrencies, and more, all with fully customizable parameters.

The Finazon API is built around REST principles, featuring resource-oriented URLs with predictable behavior. The API accepts form-encoded request bodies, returns JSON-encoded responses, and utilizes standard HTTP response codes, authentication methods, and verbs.

The Finazon API doesn't support bulk updates. You can work on only one instrument per request.

Authentification

To authenticate requests, the Finazon API requires API keys. You can obtain, view, and manage your API keys through the Finazon Dashboard.

Your API keys hold significant privileges, so ensure their security by not sharing your secret API keys in publicly accessible areas, such as GitHub repositories, client-side code, or any other public platforms.

All API requests must be made over HTTPS. Calls over plain HTTP will fail, as will API requests without authentication.

Once you have your API key, include it in the parameters as follows:

https://api.finazon.io/latest?apikey=YOUR_API_KEY

Alternatively, pass it as a request header:

Authorization: apikey YOUR_API_KEY

Versioning

Whenever backwards-incompatible changes are introduced to the API, a new dated version is released. Consult our API upgrades guide for more information on backwards compatibility, and view our API changelog for all API updates.

To always use the most up-to-date version, specify it as /latest:

https://api.finazon.io/latest

To access the most recent version of v1.*, use the following:

https://api.finazon.io/v1

Or, to retrieve a specific version, call:

https://api.finazon.io/v1.0

Finazon will provide advance notice before deprecating older API versions, giving developers ample time to migrate to the updated version.

Endpoints structure

The Finazon API adheres to a consistent and structured pattern for its endpoints. The base URL for all requests is:

https://api.finazon.io/

API endpoints are organized by resource types, including universal resources accessible across all publishers and publisher-specific resources. For example, the /time_series endpoint is compatible with all publishers that support this data format. Such responses will be standardized across all datasets, facilitating rapid integration of new markets into your applications.

https://api.finazon.io/latest/{{resource}}
https://api.finazon.io/latest/time_series

Additionally, datasets may contain unique data exclusive to that dataset. In such cases, you might want to call a separate endpoint specifying the publisher to gather more data. For instance, the Binance dataset time series can be requested as:


https://api.finazon.io/latest/{{publisher}}/{{resource}}
https://api.finazon.io/latest/binance/time_series

Parameters

Each API request has its own set of required and optional parameters. Parameters should be separated by an ampersand. Parameter names are case-sensitive, while parameter values are not. Each API request has its own set of required and optional parameters. Parameters should be separated by an ampersand. Parameter names and parameter values are case-sensitive

https://api.finazon.io/latest/time_series?dataset=sip_non_pro&ticker=AAPL&interval=1m&apikey=

Pagination

All API resources supporting bulk fetches are retrieved via "list" API methods. For example, you can list time series, list trades, and list quotes. These list API methods share a common structure, accepting at least these five parameters: page, page_size, order, start_at, and end_at.

The response of a list API method represents a single page in a reverse chronological stream of objects. If you do not specify start_at or end_at, you will receive the first page of this list, containing the newest objects. By default, you will receive 10 objects if you do not specify an alternative value for page_size. You can specify start_at equal to the T (timestamp) value of an item to retrieve the page of older objects occurring immediately after the specified timestamp in the reverse chronological stream. Similarly, you can specify end_at to receive a page of newer objects occurring immediately before the named object in the stream. You can use one of start_at or end_at or both. Objects in a page always appear in reverse chronological order, unless order is specified.

Errors

Finazon employs standard HTTP response codes to signify the success or failure of an API request. Generally, the response codes can be interpreted as follows:

2xx range codes indicate a successful request.

4xx range codes signify an error resulting from the provided information (e.g., invalid API key, API rate limit exceeded, etc.).

5xx range codes represent errors originating from Finazon's servers (these are rare occurrences).

For all 4xxerrors that can be addressed programmatically (e.g., endpoint not found), an error message is included to succinctly explain the reported issue. This allows developers to quickly identify and resolve errors in their API requests.

status code message
400 INVALID_PARAMETER The {parameter_name} parameter is missing or invalid.
400 INVALID_DATE_RANGE The requested date range is invalid or unsupported.
400 UNSUPPORTED_MARKET The requested market or exchange is not supported by the API. Please check the supported markets and try again.
400 INVALID_TICKER The provided ticker is invalid or unsupported.
401 UNAUTHORIZED_ACCESS You are not authorized to access the requested endpoint or you have insufficient permissions.
404 ENDPOINT_NOT_FOUND The requested endpoint {endpoint_name} does not exist or could not be found.
429 API_RATE_LIMIT_EXCEEDED You have exceeded the allowed number of API calls within the minute. Please wait and try again later.
401 INVALID_API_KEY The provided API key is invalid or has expired. Please check your API key and try again
408 REQUEST_TIMEOUT The request took too long to complete and timed out. Please try again later or reduce the complexity of your query.
503 DATA_UNAVAILABLE The requested data is temporarily unavailable or not supported. Please try again later or check the availability of the data.
500 INTERNAL_SERVER_ERROR An error occurred on the server-side while processing the request. Please try again later. If the issue persists, contact support.

Reference data

/datasets

Returns a list of all datasets available at Finazon.

Parameters

code

Filter by Finazon's dataset code
Example: binance

page

Specific page of a paginated result to be displayed
Example: 0

page_size

Number of items displayed per page in a paginated result
Example: 100

Response

{
    "data": [
        {
            "code": "binance",
            "name": "Binance Market Data API"
        }
    ]
}

/publishers

Returns a list of all publishers available at Finazon.

Parameters

code

Filter by Finazon's publisher code
Example: sip

page

Specific page of a paginated result to be displayed
Example: 0

page_size

Number of items displayed per page in a paginated result
Example: 100


Markets

/markets/crypto

Returns a list of supported crypto markets.

Parameters

page

Specific page of a paginated result to be displayed
Example: 0

page_size

Number of items displayed per page in a paginated result
Example: 100

Response

{
    "data": [
        {
            "code": "crypto_binance",
            "name": "Binance"
        }
    ]
}

/markets/stocks

Returns a list of supported stock markets.

Parameters

country

Filter by ISO 3166 alpha-2 code
Example: US

name

Filter by market name
Example: Nasdaq XNGS

code

Filter by market identifier code (MIC) under ISO 10383 standard
Example: XNGS

page

Specific page of a paginated result to be displayed
Example: 0

page_size

Number of items displayed per page in a paginated result
Example: 100

Response

{
    "data": [
        {
            "country": "US",
            "mic": "XNGS",
            "name": "Nasdaq XNGS"
        }
    ]
}

Tickers

/tickers/crypto

Returns a list of cryptocurrency ticker symbols (pairs). This list is updated daily.

Parameters

dataset

Filter by Finazon's dataset code
Example: binance

ticker

Filter by ticker symbol
Example: BTC/USDT

page

Specific page of a paginated result to be displayed
Example: 0

page_size

Number of items displayed per page in a paginated result
Example: 100

Response

{
    "data": [
        {
            "publisher": "binance",
            "ticker": "BTC/USDT"
        }
    ],
    "meta": {
        "pagination": {
            "page": 0,
            "per_page": 0
        }
    }
}

/tickers/forex

Returns a list of forex ticker symbols (pairs). This list is updated daily.

Parameters

ticker

Filter by ticker symbol
Example: AUD/CAD

page

Specific page of a paginated result to be displayed
Example: 0

page_size

Number of items displayed per page in a paginated result
Example: 100

Response

{
    "data": [
        {
            "ticker": "AUD/CAD"
        }
    ],
    "meta": {
        "pagination": {
            "page": 0,
            "per_page": 0
        }
    }
}

/tickers/stocks

Returns a list of stock ticker symbols. This list is updated daily.

Parameters

dataset

Filter by Finazon's dataset code
Example: sip_non_pro

ticker

Filter by ticker symbol
Example: AAPL

page

Specific page of a paginated result to be displayed
Example: 0

page_size

Number of items displayed per page in a paginated result
Example: 100

cqs

Filter by cqs symbol
Example: ACI

cik

Filter by cik code
Example: 320193

cusip

Filter by cusip code
Example: 037833100

isin

Filter by isin code
Example: US0378331005

composite_figi

Filter by composite figi code
Example: BBG000B9XRY4

share_figi

Filter by share class figi code
Example: BBG001S5N8V8

lei

Filter by lei code
Example: HWUPKR0MPOU8FGXBT394

Response

{
    "data": [
        {
            "country": "US",
            "currency": "USD",
            "publisher": "sip",
            "ticker": "AAPL"
        }
    ],
    "meta": {
        "pagination": {
            "page": 0,
            "per_page": 0
        }
    }
}

/tickers/us_stocks

Returns a list of US stock ticker symbols. This list is updated daily.

Parameters

page

Specific page of a paginated result to be displayed
Example: 0

page_size

Number of items displayed per page in a paginated result
Example: 100

ticker

Filter by ticker symbol
Example: AAPL

cqs

Filter by cqs symbol
Example: ACI

cik

Filter by cik code
Example: 320193

cusip

Filter by cusip code
Example: 037833100

isin

Filter by isin code
Example: US0378331005

composite_figi

Filter by composite figi code
Example: BBG000B9XRY4

share_figi

Filter by share class figi code
Example: BBG001S5N8V8

lei

Filter by lei code
Example: HWUPKR0MPOU8FGXBT394

Response

{
    "data": [
        {
            "asset_type": "COMMON_STOCK",
            "cik": "320193",
            "composite_figi": "BBG000B9XRY4",
            "currency": "USD",
            "lei": "HWUPKR0MPOU8FGXBT394",
            "mic": "nyse",
            "security": "Apple Inc.",
            "share_figi": "BBG001S5N8V8",
            "ticker": "AAPL"
        }
    ],
    "meta": {
        "pagination": {
            "page": 0,
            "per_page": 0
        }
    }
}

Market data

/ticker/snapshot

This endpoint returns a combination of different data points, such as daily performance, last quote, last trade, minute data, and previous day performance.

Parameters

dataset

Filter by Finazon's dataset code
Example: sip_non_pro

ticker

Filter by ticker symbol
Example: AAPL

market

Filter by market
Example: nasdaq

country

Filter by ISO 3166 alpha-2 code
Example: US

cqs

Filter by cqs symbol
Example: ACI

cik

Filter by cik code
Example: 320193

cusip

Filter by cusip code
Example: 037833100

isin

Filter by isin code
Example: US0378331005

composite_figi

Filter by composite figi code
Example: BBG000B9XRY4

share_figi

Filter by share class figi code
Example: BBG001S5N8V8

lei

Filter by lei code
Example: HWUPKR0MPOU8FGXBT394

Response

{
    "1d": {
        "c": "154.55",
        "h": "154.9",
        "l": "153.2",
        "o": "154.12",
        "v": "65893054"
    },
    "1m": {
        "c": "154.55",
        "h": "154.9",
        "l": "153.2",
        "o": "154.12",
        "v": "65893054"
    },
    "52w": {
        "av": 34853128,
        "ch": 30.2,
        "chp": 0.23,
        "h": "154.9",
        "ht": 1679951555,
        "l": "153.2",
        "lt": 1679951555
    },
    "ch": {
        "dap": 0.156,
        "mop": -0.034,
        "wep": 0.243
    },
    "lt": {
        "p": "154.75",
        "s": 17,
        "tm": 1687543759200
    },
    "p1d": {
        "c": "154.55",
        "h": "154.9",
        "l": "153.2",
        "o": "154.12",
        "v": "65893054"
    }
}

/time_series

This endpoint returns a time series of data points for any given ticker.

Parameters

dataset

Filter by Finazon's dataset code
Example: sip_non_pro

ticker

Filter by ticker symbol
Example: AAPL

interval

Interval between two consecutive points in time series
Available values: 1m, 2m, 3m, 4m, 5m, 10m, 15m, 20m, 30m, 45m, 1h, 2h, 3h, 4h, 8h, 12h, 1d, 1w, 1mo, 2mo, 3mo, 4mo

market

Filter by market
Example: nasdaq

country

Filter by ISO 3166 alpha-2 code
Example: US

timezone

Timezone of the output datetime, presented in tz database format
Example: America/New_York

date

Specifies the exact date to get the data for
Example: 2023-05-04

start_at

Filter output by start time using a UNIX timestamp
Example: 1681963910

end_at

Filter output by end time using a UNIX timestamp
Example: 1687209110

page

Specific page of a paginated result to be displayed
Default value: 0

page_size

Number of items displayed per page in a paginated result
Default value: 100

order

Sorting order of the output series
Available values: desc, asc
Default value: desc

prepost

Indicates whether data should be included for extended hours of trading
Default value: false

adjust

Apply adjusting for data (all, splits, dividends, none)
Default value: all

cqs

Filter by cqs symbol
Example: ACI

cik

Filter by cik code
Example: 320193

cusip

Filter by cusip code
Example: 037833100

isin

Filter by isin code
Example: US0378331005

composite_figi

Filter by composite figi code
Example: BBG000B9XRY4

share_figi

Filter by share class figi code
Example: BBG001S5N8V8

lei

Filter by lei code
Example: HWUPKR0MPOU8FGXBT394

Response

[
    {
        "c": 145.46001,
        "h": 145.49001,
        "l": 145.13,
        "o": 145.35001,
        "t": 1675256340,
        "v": 1006162
    }
]

/trades

Returns general information on executed trades.

Parameters

dataset

Filter by Finazon's dataset code
Example: sip_non_pro

ticker

Filter by ticker symbol
Example: AAPL

country

Filter by ISO 3166 alpha-2 code
Example: US

start_at

Filter trades by start time using a UNIX timestamp
Example: 1686956400

end_at

Filter trades by end time using a UNIX timestamp
Example: 1687217949

order

Sorting order of the output series
Available values: desc, asc
Default value: desc

page

Specific page of a paginated result to be displayed
Default value: 0

page_size

Number of items displayed per page in a paginated result
Default value: 10

cqs

Filter by cqs symbol
Example: ACI

cik

Filter by cik code
Example: 320193

cusip

Filter by cusip code
Example: 037833100

isin

Filter by isin code
Example: US0378331005

composite_figi

Filter by composite figi code
Example: BBG000B9XRY4

share_figi

Filter by share class figi code
Example: BBG001S5N8V8

lei

Filter by lei code
Example: HWUPKR0MPOU8FGXBT394


Technical indicators

/time_series/atr

The Average True Range (ATR) is a volatility indicator that measures the average range of price movement over a specified period, helping traders assess market volatility.

Parameters

dataset

Filter by Finazon's dataset code
Example: sip_non_pro

ticker

Filter by ticker symbol
Example: AAPL

interval

Interval between two consecutive points in time series
Available values: 1m, 2m, 3m, 4m, 5m, 10m, 15m, 20m, 30m, 45m, 1h, 2h, 3h, 4h, 8h, 12h, 1d, 1w, 1mo, 2mo, 3mo, 4mo

market

Filter by market
Example: nasdaq

country

Filter by ISO 3166 alpha-2 code
Example: US

timezone

Timezone of the output datetime, presented in tz database format
Example: America/New_York

date

Specifies the exact date to get the data for
Example: 2023-05-04

start_at

Filter output by start time using a UNIX timestamp
Example: 1681963910

end_at

Filter output by end time using a UNIX timestamp
Example: 1687209110

page

Specific page of a paginated result to be displayed
Default value: 0

page_size

Number of items displayed per page in a paginated result
Default value: 100

order

Sorting order of the output series
Available values: desc, asc
Default value: desc

prepost

Indicates whether data should be included for extended hours of trading
Default value: false

adjust

Apply adjusting for data (all, splits, dividends, none)
Default value: all

time_period

The time period used for calculation in the indicator. Default is 14.

cqs

Filter by cqs symbol
Example: ACI

cik

Filter by cik code
Example: 320193

cusip

Filter by cusip code
Example: 037833100

isin

Filter by isin code
Example: US0378331005

composite_figi

Filter by composite figi code
Example: BBG000B9XRY4

share_figi

Filter by share class figi code
Example: BBG001S5N8V8

lei

Filter by lei code
Example: HWUPKR0MPOU8FGXBT394


/time_series/bbands

Bollinger Bands (BBANDS) are volatility bands placed above and below a moving average, measuring price volatility and helping traders identify potential overbought or oversold conditions.

Parameters

dataset

Filter by Finazon's dataset code
Example: sip_non_pro

ticker

Filter by ticker symbol
Example: AAPL

interval

Interval between two consecutive points in time series
Available values: 1m, 2m, 3m, 4m, 5m, 10m, 15m, 20m, 30m, 45m, 1h, 2h, 3h, 4h, 8h, 12h, 1d, 1w, 1mo, 2mo, 3mo, 4mo

market

Filter by market
Example: nasdaq

country

Filter by ISO 3166 alpha-2 code
Example: US

timezone

Timezone of the output datetime, presented in tz database format
Example: America/New_York

date

Specifies the exact date to get the data for
Example: 2023-05-04

start_at

Filter output by start time using a UNIX timestamp
Example: 1681963910

end_at

Filter output by end time using a UNIX timestamp
Example: 1687209110

page

Specific page of a paginated result to be displayed
Default value: 0

page_size

Number of items displayed per page in a paginated result
Default value: 100

order

Sorting order of the output series
Available values: desc, asc
Default value: desc

prepost

Indicates whether data should be included for extended hours of trading
Default value: false

adjust

Apply adjusting for data (all, splits, dividends, none)
Default value: all

series_type

Specifies the price data type: open, high, low, or close. Default is close.

time_period

The time period used for calculation in the indicator. Default is 14.

sd

The standard deviation applied in the calculation. Default is 2.0.

ma_type

The type of moving average used, such as SMA or EMA. Default is SMA.

cqs

Filter by cqs symbol
Example: ACI

cik

Filter by cik code
Example: 320193

cusip

Filter by cusip code
Example: 037833100

isin

Filter by isin code
Example: US0378331005

composite_figi

Filter by composite figi code
Example: BBG000B9XRY4

share_figi

Filter by share class figi code
Example: BBG001S5N8V8

lei

Filter by lei code
Example: HWUPKR0MPOU8FGXBT394

Response

[
    {
        "lower_band": "71.71872558707",
        "middle_band": "161.31178571429",
        "t": 1696478400,
        "upper_band": "250.90484584150"
    }
]

/time_series/ichimoku

The Ichimoku Cloud (ICHIMOKU) is a comprehensive trend-following indicator that combines multiple moving averages and support/resistance levels to help traders identify potential entry and exit points, trend direction, and momentum.

Parameters

dataset

Filter by Finazon's dataset code
Example: sip_non_pro

ticker

Filter by ticker symbol
Example: AAPL

interval

Interval between two consecutive points in time series
Available values: 1m, 2m, 3m, 4m, 5m, 10m, 15m, 20m, 30m, 45m, 1h, 2h, 3h, 4h, 8h, 12h, 1d, 1w, 1mo, 2mo, 3mo, 4mo

market

Filter by market
Example: nasdaq

country

Filter by ISO 3166 alpha-2 code
Example: US

timezone

Timezone of the output datetime, presented in tz database format
Example: America/New_York

date

Specifies the exact date to get the data for
Example: 2023-05-04

start_at

Filter output by start time using a UNIX timestamp
Example: 1681963910

end_at

Filter output by end time using a UNIX timestamp
Example: 1687209110

page

Specific page of a paginated result to be displayed
Default value: 0

page_size

Number of items displayed per page in a paginated result
Default value: 100

order

Sorting order of the output series
Available values: desc, asc
Default value: desc

prepost

Indicates whether data should be included for extended hours of trading
Default value: false

adjust

Apply adjusting for data (all, splits, dividends, none)
Default value: all

conversion_line_period

The time period used for generating the conversation line. Default is 9.

base_line_period

The time period used for generating the base line. Default is 26.

leading_span_b_period

The time period used for generating the leading span B line. Default is 52.

lagging_span_period

The time period used for generating the lagging span line. Default is 26.

include_ahead_span_period

Indicates whether to include ahead span period. Default is true.

cqs

Filter by cqs symbol
Example: ACI

cik

Filter by cik code
Example: 320193

cusip

Filter by cusip code
Example: 037833100

isin

Filter by isin code
Example: US0378331005

composite_figi

Filter by composite figi code
Example: BBG000B9XRY4

share_figi

Filter by share class figi code
Example: BBG001S5N8V8

lei

Filter by lei code
Example: HWUPKR0MPOU8FGXBT394

Response

[
    {
        "chikou_span": "0.00000000000",
        "kijun_sen": "94.99000000000",
        "senkou_span_a": "183.00250000000",
        "senkou_span_b": "185.85500000000",
        "t": 1696478400,
        "tenkan_sen": "87.72500000000"
    }
]

/time_series/ma

The Moving Average (MA) is a smoothing indicator that calculates the average price of a security over a specified period, helping traders identify trends and potential support or resistance levels.

Parameters

dataset

Filter by Finazon's dataset code
Example: sip_non_pro

ticker

Filter by ticker symbol
Example: AAPL

interval

Interval between two consecutive points in time series
Available values: 1m, 2m, 3m, 4m, 5m, 10m, 15m, 20m, 30m, 45m, 1h, 2h, 3h, 4h, 8h, 12h, 1d, 1w, 1mo, 2mo, 3mo, 4mo

market

Filter by market
Example: nasdaq

country

Filter by ISO 3166 alpha-2 code
Example: US

timezone

Timezone of the output datetime, presented in tz database format
Example: America/New_York

date

Specifies the exact date to get the data for
Example: 2023-05-04

start_at

Filter output by start time using a UNIX timestamp
Example: 1681963910

end_at

Filter output by end time using a UNIX timestamp
Example: 1687209110

page

Specific page of a paginated result to be displayed
Default value: 0

page_size

Number of items displayed per page in a paginated result
Default value: 100

order

Sorting order of the output series
Available values: desc, asc
Default value: desc

prepost

Indicates whether data should be included for extended hours of trading
Default value: false

adjust

Apply adjusting for data (all, splits, dividends, none)
Default value: all

series_type

Specifies the price data type: open, high, low, or close. Default is close.

time_period

The time period used for calculation in the indicator. Default is 14.

ma_type

The type of moving average used, such as SMA or EMA. Default is SMA.

cqs

Filter by cqs symbol
Example: ACI

cik

Filter by cik code
Example: 320193

cusip

Filter by cusip code
Example: 037833100

isin

Filter by isin code
Example: US0378331005

composite_figi

Filter by composite figi code
Example: BBG000B9XRY4

share_figi

Filter by share class figi code
Example: BBG001S5N8V8

lei

Filter by lei code
Example: HWUPKR0MPOU8FGXBT394


/time_series/macd

The Moving Average Convergence Divergence (MACD) is a momentum indicator that measures the difference between two moving averages, with a signal line used to identify potential trend reversals and trading opportunities.

Parameters

dataset

Filter by Finazon's dataset code
Example: sip_non_pro

ticker

Filter by ticker symbol
Example: AAPL

interval

Interval between two consecutive points in time series
Available values: 1m, 2m, 3m, 4m, 5m, 10m, 15m, 20m, 30m, 45m, 1h, 2h, 3h, 4h, 8h, 12h, 1d, 1w, 1mo, 2mo, 3mo, 4mo

market

Filter by market
Example: nasdaq

country

Filter by ISO 3166 alpha-2 code
Example: US

timezone

Timezone of the output datetime, presented in tz database format
Example: America/New_York

date

Specifies the exact date to get the data for
Example: 2023-05-04

start_at

Filter output by start time using a UNIX timestamp
Example: 1681963910

end_at

Filter output by end time using a UNIX timestamp
Example: 1687209110

page

Specific page of a paginated result to be displayed
Default value: 0

page_size

Number of items displayed per page in a paginated result
Default value: 100

order

Sorting order of the output series
Available values: desc, asc
Default value: desc

prepost

Indicates whether data should be included for extended hours of trading
Default value: false

adjust

Apply adjusting for data (all, splits, dividends, none)
Default value: all

series_type

Specifies the price data type: open, high, low, or close. Default is close.

fast_period

The shorter time period for calculation. Default is 12.

slow_period

The longer time period for calculation. Default is 26.

signal_period

The time period used for generating the signal line. Default is 9.

cqs

Filter by cqs symbol
Example: ACI

cik

Filter by cik code
Example: 320193

cusip

Filter by cusip code
Example: 037833100

isin

Filter by isin code
Example: US0378331005

composite_figi

Filter by composite figi code
Example: BBG000B9XRY4

share_figi

Filter by share class figi code
Example: BBG001S5N8V8

lei

Filter by lei code
Example: HWUPKR0MPOU8FGXBT394

Response

[
    {
        "macd": "-6.23433025226",
        "macd_hist": "1.15495417720",
        "macd_signal": "-7.38928442946",
        "t": 1696478400
    }
]

/time_series/obv

The On Balance Volume (OBV) indicator is a cumulative volume-based tool used to measure buying and selling pressure, helping traders identify potential price trends and reversals.

Parameters

dataset

Filter by Finazon's dataset code
Example: sip_non_pro

ticker

Filter by ticker symbol
Example: AAPL

interval

Interval between two consecutive points in time series
Available values: 1m, 2m, 3m, 4m, 5m, 10m, 15m, 20m, 30m, 45m, 1h, 2h, 3h, 4h, 8h, 12h, 1d, 1w, 1mo, 2mo, 3mo, 4mo

market

Filter by market
Example: nasdaq

country

Filter by ISO 3166 alpha-2 code
Example: US

timezone

Timezone of the output datetime, presented in tz database format
Example: America/New_York

date

Specifies the exact date to get the data for
Example: 2023-05-04

start_at

Filter output by start time using a UNIX timestamp
Example: 1681963910

end_at

Filter output by end time using a UNIX timestamp
Example: 1687209110

page

Specific page of a paginated result to be displayed
Default value: 0

page_size

Number of items displayed per page in a paginated result
Default value: 100

order

Sorting order of the output series
Available values: desc, asc
Default value: desc

prepost

Indicates whether data should be included for extended hours of trading
Default value: false

adjust

Apply adjusting for data (all, splits, dividends, none)
Default value: all

series_type

Specifies the price data type: open, high, low, or close. Default is close.

cqs

Filter by cqs symbol
Example: ACI

cik

Filter by cik code
Example: 320193

cusip

Filter by cusip code
Example: 037833100

isin

Filter by isin code
Example: US0378331005

composite_figi

Filter by composite figi code
Example: BBG000B9XRY4

share_figi

Filter by share class figi code
Example: BBG001S5N8V8

lei

Filter by lei code
Example: HWUPKR0MPOU8FGXBT394

Response

[
    {
        "obv": "137453052.00000000000",
        "t": 1696564800
    }
]

/time_series/rsi

The Relative Strength Index (RSI) is a momentum oscillator that measures the speed and change of price movements, helping traders identify potential overbought or oversold conditions and trend reversals.

Parameters

dataset

Filter by Finazon's dataset code
Example: sip_non_pro

ticker

Filter by ticker symbol
Example: AAPL

interval

Interval between two consecutive points in time series
Available values: 1m, 2m, 3m, 4m, 5m, 10m, 15m, 20m, 30m, 45m, 1h, 2h, 3h, 4h, 8h, 12h, 1d, 1w, 1mo, 2mo, 3mo, 4mo

market

Filter by market
Example: nasdaq

country

Filter by ISO 3166 alpha-2 code
Example: US

timezone

Timezone of the output datetime, presented in tz database format
Example: America/New_York

date

Specifies the exact date to get the data for
Example: 2023-05-04

start_at

Filter output by start time using a UNIX timestamp
Example: 1681963910

end_at

Filter output by end time using a UNIX timestamp
Example: 1687209110

page

Specific page of a paginated result to be displayed
Default value: 0

page_size

Number of items displayed per page in a paginated result
Default value: 100

order

Sorting order of the output series
Available values: desc, asc
Default value: desc

prepost

Indicates whether data should be included for extended hours of trading
Default value: false

adjust

Apply adjusting for data (all, splits, dividends, none)
Default value: all

series_type

Specifies the price data type: open, high, low, or close. Default is close.

time_period

The time period used for calculation in the indicator. Default is 14.

cqs

Filter by cqs symbol
Example: ACI

cik

Filter by cik code
Example: 320193

cusip

Filter by cusip code
Example: 037833100

isin

Filter by isin code
Example: US0378331005

composite_figi

Filter by composite figi code
Example: BBG000B9XRY4

share_figi

Filter by share class figi code
Example: BBG001S5N8V8

lei

Filter by lei code
Example: HWUPKR0MPOU8FGXBT394


/time_series/sar

The Parabolic SAR (SAR) is a trend-following indicator that calculates potential support and resistance levels based on a security's price and time, helping traders identify potential entry and exit points.

Parameters

dataset

Filter by Finazon's dataset code
Example: sip_non_pro

ticker

Filter by ticker symbol
Example: AAPL

interval

Interval between two consecutive points in time series
Available values: 1m, 2m, 3m, 4m, 5m, 10m, 15m, 20m, 30m, 45m, 1h, 2h, 3h, 4h, 8h, 12h, 1d, 1w, 1mo, 2mo, 3mo, 4mo

market

Filter by market
Example: nasdaq

country

Filter by ISO 3166 alpha-2 code
Example: US

timezone

Timezone of the output datetime, presented in tz database format
Example: America/New_York

date

Specifies the exact date to get the data for
Example: 2023-05-04

start_at

Filter output by start time using a UNIX timestamp
Example: 1681963910

end_at

Filter output by end time using a UNIX timestamp
Example: 1687209110

page

Specific page of a paginated result to be displayed
Default value: 0

page_size

Number of items displayed per page in a paginated result
Default value: 100

order

Sorting order of the output series
Available values: desc, asc
Default value: desc

prepost

Indicates whether data should be included for extended hours of trading
Default value: false

adjust

Apply adjusting for data (all, splits, dividends, none)
Default value: all

acceleration

The rate of change in the indicator's values. Default is 0.02.

maximum

The maximum value considered for the indicator calculation. Default is 0.2.

cqs

Filter by cqs symbol
Example: ACI

cik

Filter by cik code
Example: 320193

cusip

Filter by cusip code
Example: 037833100

isin

Filter by isin code
Example: US0378331005

composite_figi

Filter by composite figi code
Example: BBG000B9XRY4

share_figi

Filter by share class figi code
Example: BBG001S5N8V8

lei

Filter by lei code
Example: HWUPKR0MPOU8FGXBT394


/time_series/stoch

The Stochastic Oscillator (STOCH) is a momentum indicator that compares a security's closing price to its price range over a specified period, helping traders identify potential overbought or oversold conditions and trend reversals.

Parameters

dataset

Filter by Finazon's dataset code
Example: sip_non_pro

ticker

Filter by ticker symbol
Example: AAPL

interval

Interval between two consecutive points in time series
Available values: 1m, 2m, 3m, 4m, 5m, 10m, 15m, 20m, 30m, 45m, 1h, 2h, 3h, 4h, 8h, 12h, 1d, 1w, 1mo, 2mo, 3mo, 4mo

market

Filter by market
Example: nasdaq

country

Filter by ISO 3166 alpha-2 code
Example: US

timezone

Timezone of the output datetime, presented in tz database format
Example: America/New_York

date

Specifies the exact date to get the data for
Example: 2023-05-04

start_at

Filter output by start time using a UNIX timestamp
Example: 1681963910

end_at

Filter output by end time using a UNIX timestamp
Example: 1687209110

page

Specific page of a paginated result to be displayed
Default value: 0

page_size

Number of items displayed per page in a paginated result
Default value: 100

order

Sorting order of the output series
Available values: desc, asc
Default value: desc

prepost

Indicates whether data should be included for extended hours of trading
Default value: false

adjust

Apply adjusting for data (all, splits, dividends, none)
Default value: all

fast_k_period

The time period for the fast %K line in the Stochastic Oscillator. Default is 14.

slow_k_period

The time period for the slow %K line in the Stochastic Oscillator. Default is 1.

slow_d_period

The time period for the slow %D line in the Stochastic Oscillator. Default is 3.

slow_kma_type

The type of slow %K Moving Average used. Default is SMA.

slow_dma_type

The type of slow Displaced Moving Average used. Default is SMA.

cqs

Filter by cqs symbol
Example: ACI

cik

Filter by cik code
Example: 320193

cusip

Filter by cusip code
Example: 037833100

isin

Filter by isin code
Example: US0378331005

composite_figi

Filter by composite figi code
Example: BBG000B9XRY4

share_figi

Filter by share class figi code
Example: BBG001S5N8V8

lei

Filter by lei code
Example: HWUPKR0MPOU8FGXBT394

Response

[
    {
        "slow_d": "96.63967648887",
        "slow_k": "97.33715462311",
        "t": 1696478400
    }
]

Dataset specific

Endpoints specific for particular dataset.

Benzinga

Benzinga datasets in catalog →

/dividends_calendar

Returns the dividends calendar from Benzinga.

Parameters

ticker

Filter by ticker symbol
Example: AAPL

date

Specifies the exact date to get the data for
Example: 2023-05-04

start_at

Filter events by start time using a UNIX timestamp
Example: 1681963910

end_at

Filter events by end time using a UNIX timestamp
Example: 1687209110

page

Specific page of a paginated result to be displayed
Default value: 0

page_size

Number of items displayed per page in a paginated result
Default value: 100

order

Sorting order of the output series
Available values: desc, asc
Default value: desc

cqs

Filter by cqs symbol
Example: ACI

cik

Filter by cik code
Example: 320193

cusip

Filter by cusip code
Example: 037833100

isin

Filter by isin code
Example: US0378331005

composite_figi

Filter by composite figi code
Example: BBG000B9XRY4

share_figi

Filter by share class figi code
Example: BBG001S5N8V8

lei

Filter by lei code
Example: HWUPKR0MPOU8FGXBT394

Response

{
    "data": [
        {
            "currency": "USD",
            "declaration_date": "2023-05-03",
            "dividend": 0.24,
            "dividend_prior": "0",
            "dividend_type": "Cash",
            "dividend_yield": 0.00573305,
            "end_regular_dividend": false,
            "ex_dividend_date": "2023-05-11",
            "frequency": 4,
            "importance": 5,
            "mic": "XNGS",
            "name": "Apple",
            "notes": "",
            "payable_date": "2023-05-17",
            "record_date": "2023-05-14",
            "record_id": "6454253aded99400013f6121",
            "ticker": "AAPL",
            "updated": 1683236210
        }
    ]
}

/earnings_calendar

Returns the earnings calendar from Benzinga.

Parameters

ticker

Filter by ticker symbol
Example: AAPL

date

Specifies the exact date to get the data for
Example: 2023-05-04

start_at

Filter events by start time using a UNIX timestamp
Example: 1681963910

end_at

Filter events by end time using a UNIX timestamp
Example: 1687209110

page

Specific page of a paginated result to be displayed
Default value: 0

page_size

Number of items displayed per page in a paginated result
Default value: 100

order

Sorting order of the output series
Available values: desc, asc
Default value: desc

cqs

Filter by cqs symbol
Example: ACI

cik

Filter by cik code
Example: 320193

cusip

Filter by cusip code
Example: 037833100

isin

Filter by isin code
Example: US0378331005

composite_figi

Filter by composite figi code
Example: BBG000B9XRY4

share_figi

Filter by share class figi code
Example: BBG001S5N8V8

lei

Filter by lei code
Example: HWUPKR0MPOU8FGXBT394

Response

{
    "data": [
        {
            "currency": "USD",
            "date": "2023-05-04",
            "date_confirmed": true,
            "eps": {
                "estimated": 1.43,
                "prior": 1.52,
                "reported": 1.52,
                "surprise": 0.09,
                "surprise_percent": 0.0629,
                "type": "GAAP"
            },
            "importance": 5,
            "mic": "XNGS",
            "name": "Apple",
            "notes": "",
            "period": "Q2",
            "period_year": 2023,
            "record_id": "32515085",
            "revenue": {
                "estimated": 92960000000,
                "prior": 97278000000,
                "reported": 94836000000,
                "surprise": 1876000000,
                "surprise_percent": 0.0202,
                "type": "GAAP"
            },
            "ticker": "AAPL",
            "time": "12:30:00",
            "updated": 1683232340
        }
    ]
}

/ipo

Returns IPO data from Benzinga.

Parameters

start_at

Filter events by start time using a UNIX timestamp
Example: 1681963910

end_at

Filter events by end time using a UNIX timestamp
Example: 1687209110

page

Specific page of a paginated result to be displayed
Default value: 0

page_size

Number of items displayed per page in a paginated result
Default value: 100

order

Sorting order of the output series
Available values: desc, asc
Default value: asc

exchange

Exchange where instrument is traded
Example: AMEX

Response

{
    "ipos": [
        {
            "currency": "USD",
            "date": "2023-12-31",
            "deal_status": "Amendment",
            "description": "Knowlton Development Corporation, Inc are a trusted global provider of value-added solutions",
            "initial_filing_date": "2021-07-11",
            "insider_lockup_date": "2022-03-22",
            "insider_lockup_days": 180,
            "ipo_type": "Ordinary Shares",
            "last_yr_income": 0,
            "last_yr_income_year": 0,
            "last_yr_revenue": 0,
            "last_yr_revenue_year": 0,
            "lead_underwriters": [
                "Goldman Sachs",
                "JP Morgan"
            ],
            "market_cap_at_offer": 0,
            "mic": "NYSE",
            "name": "Knowlton Development Corporation, Inc",
            "notes": "Some notes",
            "offering_shares": 57143000,
            "offering_shares_ord_adr": 0,
            "offering_value": 800002000,
            "open_date_verified": false,
            "ord_shares_out_after_offer": 0,
            "other_underwriters": "[\"Early Bird Capital\", \"Guggenheim\",]",
            "price_max": 15,
            "price_min": 13,
            "price_open": 0,
            "price_public_offering": 0,
            "pricing_date": "2021-09-21",
            "record_id": "60ecd9bfc453830001d4ce72",
            "sec_accession_number": "0001193125-21-259499",
            "sec_filing_url": "https://www.sec.gov/Archives/edgar/data/1846055/000119312521272107/d39510ds1a.htm",
            "shares_outstanding": 0,
            "sic": 73272,
            "spac_converted_to_target": false,
            "state_location": "MA",
            "ticker": "KDC",
            "time": "15:09:35",
            "underwriter_quiet_expiration_date": "2021-11-02",
            "underwriter_quiet_expiration_days": 40,
            "updated": 1683232340
        }
    ]
}

/news

Returns the news articles from Benzinga.

Parameters

ticker

Filter by ticker symbol
Example: AAPL

date

Specifies the exact date to get the data for
Example: 2023-05-04

start_at

Filter events by start time using a UNIX timestamp
Example: 1681963910

end_at

Filter events by end time using a UNIX timestamp
Example: 1687209110

page

Specific page of a paginated result to be displayed
Default value: 0

page_size

Number of items displayed per page in a paginated result
Default value: 100

order

Sorting order of the output series
Available values: desc, asc
Default value: desc

cqs

Filter by cqs symbol
Example: ACI

cik

Filter by cik code
Example: 320193

cusip

Filter by cusip code
Example: 037833100

isin

Filter by isin code
Example: US0378331005

composite_figi

Filter by composite figi code
Example: BBG000B9XRY4

share_figi

Filter by share class figi code
Example: BBG001S5N8V8

lei

Filter by lei code
Example: HWUPKR0MPOU8FGXBT394

Response

{
    "data": [
        {
            "author": "Ananya Gairola",
            "channels": [
                "Economics"
            ],
            "created_at": "2023-06-19T14:14:29Z",
            "images": [
                "https://cdn.benzinga.com/files/imagecache/1024x768xUP/images/story/2023/05/02/ford_-_logo_0.jpg"
            ],
            "record_id": 32911851,
            "tags": [
                "OpenAi"
            ],
            "tickers": [
                "AAPL"
            ],
            "title": "iPhone 15,16 Could Unleash Enhanced Connectivity, Performance, Says Apple Analyst Ming-Chi Kuo",
            "updated_at": "2023-06-19T14:14:30Z",
            "url": "https://www.benzinga.com/news/23/06/32911851/iphone-15-16-could-unleash-enhanced-connectivity-performance-says-apple-analyst-ming-chi-kuo"
        }
    ]
}

Binance

Binance datasets in catalog →

/binance/time_series

This endpoint returns a time series of data points for any given ticker.

Parameters

ticker

Filter by ticker symbol
Example: AAPL

interval

Interval between two consecutive points in time series
Available values: 1m, 2m, 3m, 4m, 5m, 10m, 15m, 20m, 30m, 45m, 1h, 2h, 3h, 4h, 8h, 12h, 1d, 1w, 1mo, 2mo, 3mo, 4mo

timezone

Timezone of the output datetime, presented in tz database format
Example: America/New_York

date

Specifies the exact date to get the data for
Example: 2023-05-04

start_at

Filter output by start time using a UNIX timestamp
Example: 1681963910

end_at

Filter output by end time using a UNIX timestamp
Example: 1687209110

page

Specific page of a paginated result to be displayed
Default value: 0

page_size

Number of items displayed per page in a paginated result
Default value: 100

order

Sorting order of the output series
Available values: desc, asc
Default value: desc

Response

[
    {
        "bv": 97.598074,
        "c": 145.46001,
        "h": 145.49001,
        "l": 145.13,
        "o": 145.35001,
        "qv": 97.598074,
        "t": 1675256340,
        "tbv": 97.598074,
        "tqv": 97.598074,
        "tr": 123
    }
]

Crypto

/crypto/time_series

This endpoint returns a time series of data points for any given ticker.

Parameters

ticker

Filter by ticker symbol
Example: AAPL

interval

Interval between two consecutive points in time series
Available values: 1m, 2m, 3m, 4m, 5m, 10m, 15m, 20m, 30m, 45m, 1h, 2h, 3h, 4h, 8h, 12h, 1d, 1w, 1mo, 2mo, 3mo, 4mo

timezone

Timezone of the output datetime, presented in tz database format
Example: America/New_York

date

Specifies the exact date to get the data for
Example: 2023-05-04

start_at

Filter output by start time using a UNIX timestamp
Example: 1681963910

end_at

Filter output by end time using a UNIX timestamp
Example: 1687209110

page

Specific page of a paginated result to be displayed
Default value: 0

page_size

Number of items displayed per page in a paginated result
Default value: 100

order

Sorting order of the output series
Available values: desc, asc
Default value: desc

Response

[
    {
        "c": 145.46001,
        "h": 145.49001,
        "l": 145.13,
        "o": 145.35001,
        "t": 1675256340,
        "v": 1006162
    }
]

Forex

/forex/time_series

This endpoint returns a time series of data points for any given ticker.

Parameters