Get started

Resources

Sign in to see your API keys

API Docs

Sign in to try

Sign in to request data for symbols: QQQ, AAPL, TRP, SVI.

Sign in

/rivium/rivium_ca/tickers

Returns a list of Canada Equities Market Data. This list is updated daily.

Parameters Response
Log in to query

ticker

Filter by ticker

Example: QQQ

figi

Filter by financial instrument global identifier (FIGI)

exchange

Filter by exchange name or mic code

mic_code

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

type

Filter by instrument type

Values: American Depositary Receipt Bond Bond Fund Closed-end Fund Common Stock Depositary Receipt Digital Currency ETF Exchange-Traded Note Global Depositary Receipt Index Limited Partnership Mutual Fund Physical Currency Preferred Stock REIT Right Structured Product Trust Unit Warrant

include_delisted

Include delisted identifiers

Values: true false

Default value: false

data

array of object
Stocks list
Attributes

ticker

string
Instrument ticker name

name

string
Full name of instrument

currency

string
Currency of the instrument according to the ISO 4217 standard

exchange

string
Exchange where instrument is traded

figi_code

string
Financial instrument global identifier (FIGI)

GET

Response

{
    "data": [
        {
            "ticker": "AAPL",
            "name": "Apple Inc.",
            "currency": "CAD",
            "exchange": "NEO",
            "figi_code": "BBG01293F5X4"
        }
    ]
}

/rivium/rivium_ca/price

Returns price value for given ticker.

Parameters Response
Log in to query

ticker

Ticker of the instrument. Required if Figi is empty

Example: QQQ

figi

Filter by financial instrument global identifier (FIGI). Required if Symbol is empty

Example: BBG01293F5X4

exchange

Exchange where instrument is traded

Example: NEO

mic_code

Market Identifier Code (MIC) under ISO 10383 standard

Example: NEOE

type

The asset class to which the instrument belongs

Values: American Depositary Receipt Bond Bond Fund Closed-end Fund Common Stock Depositary Receipt Digital Currency ETF Exchange-Traded Note Global Depositary Receipt Index Limited Partnership Mutual Fund Physical Currency Preferred Stock REIT Right Structured Product Trust Unit Warrant

dp

Specifies the number of decimal places for floating values. Should be in range [0,11] inclusive.

Values: 0 1 2 3 4 5 6 7 8 9 10 11

Default value: 5

price

string
Price at which the trade occurred

GET

Response

{
    "price": "184.95"
}

/rivium/rivium_ca/time_series

This endpoint returns meta and time series for the requested instrument

Parameters Response
Log in to query

ticker

Ticker of the instrument. Required if Figi is empty

Example: QQQ

figi

Filter by financial instrument global identifier (FIGI). Required if Symbol is empty

Example: BBG01293F5X4

interval

Interval between two consecutive points in time series

Values: 1m 5m 15m 30m 45m 1h 2h 4h 1d 1w 1mo

exchange

Exchange where instrument is traded

Example: NEO

mic_code

Market Identifier Code (MIC) under ISO 10383 standard

Example: NEOE

type

The asset class to which the instrument belongs

Values: American Depositary Receipt Bond Bond Fund Closed-end Fund Common Stock Depositary Receipt Digital Currency ETF Exchange-Traded Note Global Depositary Receipt Index Limited Partnership Mutual Fund Physical Currency Preferred Stock REIT Right Structured Product Trust Unit Warrant

outputsize

Number of data points to retrieve. Supports values in the range from 1 to 5000. Default is 30 when no date parameters are set, otherwise set to maximum

Default value: 30

prepost

Available at the 1min, 5min, 15min, and 30min intervals for all US equities. Open, high, low, close values are supplied without volume.

Values: 1min 5min 15min 30min

Default value: false

dp

Specifies the number of decimal places for floating values. Should be in range [0,11] inclusive.

Values: 0 1 2 3 4 5 6 7 8 9 10 11

Default value: 5

order

Sorting order of the output

Values: ASC DESC

Default value: DESC

timezone

Timezone at which output datetime will be displayed. Supports:

  • 1. Exchange for local exchange time
  • 2. UTC for datetime at universal UTC standard
  • 3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found here.
Take note that the IANA Timezone name is case-sensitive

Default value: Exchange

date

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Example: 2024-08-21

start_date

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02 15:04:05

Default location:

    • Forex and Cryptocurrencies - UTC
    • Stocks - where exchange is located (e.g. for AAPL it will be America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location

Examples:

  • 1. &symbol=AAPL&start_date=2019-08-09 15:50:00&…
    Returns all records starting from 2019-08-09 15:50:00 New York time up to current date
  • 2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09 15:50:00&…
    Returns all records starting from 2019-08-09 15:50:00 Singapore time up to current date
  • 3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09 15:50:00&end_date=2019-08-09 15:55:00&...
    Returns all records starting from 2019-08-09 15:50:00 Zurich time up to 2019-08-09 15:55:00

Example: 2024-08-22 15:04:05

end_date

Can be used separately and together with start_date. Format 2006-01-02 or 2006-01-02 15:04:05

Example: 2021-10-28 15:04:05

previous_close

If true, adds previous bar close price value to the current object. Only applicable to /time_series endpoint

Values: true false

Default value: false

adjust

Adjusting mode for prices

Values: all splits dividends none

Default value: splits

d

string
Datetime at local exchange time referring to when the bar with specified interval was opened

o

number
Price at the opening of the trading interval

h

number
Highest price reached during the trading interval

l

number
Lowest price reached during the trading interval

c

number
Closing price at the end of the trading interval

v

integer
Trading volume recorded during the trading interval

GET

Response

[
    {
        "d": "2024-08-19 15:59:00",
        "o": 148.735,
        "h": 148.86,
        "l": 148.73,
        "c": 148.85001,
        "v": 624277
    }
]

/rivium/rivium_ca/api_usage

Returns API usage for the current dataset

Parameters Response
Log in to query
No parameters are required

api_calls

object
Attributes

limit

integer
Quota limit

usage

integer
Quota usage

api_calls_dataset

object
Attributes

limit

integer
Quota limit

usage

integer
Quota usage

api_calls_price

object
Attributes

limit

integer
Quota limit

usage

integer
Quota usage

api_calls_reference

object
Attributes

limit

integer
Quota limit

usage

integer
Quota usage

api_calls_snapshots

object
Attributes

limit

integer
Quota limit

usage

integer
Quota usage

api_calls_time_series

object
Attributes

limit

integer
Quota limit

usage

integer
Quota usage

api_calls_trades

object
Attributes

limit

integer
Quota limit

usage

integer
Quota usage

historical_api_calls

object
Attributes

limit

integer
Quota limit

usage

integer
Quota usage

GET

Response

{
    "api_calls": {
        "limit": 1000,
        "usage": 10
    },
    "api_calls_dataset": {
        "limit": 1000,
        "usage": 10
    },
    "api_calls_price": {
        "limit": 1000,
        "usage": 10
    },
    "api_calls_reference": {
        "limit": 1000,
        "usage": 10
    },
    "api_calls_snapshots": {
        "limit": 1000,
        "usage": 10
    },
    "api_calls_time_series": {
        "limit": 1000,
        "usage": 10
    },
    "api_calls_trades": {
        "limit": 1000,
        "usage": 10
    },
    "historical_api_calls": {
        "limit": 1000,
        "usage": 10
    }
}
Finazon • Marketplace for the Global Financial Data APIs
Finazon is a financial data marketplace covering stocks, forex, cryptocurrencies and beyond. Access real-time, historical and alternative data via API & WebSocket.
Url:
credit card
Finazon LLC