Instruments Info API will require active subscription to access, when out of preview period.
Returns instrument info for provided exchange and symbol
https://api.tardis.dev/v1/instruments/:exchange/:symbol_id
{id: string // symbol iddatasetId: string // id used for CSV datasets downloadsexchange: string // exchange idbaseCurrency: string // normalized, so for example bitmex XBTUSD has base currency set to BTC not XBTquoteCurrency: string // normalized, so for example bitfinex BTCUST has quote currency set to USDT, not USTtype: 'spot' | 'perpetual' | 'future' | 'option'active: boolean // indicates if the instrument can currently be traded.availableSince: string, // date in ISO formatavailableTo: string | undefined, // date in ISO formatexpiry: string | undefined // in ISO format, only for futures and optionspriceIncrement: number // price tick size, price precision can be calculated from itamountIncrement: number // amount tick size, amount/size precision can be calculated from itminTradeAmount: number // min order sizemakerFee: number // consider it as illustrative only, as it depends in practice on account traded volume levels, different categories, VIP levels, owning exchange currency etctakerFee: number // consider it as illustrative only, as it depends in practice on account traded volume levels, different categories, VIP levels, owning exchange currency etcinverse: boolean | undefined // only for derivativescontractType: "move" | "linear_future" | "inverse_future" | "quanto_future" | "linear_perpetual" | "inverse_perpetual" | "quanto_perpetual" | "put_option" | "call_option" | "turbo_put_option" | "turbo_call_option" | "spread" | "interest_rate_swap" | "repo" | "index" // only for derivatives, detailed contract typecontractMultiplier: number | undefined // only for derivativesquanto: boolean | undefined // set to true for quanto instruments, otherwise undefinedsettlementCurrency: string | undefined // settlement currency, only for quanto instruments as it's different base/quote currencystrikePrice: number | undefined // strike price, only for optionsoptionType: 'call' | 'put' // option type, only for optionschanges: undefined | {until: string // date in ISO formatpriceIncrement: number | undefinedamountIncrement: number | undefinedcontractMultiplier: number | undefined}[]}
{"id": "XBTUSD","datasetId": "XBTUSD","exchange": "bitmex","baseCurrency": "BTC","quoteCurrency": "USD","type": "perpetual","active": true,"availableSince": "2019-03-30T00:00:00.000Z","priceIncrement": 0.5,"amountIncrement": 1,"minTradeAmount": 1,"makerFee": -0.00025,"takerFee": 0.00075,"inverse": true,"contractType": "inverse_perpetual","contractMultiplier": 1}
Returns instruments array for given exchange matching provided optional filter
https://api.tardis.dev/v1/instruments/:exchange?filter={filter_payload}
JSON object, when provided via query string it needs be url encoded.
{baseCurrency: string | string[] | undefinedquoteCurrency: string | string[] | undefinedtype: string | string[] | undefinedcontractType: string | string[] | undefinedactive: boolean | undefined}
const payload = {baseCurrency: 'BTC',quoteCurrency: ['USD', 'USDT'],type: 'perpetual'}const encodedPayload = encodeURIComponent(JSON.stringify(payload))await fetch(`https://api.tardis.dev/v1/instruments/bitmex?filter=${encodedPayload}`)
Array of instruments objects as described for single instrument endpoint