BitMEX API
- API version: 1.2.0
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. View Changelog - #### 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. - Pricing Data - Trade Data - OrderBook Data - Settlement Data - Exchange Statistics Every function of the BitMEX.com platform is exposed here and documented. Many more functions are available. ##### Swagger Specification ⇩ Download Swagger JSON - ## All API Endpoints Click to expand a section.
Automatically generated by the Swagger Codegen
Building the API client library requires:
- Java 1.7+
- Maven/Gradle/SBT
To install the API client library to your local Maven repository, simply execute:
mvn clean installTo deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
mvn clean deployRefer to the OSSRH Guide for more information.
Add this dependency to your project's POM:
<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-client</artifactId>
<version>1.0.0</version>
<scope>compile</scope>
</dependency>Add this dependency to your project's build file:
compile "io.swagger:swagger-client:1.0.0"libraryDependencies += "io.swagger" % "swagger-client" % "1.0.0"All URIs are relative to https://www.bitmex.com/api/v1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| APIKeyApi | aPIKey.get | GET /apiKey | Get your API Keys. |
| AddressApi | address.get | GET /address | Get your addresses. |
| AddressApi | address.new | POST /address | Creates a new saved address. |
| AnnouncementApi | announcement.get | GET /announcement | Get site announcements. |
| AnnouncementApi | announcement.getUrgent | GET /announcement/urgent | Get urgent (banner) announcements. |
| ChatApi | chat.get | GET /chat | Get chat messages. |
| ChatApi | chat.getChannels | GET /chat/channels | Get available channels. |
| ChatApi | chat.getConnected | GET /chat/connected | Get connected users. |
| ChatApi | chat.getPinnedMessage | GET /chat/pinned | Get pinned message for a channel. |
| ChatApi | chat.new | POST /chat | Send a chat message. |
| ExecutionApi | execution.get | GET /execution | Get all raw executions for your account. |
| ExecutionApi | execution.getTradeHistory | GET /execution/tradeHistory | Get all balance-affecting executions. |
| FundingApi | funding.get | GET /funding | Get funding history. |
| GlobalNotificationApi | globalNotification.get | GET /globalNotification | Get your current GlobalNotifications. |
| GuildApi | guild.archive | POST /guild/archive | Archive a guild |
| GuildApi | guild.edit | PUT /guild | Edit guild new guild |
| GuildApi | guild.get | GET /guild | Get all guilds |
| GuildApi | guild.join | POST /guild/join | Request to Join a private guild or join a public guild |
| GuildApi | guild.kick | POST /guild/kick | Kick member from guild |
| GuildApi | guild.leave | POST /guild/leave | Leave guild or cancel guild join request |
| GuildApi | guild.new | POST /guild | Creates a new guild |
| GuildApi | guild.shareTrades | POST /guild/shareTrades | Toggle share trades for your account, which controls whether your guild members can see your orders and positions in their UI |
| InstrumentApi | instrument.get | GET /instrument | Get instruments. |
| InstrumentApi | instrument.getActive | GET /instrument/active | Get all active instruments and instruments that have expired in <24hrs. |
| InstrumentApi | instrument.getActiveAndIndices | GET /instrument/activeAndIndices | Helper method. Gets all active instruments and all indices. This is a join of the result of /indices and /active. |
| InstrumentApi | instrument.getActiveIntervals | GET /instrument/activeIntervals | Return all active contract series and interval pairs. |
| InstrumentApi | instrument.getCompositeIndex | GET /instrument/compositeIndex | Show constituent parts of an index. |
| InstrumentApi | instrument.getIndices | GET /instrument/indices | Get all price indices. |
| InstrumentApi | instrument.getUsdVolume | GET /instrument/usdVolume | Get a summary of exchange statistics in USD. |
| InsuranceApi | insurance.get | GET /insurance | Get insurance fund history. |
| LeaderboardApi | leaderboard.get | GET /leaderboard | Get current leaderboard. |
| LeaderboardApi | leaderboard.getName | GET /leaderboard/name | Get your alias on the leaderboard. |
| LiquidationApi | liquidation.get | GET /liquidation | Get liquidation orders. |
| OrderApi | order.amend | PUT /order | Amend the quantity or price of an open order. |
| OrderApi | order.cancel | DELETE /order | Cancel order(s). Send multiple order IDs to cancel in bulk. |
| OrderApi | order.cancelAll | DELETE /order/all | Cancels all of your orders. |
| OrderApi | order.cancelAllAfter | POST /order/cancelAllAfter | Automatically cancel all your orders after a specified timeout. |
| OrderApi | order.closePosition | POST /order/closePosition | Close a position. [Deprecated, use POST /order with execInst: 'Close'] |
| OrderApi | order.getOrders | GET /order | Get your orders. |
| OrderApi | order.new | POST /order | Create a new order. |
| OrderBookApi | orderBook.getL2 | GET /orderBook/L2 | Get current orderbook in vertical format. |
| PorlApi | porl.getNonce | GET /porl/nonce | Get your Proof of Reserves nonce and data. |
| PorlApi | porl.getSnapshots | GET /porl/snapshots | Get Proof of Reserves historical snapshots |
| PositionApi | position.get | GET /position | Get your positions. |
| PositionApi | position.isolateMargin | POST /position/isolate | Enable isolated margin or cross margin per-position. |
| PositionApi | position.transferIsolatedMargin | POST /position/transferMargin | Transfer equity in or out of a position. |
| PositionApi | position.updateLeverage | POST /position/leverage | Choose leverage for a position. |
| PositionApi | position.updateRiskLimit | POST /position/riskLimit | Update your risk limit. |
| QuoteApi | quote.get | GET /quote | Get Quotes. |
| QuoteApi | quote.getBucketed | GET /quote/bucketed | Get previous quotes in time buckets. |
| SchemaApi | schema.get | GET /schema | Get model schemata for data objects returned by this API. |
| SchemaApi | schema.websocketHelp | GET /schema/websocketHelp | Returns help text & subject list for websocket usage. |
| SettlementApi | settlement.get | GET /settlement | Get settlement history. |
| StatsApi | stats.get | GET /stats | Get exchange-wide and per-series turnover and volume statistics. |
| StatsApi | stats.history | GET /stats/history | Get historical exchange-wide and per-series turnover and volume statistics. |
| StatsApi | stats.historyUSD | GET /stats/historyUSD | Get a summary of exchange statistics in USD. |
| TradeApi | trade.get | GET /trade | Get Trades. |
| TradeApi | trade.getBucketed | GET /trade/bucketed | Get previous trades in time buckets. |
| UserApi | user.cancelPendingWithdrawal | DELETE /user/withdrawal | Cancel pending withdrawal |
| UserApi | user.cancelWithdrawal | POST /user/cancelWithdrawal | Cancel a withdrawal. |
| UserApi | user.checkReferralCode | GET /user/checkReferralCode | Check if a referral code is valid. |
| UserApi | user.communicationToken | POST /user/communicationToken | Register your communication token for mobile clients |
| UserApi | user.confirm | POST /user/confirmEmail | Confirm your email address with a token. |
| UserApi | user.confirmWithdrawal | POST /user/confirmWithdrawal | Confirm a withdrawal. |
| UserApi | user.createSubAccount | POST /user/addSubaccount | Creates a new sub-account. |
| UserApi | user.createUnstakingRequests | POST /user/unstakingRequests | Create unstaking request |
| UserApi | user.deleteUnstakingRequests | DELETE /user/unstakingRequests | Cancel unstaking request |
| UserApi | user.get | GET /user | Get your user model. |
| UserApi | user.getAffiliateStatus | GET /user/affiliateStatus | Get your current affiliate/referral status. |
| UserApi | user.getCSA | GET /user/csa | Get your account's CSA status. |
| UserApi | user.getCommission | GET /user/commission | Get your account's commission status. |
| UserApi | user.getDepositAddress | GET /user/depositAddress | Get a deposit address. |
| UserApi | user.getDepositAddressInformation | GET /user/depositAddressInformation | Get a deposit address. |
| UserApi | user.getExecutionHistory | GET /user/executionHistory | Get the execution history by day. |
| UserApi | user.getMargin | GET /user/margin | Get your account's margin status. Send a currency of "all" to receive an array of all supported currencies. |
| UserApi | user.getQuoteFillRatio | GET /user/quoteFillRatio | Get 7 days worth of Quote Fill Ratio statistics. |
| UserApi | user.getQuoteValueRatio | GET /user/quoteValueRatio | Get Quote Value Ratio statistics over the last 3 days |
| UserApi | user.getStaking | GET /user/staking | Get the current user staking amount. |
| UserApi | user.getStakingInstruments | GET /user/staking/instruments | List staking instruments |
| UserApi | user.getStakingTiers | GET /user/staking/tiers | List staking tiers for a given currency |
| UserApi | user.getTradingVolume | GET /user/tradingVolume | Get your 30 days USD average trading volume |
| UserApi | user.getUnstakingRequests | GET /user/unstakingRequests | Get the current user unstaking requests |
| UserApi | user.getWallet | GET /user/wallet | Get your current wallet information. |
| UserApi | user.getWalletHistory | GET /user/walletHistory | Get a history of all of your wallet transactions (deposits, withdrawals, PNL). |
| UserApi | user.getWalletSummary | GET /user/walletSummary | Get a summary of all of your wallet transactions (deposits, withdrawals, PNL). |
| UserApi | user.getWalletTransferAccounts | GET /user/getWalletTransferAccounts | Get the list of accounts you can transfer funds between. |
| UserApi | user.logout | POST /user/logout | Log out of BitMEX. |
| UserApi | user.requestWithdrawal | POST /user/requestWithdrawal | Request a withdrawal to an external wallet. |
| UserApi | user.savePreferences | POST /user/preferences | Save user preferences. |
| UserApi | user.updateSubAccount | POST /user/updateSubaccount | Updates the sub-account name. |
| UserApi | user.walletTransfer | POST /user/walletTransfer | Execute a transfer to a paired account. |
| UserAffiliatesApi | userAffiliates.get | GET /userAffiliates | Get user's affiliates to a given depth |
| UserEventApi | userEvent.get | GET /userEvent | Get your user events |
| WalletApi | wallet.getAssetsConfig | GET /wallet/assets | Get Assets Config |
| WalletApi | wallet.getNetworksConfig | GET /wallet/networks | Get Networks Config |
- APIKey
- AccessToken
- Address
- Affiliate
- Announcement
- AssetsConfig
- AssetsConfigNetworkItem
- Chat
- ChatChannel
- CollateralSupportAgreement
- CommunicationToken
- ConnectedUsers
- DepositAddress
- Error
- ErrorError
- Execution
- Funding
- GlobalNotification
- Guild
- IndexComposite
- InlineResponse200
- Instrument
- InstrumentInterval
- Insurance
- Leaderboard
- Liquidation
- Margin
- NetworksConfig
- Order
- OrderBookL2
- PinnedMessage
- Porl
- Position
- Quote
- QuoteFillRatio
- QuoteValueRatio
- Settlement
- StakingRecord
- Stats
- StatsHistory
- StatsUSD
- StatsUSDBySymbol
- Trade
- TradeBin
- TradingVolume
- Transaction
- User
- UserCommissionsBySymbol
- UserEvent
- UserPreferences
- Wallet
- WalletSummaryRecord
- XAny
Authentication schemes defined for the API:
- Type: API key
- API key parameter name: api-expires
- Location: HTTP header
- Type: API key
- API key parameter name: api-key
- Location: HTTP header
- Type: API key
- API key parameter name: api-signature
- Location: HTTP header