The Bjarkan SOR API uses specific symbol formats to distinguish between markets,
and it supports 4 different financial products: spot
, swap/perpetual
, future
, option
.
Spot Markets
Spot symbols are formatted the following way: BASE/QUOTE
.
'BTC/USDT' #BTC spot market quoted in USDT
'ETH/USD' #ETH spot market quoted in USD
'ETH/BTC' #ETH spot market quoted in BTC
Swap/Perpetual Markets
Perpetual symbols are formatted the following way: BASE/QUOTE:MARGIN
.
They consist of:
- The underlying currency
- The quoting currency
- The margin currency
'BTC/USDT:USDT' #BTC perpetual contract quoted in USDT and margined with USDT
'ETH/USD:USD' #ETH perpetual contract quoted in USD and margined with USD
'ETH/BTC:USDC' #ETH perpetual contract quoted in BTC and margined with USDC
Future Markets
Future symbols are formatted the following way: BASE/QUOTE:SETTLEMENTCURRENCY-SETTLEMENTDATE
.
They consist of:
- The underlying currency
- The quoting currency
- The settlement currency
- The settlement date in
YYMMDD
format
'BTC/USDT:BTC-241225' #BTC/USDT futures contract settled in BTC (inverse) on 2024-12-25
'BTC/USDT:USDT-241225' #BTC/USDT futures contract settled in USDT (linear, vanilla) on 2024-12-25
'ETH/USDT:ETH-240625' #ETH/USDT futures contract settled in ETH (inverse) on 2024-06-25
'ETH/USDT:USDT-240625' #ETH/USDT futures contract settled in USDT (linear, vanilla) on 2024-06-25
Option Markets
Option symbols are formatted the following way: BASE/QUOTE:SETTLEMENTCURRENCY-SETTLEMENTDATE-STRIKE-TYPE
.
They consist of:
- The underlying currency
- The quoting currency
- The settlement currency
- The settlement date in
YYMMDD
format
- The strike price of the option
- The type (either put or call,
P/C
)
'BTC/USDT:BTC-241225-60000-P' #BTC/USDT put option contract with strike price at 60000 USDT settled in BTC (inverse) on 2024-12-25
'ETH/USDT:USDT-241225-40000-C' #BTC/USDT call option contract with strike price at 40000 USDT settled in USDT (linear, vanilla) on 2024-12-25
'ETH/USDT:ETH-240625-5000-P' #ETH/USDT put option contract with strike price at 5000 USDT settled in ETH (inverse) on 2024-06-25
'ETH/USDT:USDT-240625-5000-C' #ETH/USDT call option contract with strike price at 5000 USDT settled in USDT (linear, vanilla) on 2024-06-25
Understanding these symbol formats is crucial when using the API, especially when setting up your base configuration or executing orders across different exchanges.