BitMEX API
REST API for the BitMEX Trading Platform
If you are building automated tools, please subscribe to the BitMEX API RSS Feed for changes. The feed will be updated regularly and is the most reliable way to get downtime and update announcements.
Getting Started
Base URI: https://www.bitmex.com/api/v1
Fetching Data
All REST endpoints are documented below. You can try out any query right from this interface.
Most table queries accept count, start, and reverse params. Set reverse=true to get rows newest-first.
Additional documentation regarding filters, timestamps, and authentication is available in the main API documentation.
All table data is available via the Websocket. We highly recommend using the socket if you want to have the quickest possible data without being subject to ratelimits.
Return Types
By default, all data is returned as JSON. Send ?_format=csv to get CSV data or ?_format=xml to get XML data.
Trade Data Queries
This is only a small subset of what is available, to get you started.
Fill in the parameters and click the Try it out! button to try any of these queries.
Every function of the BitMEX.com platform is exposed here and documented. Many more functions are available.
Swagger Specification
All API Endpoints
Click to expand a section.
Authentication
- API Key: apiKey
- API Key: apiSignature
- API Key: apiExpires
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | api-key |
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | api-signature |
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | api-expires |
Contact
Terms of Service
https://www.bitmex.com/app/terms