bit_mex_api

BitMexApi - JavaScript client for bit_mex_api REST API for the BitMEX.com trading platform.<a href="/app/restAPI">REST Documentation<a href="/app/wsAPI">Websocket Documentation This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.2.0
• Package version: 1.2.0
• Build date: 2016-07-05T09:40:50.068-05:00
• Build package: class io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install bit_mex_api --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var BitMexApi = require('bit_mex_api');

var api = new BitMexApi.AnnouncementApi()

var opts = { 
  'columns': "columns_example" // {String} Array of column names to fetch. If omitted, will return all columns.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.announcementGet(opts, callback);

Documentation for API Endpoints

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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- BitMexApi.AnnouncementApi | announcementGet | GET /announcement | Get site announcements. BitMexApi.AnnouncementApi | announcementGetUrgent | GET /announcement/urgent | Get urgent (banner) announcements. BitMexApi.ApiKeyApi | apiKeyDisable | POST /apiKey/disable | Disable an API Key. BitMexApi.ApiKeyApi | apiKeyEnable | POST /apiKey/enable | Enable an API Key. BitMexApi.ApiKeyApi | apiKeyGet | GET /apiKey | Get your API Keys. BitMexApi.ApiKeyApi | apiKeyNew | POST /apiKey | Create a new API Key. BitMexApi.ApiKeyApi | apiKeyRemove | DELETE /apiKey | Remove an API Key. BitMexApi.ChatApi | chatGet | GET /chat | Get chat messages. BitMexApi.ChatApi | chatGetConnected | GET /chat/connected | Get connected users. BitMexApi.ChatApi | chatNew | POST /chat | Send a chat message. BitMexApi.ExecutionApi | executionGet | GET /execution | Get all raw executions for your account. BitMexApi.ExecutionApi | executionGetTradeHistory | GET /execution/tradeHistory | Get all balance-affecting executions. This includes each trade, insurance charge, and settlement. BitMexApi.FundingApi | fundingGet | GET /funding | Get funding history. BitMexApi.InstrumentApi | instrumentGet | GET /instrument | Get instruments. BitMexApi.InstrumentApi | instrumentGetActive | GET /instrument/active | Get all active instruments and instruments that have expired in <24hrs. BitMexApi.InstrumentApi | instrumentGetActiveAndIndices | GET /instrument/activeAndIndices | Helper method. Gets all active instruments and all indices. This is a join of the result of /indices and /active. BitMexApi.InstrumentApi | instrumentGetActiveIntervals | GET /instrument/activeIntervals | Return all active contract series and interval pairs. BitMexApi.InstrumentApi | instrumentGetIndices | GET /instrument/indices | Get all price indices. BitMexApi.InsuranceApi | insuranceGet | GET /insurance | Get insurance fund history. BitMexApi.LeaderboardApi | leaderboardGet | GET /leaderboard | Get current leaderboard. BitMexApi.LiquidationApi | liquidationGet | GET /liquidation | Get liquidation orders. BitMexApi.OrderApi | orderAmend | PUT /order | Amend the quantity or price of an open order. BitMexApi.OrderApi | orderAmendBulk | PUT /order/bulk | Amend multiple orders. BitMexApi.OrderApi | orderCancel | DELETE /order | Cancel order(s). Send multiple order IDs to cancel in bulk. BitMexApi.OrderApi | orderCancelAll | DELETE /order/all | Cancels all of your orders. BitMexApi.OrderApi | orderCancelAllAfter | POST /order/cancelAllAfter | Automatically cancel all your orders after a specified timeout. BitMexApi.OrderApi | orderClosePosition | POST /order/closePosition | Close a position. [Deprecated, use POST /order with execInst: 'Close'] BitMexApi.OrderApi | orderGetOrders | GET /order | Get your orders. BitMexApi.OrderApi | orderNew | POST /order | Create a new order. BitMexApi.OrderApi | orderNewBulk | POST /order/bulk | Create multiple new orders. BitMexApi.OrderBookApi | orderBookGet | GET /orderBook | Get current orderbook [deprecated, use /orderBook/L2]. BitMexApi.OrderBookApi | orderBookGetL2 | GET /orderBook/L2 | Get current orderbook in vertical format. BitMexApi.PositionApi | positionGet | GET /position | Get your positions. BitMexApi.PositionApi | positionIsolateMargin | POST /position/isolate | Enable isolated margin or cross margin per-position. BitMexApi.PositionApi | positionTransferIsolatedMargin | POST /position/transferMargin | Transfer equity in or out of a position. BitMexApi.PositionApi | positionUpdateLeverage | POST /position/leverage | Choose leverage for a position. BitMexApi.QuoteApi | quoteGet | GET /quote | Get Quotes. BitMexApi.QuoteApi | quoteGetBucketed | GET /quote/bucketed | Get previous quotes in time buckets. BitMexApi.SchemaApi | schemaGet | GET /schema | Get model schemata for data objects returned by this API. BitMexApi.SchemaApi | schemaWebsocketHelp | GET /schema/websocketHelp | Returns help text & subject list for websocket usage. BitMexApi.SettlementApi | settlementGet | GET /settlement | Get settlement history. BitMexApi.StatsApi | statsGet | GET /stats | Get exchange-wide and per-series turnover and volume statistics. BitMexApi.StatsApi | statsHistory | GET /stats/history | Get historical exchange-wide and per-series turnover and volume statistics. BitMexApi.TradeApi | tradeGet | GET /trade | Get Trades. BitMexApi.TradeApi | tradeGetBucketed | GET /trade/bucketed | Get previous trades in time buckets. BitMexApi.UserApi | userCancelWithdrawal | POST /user/cancelWithdrawal | Cancel a withdrawal. BitMexApi.UserApi | userCheckReferralCode | GET /user/checkReferralCode | Check if a referral code is valid. BitMexApi.UserApi | userConfirmEmail | POST /user/confirmEmail | Confirm your email address with a token. BitMexApi.UserApi | userConfirmEnableTFA | POST /user/confirmEnableTFA | Confirm two-factor auth for this account. If using a Yubikey, simply send a token to this endpoint. BitMexApi.UserApi | userConfirmPasswordReset | POST /user/confirmPasswordReset | Confirm a password reset. BitMexApi.UserApi | userConfirmWithdrawal | POST /user/confirmWithdrawal | Confirm a withdrawal. BitMexApi.UserApi | userDisableTFA | POST /user/disableTFA | Disable two-factor auth for this account. BitMexApi.UserApi | userGet | GET /user | Get your user model. BitMexApi.UserApi | userGetAffiliateStatus | GET /user/affiliateStatus | Get your current affiliate/referral status. BitMexApi.UserApi | userGetCommission | GET /user/commission | Get your account's commission status. BitMexApi.UserApi | userGetDepositAddress | GET /user/depositAddress | Get a deposit address. BitMexApi.UserApi | userGetMargin | GET /user/margin | Get your account's margin status. Send a currency of &quot;all&quot; to receive an array of all supported currencies. BitMexApi.UserApi | userGetWalletHistory | GET /user/walletHistory | Get a history of all of your wallet transactions (deposits and withdrawals). BitMexApi.UserApi | userLogin | POST /user/login | Log in to BitMEX. BitMexApi.UserApi | userLogout | POST /user/logout | Log out of BitMEX. BitMexApi.UserApi | userLogoutAll | 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. BitMexApi.UserApi | userNew | POST /user | Register a new user. BitMexApi.UserApi | userRequestEnableTFA | POST /user/requestEnableTFA | Get Google Authenticator secret key for setting up two-factor auth. Fails if already enabled. Use /confirmEnableTFA for Yubikeys. BitMexApi.UserApi | userRequestPasswordReset | POST /user/requestPasswordReset | Request a password reset. BitMexApi.UserApi | userRequestWithdrawal | POST /user/requestWithdrawal | Request a withdrawal to an external wallet. BitMexApi.UserApi | userSavePreferences | POST /user/preferences | Save user preferences. BitMexApi.UserApi | userSendVerificationEmail | POST /user/resendVerificationEmail | Re-send verification email. BitMexApi.UserApi | userUpdate | PUT /user | Update your password, name, and other attributes.

Documentation for Models

• BitMexApi.AccessToken
• BitMexApi.Affiliate
• BitMexApi.Announcement
• BitMexApi.ApiKey
• BitMexApi.Chat
• BitMexApi.ConnectedUsers
• BitMexApi.Error
• BitMexApi.Execution
• BitMexApi.Funding
• BitMexApi.InlineResponse200
• BitMexApi.Instrument
• BitMexApi.InstrumentInterval
• BitMexApi.Insurance
• BitMexApi.Leaderboard
• BitMexApi.Liquidation
• BitMexApi.Margin
• BitMexApi.Order
• BitMexApi.OrderBook
• BitMexApi.OrderBookL2
• BitMexApi.Position
• BitMexApi.Quote
• BitMexApi.Settlement
• BitMexApi.Stats
• BitMexApi.StatsHistory
• BitMexApi.Trade
• BitMexApi.TradeBin
• BitMexApi.Transaction
• BitMexApi.User
• BitMexApi.UserCommission
• BitMexApi.UserPreferences

Documentation for Authorization

All endpoints do not require authorization.