The identity and technical contract details declared by the specification.
SubscribeTicker
message
Subscribe to the ticker channel for a symbol.
ConfRequest
message
Set per-connection feature flags. Sum the flag values to enable multiple features.
AuthRequest
message
Authenticate the connection. authSig is an HMAC-SHA384 of authPayload keyed with the API secret. authPayload is conventionally "AUTH" + authNonce. Optional fil…
Heartbeat
message
[CHANNELID, "hb"] - sent every 15 seconds of inactivity.
ChecksumMessage
message
[CHANNELID, "cs", CHECKSUM] - emitted when OBCHECKSUM is enabled.
TradingTickerMessage
message
FundingTickerMessage
message
FundingTradesSnapshot
message
FundingTradeUpdate
message
TradingBookSnapshot
message
TradingBookUpdate
message
FundingBookSnapshot
message
FundingBookUpdate
message
TradingRawBookSnapshot
message
TradingRawBookUpdate
message
FundingRawBookSnapshot
message
FundingRawBookUpdate
message
DerivativesStatusUpdate
message
LiquidationFeedUpdate
message
AuthTradeExecuted
message
FundingOfferSnapshot
message
FundingOfferUpdate
message
FundingOfferCancel
message
FundingCreditSnapshot
message
FundingCreditUpdate
message
FundingCreditClose
message
FundingLoanSnapshot
message
FundingLoanUpdate
message
FundingTradeExecuted
message
FundingTradeUpdateMsg
message
FundingInfoUpdate
message
TradingTickerArray
array
[BID, BIDSIZE, ASK, ASKSIZE, DAILYCHANGE, DAILYCHANGERELATIVE, LASTPRICE, VOLUME, HIGH, LOW]
FundingTickerArray
array
[FRR, BID, BIDPERIOD, BIDSIZE, ASK, ASKPERIOD, ASKSIZE, DAILYCHANGE, DAILYCHANGERELATIVE, LASTPRICE, VOLUME, HIGH, LOW, PLACEHOLDER, PLACEHOLDER, FRRAMOUNTAVAI…
TradeArray
array
[ID, MTS, AMOUNT, PRICE]
FundingTradeArray
array
[ID, MTS, AMOUNT, RATE, PERIOD]
BookEntryTrading
array
[PRICE, COUNT, AMOUNT] - COUNT=0 means delete.
BookEntryFunding
array
[RATE, PERIOD, COUNT, AMOUNT] - COUNT=0 means delete.
RawBookEntryTrading
array
[ORDERID, PRICE, AMOUNT] - PRICE=0 means delete.
RawBookEntryFunding
array
[OFFERID, PERIOD, RATE, AMOUNT]
CandleArray
array
[MTS, OPEN, CLOSE, HIGH, LOW, VOLUME]
DerivStatusArray
array
Derivatives status payload. Fields (with placeholders at the positions Bitfinex documents as nulls): [TIMEMS, null, DERIVPRICE, SPOTPRICE, null, INSURANCEFUNDB…
LiquidationEntry
array
[MSGTYPE, POSID, TIMEMS, null, SYMBOL, AMOUNT, BASEPRICE, null, ISMATCH, ISMARKETSOLD, null, LIQUIDATIONPRICE]
OrderMessageEnvelope
array
PositionMessageEnvelope
array
FundingOfferMessageEnvelope
array
FundingCreditMessageEnvelope
array
FundingLoanMessageEnvelope
array
OrderArray
array
Order array (index documented by Bitfinex): [0]ID, [1]GID, [2]CID, [3]SYMBOL, [4]MTSCREATE, [5]MTSUPDATE, [6]AMOUNT, [7]AMOUNTORIG, [8]ORDERTYPE, [9]TYPEPREV,…
PositionArray
array
Position array: [0]SYMBOL, [1]STATUS, [2]AMOUNT, [3]BASEPRICE, [4]MARGINFUNDING, [5]MARGINFUNDINGTYPE, [6]PL, [7]PLPERC, [8]PRICELIQ, [9]LEVERAGE, [10]FLAGS, […
WalletArray
array
[WALLETTYPE, CURRENCY, BALANCE, UNSETTLEDINTEREST, BALANCEAVAILABLE, DESCRIPTION, META]
AuthTradeArray
array
[ID, SYMBOL, MTSCREATE, ORDERID, EXECAMOUNT, EXECPRICE, ORDERTYPE, ORDERPRICE, MAKER, FEE, FEECURRENCY, CID]. FEE and FEECURRENCY are null on 'te' and populate…
FundingOfferArray
array
[0]OFFERID, [1]SYMBOL, [2]MTSCREATED, [3]MTSUPDATED, [4]AMOUNT, [5]AMOUNTORIG, [6]OFFERTYPE, [7], [8], [9]FLAGS, [10]STATUS, [11], [12], [13], [14]RATE, [15]PE…
FundingCreditArray
array
[0]CREDITID, [1]SYMBOL, [2]SIDE, [3]MTSCREATE, [4]MTSUPDATE, [5]AMOUNT, [6]FLAGS, [7]STATUS, [8], [9], [10], [11]RATE, [12]PERIOD, [13]MTSOPENING, [14]MTSLASTP…
FundingLoanArray
array
[0]LOANID, [1]SYMBOL, [2]SIDE, [3]MTSCREATE, [4]MTSUPDATE, [5]AMOUNT, [6]FLAGS, [7]STATUS, [8], [9], [10], [11]RATE, [12]PERIOD, [13]MTSOPENING, [14]MTSLASTPAY…
AuthFundingTradeArray
array
[ID, SYMBOL, MTSCREATE, OFFERID, AMOUNT, RATE, PERIOD, MAKER]
MarginInfoBase
array
["base", [USERPL, USERSWAPS, MARGINBALANCE, MARGINNET, MARGINREQUIRED]]
MarginInfoSym
array
["sym", SYMBOL, [TRADABLEBALANCE, GROSSBALANCE, BUY, SELL, null, null, null, null]]
FundingInfoSym
array
["sym", SYMBOL, [YIELDLOAN, YIELDLEND, DURATIONLOAN, DURATIONLEND]]
NotificationArray
array
[MTS, TYPE, MESSAGEID, null, NOTIFYINFO, CODE, STATUS, TEXT]
The full machine-readable AsyncAPI contract behind this narrative.