How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bitfinex

Cryptocurrency Trading Platform

This event API exposes 14 operations across 7 channels, and defines 90 schemas. It is described by AsyncAPI 2.6.0, at version 2.0.0.

The API connects through 2 servers: api-pub.bitfinex.com/ws/2 (wss), api.bitfinex.com/ws/2 (wss).

14 operations 7 channels 90 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
2.0.0
Base URL
https://docs.bitfinex.com/docs
Contact
Resource Areas
1

Channels & Operations 14

Across 7 channels, the API surfaces 14 operations. Each is listed below with its action, channel, parameters, and response codes.

Channels 14
SUB
/ticker
Receive ticker snapshot, updates and heartbeats.
receiveTicker body
PUB
/ticker
Subscribe / unsubscribe to a ticker channel.
subscribeTicker body
SUB
/trades
Trades channel. Sends a message whenever a trade occurs on Bitfinex. Funding currencies emit fte/ftu messages with an additional PERIOD field.
receiveTrades body
PUB
/trades
Trades channel. Sends a message whenever a trade occurs on Bitfinex. Funding currencies emit fte/ftu messages with an additional PERIOD field.
subscribeTrades body
SUB
/book
Aggregated order book channel. Subscription parameters: prec (P0/P1/P2/P3/P4, default P0), freq (F0 realtime or F1 every 2s, default F0), len (1/25/100/250, default 25), and optional client-defined s…
receiveBook body
PUB
/book
Aggregated order book channel. Subscription parameters: prec (P0/P1/P2/P3/P4, default P0), freq (F0 realtime or F1 every 2s, default F0), len (1/25/100/250, default 25), and optional client-defined s…
subscribeBook body
SUB
/book-raw
Raw order book channel (PREC=R0). Tracks individual orders by ID rather than aggregated price levels. For trading pairs a PRICE of 0 means delete the order; for funding the same applies to the order…
receiveRawBook body
PUB
/book-raw
Raw order book channel (PREC=R0). Tracks individual orders by ID rather than aggregated price levels. For trading pairs a PRICE of 0 means delete the order; for funding the same applies to the order…
subscribeRawBook body
SUB
/candles
Candles channel. Subscribe with a key of the form trade:TIMEFRAME:SYMBOL (or trade:TIMEFRAME:SYMBOL:aAGGR:pPERSTART:pEND for funding). Supported timeframes: 1m, 5m, 15m, 30m, 1h, 3h, 6h, 12h, 1D, 1W,…
receiveCandles body
PUB
/candles
Candles channel. Subscribe with a key of the form trade:TIMEFRAME:SYMBOL (or trade:TIMEFRAME:SYMBOL:aAGGR:pPERSTART:pEND for funding). Supported timeframes: 1m, 5m, 15m, 30m, 1h, 3h, 6h, 12h, 1D, 1W,…
subscribeCandles body
SUB
/status
Platform status channel. Supports two key types: deriv:SYMBOL for derivatives status (e.g. deriv:tBTCF0:USTF0) and liq:global for the global liquidation feed.
receiveStatus body
PUB
/status
Platform status channel. Supports two key types: deriv:SYMBOL for derivatives status (e.g. deriv:tBTCF0:USTF0) and liq:global for the global liquidation feed.
subscribeStatus body
SUB
/account
All account-stream messages on CHANID = 0.
receiveAccount body
PUB
/account
Authentication handshake and connection-level config.
authenticateAccount body

Messages & Schemas 90

The contract defines 90 schemas that model the data carried by its messages. Each schema is shown below with its type and property counts.

SubscribeTicker
message
Subscribe to the ticker channel for a symbol.
SubscribeTrades
message
SubscribeBook
message
SubscribeRawBook
message
SubscribeCandles
message
SubscribeStatus
message
Unsubscribe
message
ConfRequest
message
Set per-connection feature flags. Sum the flag values to enable multiple features.
PingRequest
message
AuthRequest
message
Authenticate the connection. authSig is an HMAC-SHA384 of authPayload keyed with the API secret. authPayload is conventionally "AUTH" + authNonce. Optional fil…
AuthSuccess
message
AuthFailure
message
Heartbeat
message
[CHANNELID, "hb"] - sent every 15 seconds of inactivity.
ChecksumMessage
message
[CHANNELID, "cs", CHECKSUM] - emitted when OBCHECKSUM is enabled.
TradingTickerMessage
message
FundingTickerMessage
message
TradesSnapshot
message
TradeUpdate
message
FundingTradesSnapshot
message
FundingTradeUpdate
message
TradingBookSnapshot
message
TradingBookUpdate
message
FundingBookSnapshot
message
FundingBookUpdate
message
TradingRawBookSnapshot
message
TradingRawBookUpdate
message
FundingRawBookSnapshot
message
FundingRawBookUpdate
message
CandlesSnapshot
message
CandleUpdate
message
DerivativesStatusUpdate
message
LiquidationFeedUpdate
message
OrderSnapshot
message
OrderNew
message
OrderUpdate
message
OrderCancel
message
PositionSnapshot
message
PositionNew
message
PositionUpdate
message
PositionClose
message
WalletSnapshot
message
WalletUpdate
message
AuthTradeExecuted
message
AuthTradeUpdate
message
FundingOfferSnapshot
message
FundingOfferNew
message
FundingOfferUpdate
message
FundingOfferCancel
message
FundingCreditSnapshot
message
FundingCreditNew
message
FundingCreditUpdate
message
FundingCreditClose
message
FundingLoanSnapshot
message
FundingLoanNew
message
FundingLoanUpdate
message
FundingLoanClose
message
FundingTradeExecuted
message
FundingTradeUpdateMsg
message
BalanceUpdate
message
MarginInfoUpdate
message
FundingInfoUpdate
message
Notification
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]

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

bitfinex-asyncapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of Bitfinex, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.