Symbols
Learn about symbols in CoinAPI and how to use them to fetch data.
We'll cover the following...
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 |
| An FX spot is an agreement to exchange one asset for another. For example, exchange BTC for USD. |
Futures Contract |
| 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 |
| 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 |
| 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 |
| An index is a statistical composite measure for any market or economic changes. |
Credit/Funding |
| 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 |
| 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 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The symbols endpoint
We can get the details for the different symbols ...