You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: auto-generated/akka-scala/README.md
+16-19
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
BitMEX API
4
4
- API version: 1.2.0
5
5
6
-
## REST API for the BitMEX Trading Platform [View Changelog](/app/apiChangelog) #### Getting Started Base URI: [https://www.bitmex.com/api/v1](/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](/app/restAPI). *All* table data is available via the [Websocket](/app/wsAPI). 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](#!/Quote/Quote_get) * [Trade Data](#!/Trade/Trade_get) * [OrderBook Data](#!/OrderBook/OrderBook_getL2) * [Settlement Data](#!/Settlement/Settlement_get) * [Exchange Statistics](#!/Stats/Stats_history) Every function of the BitMEX.com platform is exposed here and documented. Many more functions are available. ##### Swagger Specification [⇩ Download Swagger JSON](swagger.json) ## All API Endpoints Click to expand a section.
6
+
## REST API for the BitMEX Trading Platform [View Changelog](/app/apiChangelog) - #### Getting Started Base URI: [https://www.bitmex.com/api/v1](/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](/app/restAPI). _All_ table data is available via the [Websocket](/app/wsAPI). 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](#!/Quote/Quote_get) - [Trade Data](#!/Trade/Trade_get) - [OrderBook Data](#!/OrderBook/OrderBook_getL2) - [Settlement Data](#!/Settlement/Settlement_get) - [Exchange Statistics](#!/Stats/Stats_history) Every function of the BitMEX.com platform is exposed here and documented. Many more functions are available. ##### Swagger Specification [⇩ Download Swagger JSON](swagger.json) - ## All API Endpoints Click to expand a section.
7
7
8
8
9
9
*Automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen)*
*ExecutionApi* | **execution.get** | **GET** /execution | Get all raw executions for your account.
80
76
*ExecutionApi* | **execution.getTradeHistory** | **GET** /execution/tradeHistory | Get all balance-affecting executions. This includes each trade, insurance charge, and settlement.
81
77
*FundingApi* | **funding.get** | **GET** /funding | Get funding history.
78
+
*GlobalNotificationApi* | **globalNotification.get** | **GET** /globalNotification | Get your current GlobalNotifications.
82
79
*InstrumentApi* | **instrument.get** | **GET** /instrument | Get instruments.
83
80
*InstrumentApi* | **instrument.getActive** | **GET** /instrument/active | Get all active instruments and instruments that have expired in <24hrs.
84
81
*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.
*TradeApi* | **trade.getBucketed** | **GET** /trade/bucketed | Get previous trades in time buckets.
118
114
*UserApi* | **user.cancelWithdrawal** | **POST** /user/cancelWithdrawal | Cancel a withdrawal.
119
115
*UserApi* | **user.checkReferralCode** | **GET** /user/checkReferralCode | Check if a referral code is valid.
116
+
*UserApi* | **user.communicationToken** | **POST** /user/communicationToken | Register your communication token for mobile clients
120
117
*UserApi* | **user.confirm** | **POST** /user/confirmEmail | Confirm your email address with a token.
121
-
*UserApi* | **user.confirmEnableTFA** | **POST** /user/confirmEnableTFA | Confirm two-factor auth for this account. If using a Yubikey, simply send a token to this endpoint.
122
118
*UserApi* | **user.confirmWithdrawal** | **POST** /user/confirmWithdrawal | Confirm a withdrawal.
123
-
*UserApi* | **user.disableTFA** | **POST** /user/disableTFA | Disable two-factor auth for this account.
124
119
*UserApi* | **user.get** | **GET** /user | Get your user model.
125
120
*UserApi* | **user.getAffiliateStatus** | **GET** /user/affiliateStatus | Get your current affiliate/referral status.
126
121
*UserApi* | **user.getCommission** | **GET** /user/commission | Get your account's commission status.
127
122
*UserApi* | **user.getDepositAddress** | **GET** /user/depositAddress | Get a deposit address.
123
+
*UserApi* | **user.getExecutionHistory** | **GET** /user/executionHistory | Get the execution history by day.
128
124
*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.
125
+
*UserApi* | **user.getQuoteFillRatio** | **GET** /user/quoteFillRatio | Get 7 days worth of Quote Fill Ratio statistics.
129
126
*UserApi* | **user.getWallet** | **GET** /user/wallet | Get your current wallet information.
130
127
*UserApi* | **user.getWalletHistory** | **GET** /user/walletHistory | Get a history of all of your wallet transactions (deposits, withdrawals, PNL).
131
128
*UserApi* | **user.getWalletSummary** | **GET** /user/walletSummary | Get a summary of all of your wallet transactions (deposits, withdrawals, PNL).
132
129
*UserApi* | **user.logout** | **POST** /user/logout | Log out of BitMEX.
133
-
*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.
134
130
*UserApi* | **user.minWithdrawalFee** | **GET** /user/minWithdrawalFee | Get the minimum withdrawal fee for a currency.
135
-
*UserApi* | **user.requestEnableTFA** | **POST** /user/requestEnableTFA | Get secret key for setting up two-factor auth.
136
131
*UserApi* | **user.requestWithdrawal** | **POST** /user/requestWithdrawal | Request a withdrawal to an external wallet.
137
132
*UserApi* | **user.savePreferences** | **POST** /user/preferences | Save user preferences.
138
-
*UserApi* | **user.update** | **PUT** /user | Update your password, name, and other attributes.
133
+
*UserEventApi* | **userEvent.get** | **GET** /userEvent | Get your user events
0 commit comments