Skip to content

Latest commit

 

History

History
206 lines (168 loc) · 11.6 KB

README.md

File metadata and controls

206 lines (168 loc) · 11.6 KB
Raw

swagger-client

BitMEX API

  • API version: 1.2.0

REST API for the BitMEX Trading Platform 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

Requirements

Building the API client library requires:

  1. Java 1.7+
  2. Maven/Gradle/SBT

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

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>

Gradle users

Add this dependency to your project's build file:

compile "io.swagger:swagger-client:1.0.0"

SBT users

libraryDependencies += "io.swagger" % "swagger-client" % "1.0.0"

Getting Started

Documentation for API Endpoints

All URIs are relative to https://localhost/api/v1

Class Method HTTP request Description
APIKeyApi aPIKey.disable POST /apiKey/disable Disable an API Key.
APIKeyApi aPIKey.enable POST /apiKey/enable Enable an API Key.
APIKeyApi aPIKey.get GET /apiKey Get your API Keys.
APIKeyApi aPIKey.new POST /apiKey Create a new API Key.
APIKeyApi aPIKey.remove DELETE /apiKey Remove an API Key.
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.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. This includes each trade, insurance charge, and settlement.
FundingApi funding.get GET /funding Get funding history.
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.
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.
NotificationApi notification.get GET /notification Get your current notifications.
OrderApi order.amend PUT /order Amend the quantity or price of an open order.
OrderApi order.amendBulk PUT /order/bulk Amend multiple orders for the same symbol.
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.
OrderApi order.newBulk POST /order/bulk Create multiple new orders for the same symbol.
OrderBookApi orderBook.getL2 GET /orderBook/L2 Get current orderbook in vertical format.
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.cancelWithdrawal POST /user/cancelWithdrawal Cancel a withdrawal.
UserApi user.checkReferralCode GET /user/checkReferralCode Check if a referral code is valid.
UserApi user.confirm POST /user/confirmEmail Confirm your email address with a token.
UserApi user.confirmEnableTFA POST /user/confirmEnableTFA Confirm two-factor auth for this account. If using a Yubikey, simply send a token to this endpoint.
UserApi user.confirmWithdrawal POST /user/confirmWithdrawal Confirm a withdrawal.
UserApi user.disableTFA POST /user/disableTFA Disable two-factor auth for this account.
UserApi user.get GET /user Get your user model.
UserApi user.getAffiliateStatus GET /user/affiliateStatus Get your current affiliate/referral 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.getMargin GET /user/margin Get your account's margin status. Send a currency of &quot;all&quot; to receive an array of all supported currencies.
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.logout POST /user/logout Log out of BitMEX.
UserApi user.logoutAll POST /user/logoutAll Log all systems out of BitMEX. This will revoke all of your account's access tokens, logging you out on all devices.
UserApi user.minWithdrawalFee GET /user/minWithdrawalFee Get the minimum withdrawal fee for a currency.
UserApi user.requestEnableTFA POST /user/requestEnableTFA Get secret key for setting up two-factor auth.
UserApi user.requestWithdrawal POST /user/requestWithdrawal Request a withdrawal to an external wallet.
UserApi user.savePreferences POST /user/preferences Save user preferences.
UserApi user.update PUT /user Update your password, name, and other attributes.

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

apiKey

  • Type: API key
  • API key parameter name: api-key
  • Location: HTTP header

apiNonce

  • Type: API key
  • API key parameter name: api-nonce
  • Location: HTTP header

apiSignature

  • Type: API key
  • API key parameter name: api-signature
  • Location: HTTP header

Author

support@bitmex.com