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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Bitmex

Bitmex

Real-Time Cryptocurrency derivatives trading platform based in Hong Kong

Documentation Provider Profile APIs.io AsyncAPI GitHub

This event API exposes 30 operations across 30 channels, and defines 75 schemas. It is described by AsyncAPI 2.6.0, at version 1.0.0.

The API connects through a single server, ws.bitmex.com/realtime (wss).

30 operations 30 channels 75 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
1.0.0
Base URL
https://www.bitmex.com/app/apiOverview
Contact
BitMEX API
License
Proprietary
Resource Areas
1

Channels & Operations 30

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

Channels 30
SUB
announcement
Receive site-wide announcements.
subscribeAnnouncement body
SUB
chat
Receive Trollbox chat messages.
subscribeChat body
SUB
connected
Receive connected-users counts.
subscribeConnected body
SUB
funding
Receive funding events.
subscribeFunding body
SUB
instrument
Receive instrument ticker updates.
subscribeInstrument body
SUB
insurance
Receive insurance fund updates.
subscribeInsurance body
SUB
liquidation
Receive liquidation events.
subscribeLiquidation body
SUB
orderBookL2
Receive full L2 order book updates.
subscribeOrderBookL2 body
SUB
orderBookL2_25
Receive top-25 L2 order book updates.
subscribeOrderBookL2_25 body
SUB
orderBook10
Receive top-10 order book snapshots.
subscribeOrderBook10 body
SUB
publicNotifications
Receive public notifications.
subscribePublicNotifications body
SUB
quote
Receive top-of-book quote updates.
subscribeQuote body
SUB
quoteBin1m
Receive 1-minute binned quotes.
subscribeQuoteBin1m body
SUB
quoteBin5m
Receive 5-minute binned quotes.
subscribeQuoteBin5m body
SUB
quoteBin1h
Receive 1-hour binned quotes.
subscribeQuoteBin1h body
SUB
quoteBin1d
Receive 1-day binned quotes.
subscribeQuoteBin1d body
SUB
settlement
Receive instrument settlement events.
subscribeSettlement body
SUB
trade
Receive trade ticks.
subscribeTrade body
SUB
tradeBin1m
Receive 1-minute trade bins.
subscribeTradeBin1m body
SUB
tradeBin5m
Receive 5-minute trade bins.
subscribeTradeBin5m body
SUB
tradeBin1h
Receive 1-hour trade bins.
subscribeTradeBin1h body
SUB
tradeBin1d
Receive 1-day trade bins.
subscribeTradeBin1d body
SUB
affiliate
Receive affiliate metrics (auth required).
subscribeAffiliate body
SUB
execution
Receive order executions (auth required).
subscribeExecution body
SUB
margin
Receive margin updates (auth required).
subscribeMargin body
SUB
order
Receive order updates (auth required).
subscribeOrder body
SUB
position
Receive position updates (auth required).
subscribePosition body
SUB
privateNotifications
Receive private notifications (auth required).
subscribePrivateNotifications body
SUB
transact
Receive wallet transactions (auth required).
subscribeTransact body
SUB
wallet
Receive wallet balance updates (auth required).
subscribeWallet body

Messages & Schemas 75

The contract defines 75 schemas that model the data carried by its messages. The most detailed are Instrument (98 properties), Execution (55 properties), Position (55 properties), Order (34 properties). Each schema is shown below with its type and property counts.

SubscribeRequest
message
Client-to-server control message used to subscribe to, unsubscribe from, or authenticate against topics.
WelcomeMessage
message
Sent by the server immediately after connection.
SubscribeResponse
message
Server acknowledgement of a successful subscribe / unsubscribe.
ErrorMessage
message
Server-side error response.
AnnouncementMessage
message
ChatMessage
message
ConnectedMessage
message
FundingMessage
message
InstrumentMessage
message
InsuranceMessage
message
LiquidationMessage
message
OrderBookL2Message
message
OrderBook10Message
message
PublicNotificationMessage
message
QuoteMessage
message
SettlementMessage
message
TradeMessage
message
TradeBinMessage
message
AffiliateMessage
message
ExecutionMessage
message
MarginMessage
message
OrderMessage
message
PositionMessage
message
PrivateNotificationMessage
message
TransactMessage
message
WalletMessage
message
Action
string
BitMEX table action. partial arrives once at the start of a subscription with the full snapshot and keys array. Subsequent messages are insert, update or delet…
OperationName
string
Client operation names supported by the BitMEX WebSocket. subscribe / unsubscribe manage topics; authKeyExpires / authKey perform in-band authentication; cance…
SubscribeRequest
object
Client-to-server envelope. Examples: {"op":"subscribe","args":["trade:XBTUSD","instrument:XBTUSD"]} {"op":"unsubscribe","args":["trade:XBTUSD"]} {"op":"authKey…
2 properties 1 required
Welcome
object
Welcome message sent by the server immediately after the WebSocket connection is established.
5 properties
SubscribeResponse
object
Acknowledgement returned when a subscribe / unsubscribe succeeds.
4 properties
ErrorResponse
object
Server error envelope. Returned for invalid messages such as unknown topics, malformed JSON, or auth failures.
4 properties 2 required
TableEnvelopeBase
object
Common envelope for all table push messages.
7 properties 3 required
Announcement
object
5 properties 1 required
Chat
object
7 properties 1 required
ConnectedUsers
object
2 properties
Funding
object
5 properties 2 required
Instrument
object
98 properties 1 required
Insurance
object
3 properties 2 required
Liquidation
object
5 properties 1 required
OrderBookL2
object
8 properties 3 required
OrderBook10
object
Top-10 pulsed order book snapshot. bids and asks are arrays of [price, size] tuples sorted best-first.
4 properties 1 required
Quote
object
7 properties 1 required
Settlement
object
9 properties 2 required
Trade
object
12 properties 4 required
TradeBin
object
14 properties 2 required
GlobalNotification
object
10 properties 1 required
Affiliate
object
17 properties 2 required
Execution
object
55 properties 1 required
Margin
object
31 properties 2 required
Order
object
34 properties 1 required
Position
object
55 properties 2 required
Transaction
object
17 properties 1 required
Wallet
object
11 properties 2 required
TableMessageAnnouncement
object
TableMessageChat
object
TableMessageConnected
object
TableMessageFunding
object
TableMessageInstrument
object
TableMessageInsurance
object
TableMessageLiquidation
object
TableMessageOrderBookL2
object
TableMessageOrderBook10
object
TableMessageGlobalNotification
object
TableMessageQuote
object
TableMessageSettlement
object
TableMessageTrade
object
TableMessageTradeBin
object
TableMessageAffiliate
object
TableMessageExecution
object
TableMessageMargin
object
TableMessageOrder
object
TableMessagePosition
object
TableMessageTransaction
object
TableMessageWallet
object

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

bitmex-asyncapi.yml Raw ↑
#Cryptocurrency
← Back to B APIs
API Details
ID
bitmex:bitmex
Base URL
https://www.bitmex.com/app/apiOverview
Docs
https://www.bitmex.com/app/apiOverview
Provider
Bitmex
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=bitmex-bitmex&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/bitmex-bitmex"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Bitmex, 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.