Symbols

Learn about symbols in CoinAPI and how to use them to fetch data.

What are symbols in CoinAPI?

CoinAPI defines symbols as unique identifiers for specific assets of exchange based on a specific financial instrument. We use the type of symbol to define the pattern for constructing each symbol. The following table describes these different symbol types:

Symbol Types

Name

Type

Description

FX Spot

SPOT

An FX spot is an agreement to exchange one asset for another. For example, exchange BTC for USD.

Futures Contract

FUTURES

A futures contract is an fx spot derivative contract in which traders have an agreement to trade fx spots at a pre-determined time in the future.

Option Contract

OPTION

An option contract is an fx spot derivative contract that requires traders to buy or sell fx spots at pre-determined prices on an agreed-upon exercise date.

Perpetual Contract

PERPETUAL

A perpetual contract is an fx spot derivative contract in which traders have an agreement to trade fx spots continuously without setting any pre-determined delivery time in the future.

Index

INDEX

An index is a statistical composite measure for any market or economic changes.

Credit/Funding

CREDIT

Credit/funding refers to a margin funding contract where prices represent the daily rate and order books display loan and borrow bids. Price represents the daily rate.

Contract

CONTRACT

This symbol type represents other types of financial contracts or instruments like spreads and interest rate swaps.

Now here's a table that shows the symbol pattern for each corresponding symbol type:

Symbol Patterns

Symbol type

Symbol pattern

SPOT

{exchange_id}_SPOT_{asset_id_base}_{asset_id_quote}

FUTURES

{exchange_id}_FTS_{asset_id_base}_{asset_id_quote}_{YYMMDD of future_delivery_time}

OPTION

{exchange_id}_OPT_{asset_id_base}_{asset_id_quote}_{YYMMDD of option_expiration_time}_{option_strike_price}_{option_type_is_call as C/P}

PERPETUAL

{exchange_id}_PERP_{asset_id_base}_{asset_id_quote}

INDEX

{exchange_id}_IDX_{index_id}

CREDIT

{exchange_id}_CRE_{asset_id_base}

CONTRACT

{exchange_id}_COT_{contract_id}

The symbols endpoint

We can get the details for the different symbols ...