BitMexApi - JavaScript client for bit_mex_api

This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.2.0
• Package version: 1.2.0
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

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

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your bit_mex_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('bit_mex_api') in javascript files from the directory you ran the last command above from.

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

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, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

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

var BitMexApi = require('bit_mex_api');

var defaultClient = BitMexApi.ApiClient.instance;

// Configure API key authorization: apiExpires
var apiExpires = defaultClient.authentications['apiExpires'];
apiExpires.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiExpires.apiKeyPrefix['api-expires'] = "Token"

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['api-key'] = "Token"

// Configure API key authorization: apiSignature
var apiSignature = defaultClient.authentications['apiSignature'];
apiSignature.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiSignature.apiKeyPrefix['api-signature'] = "Token"

var api = new BitMexApi.APIKeyApi()

var opts = { 
  'reverse': false // {Boolean} If true, will sort results newest first.
};

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

All URIs are relative to https://www.bitmex.com/api/v1

• BitMexApi.APIKey
• BitMexApi.AccessToken
• BitMexApi.Affiliate
• BitMexApi.Announcement
• BitMexApi.Chat
• BitMexApi.ChatChannel
• BitMexApi.CommunicationToken
• BitMexApi.ConnectedUsers
• BitMexApi.Error
• BitMexApi.ErrorError
• BitMexApi.Execution
• BitMexApi.Funding
• BitMexApi.GlobalNotification
• BitMexApi.IndexComposite
• BitMexApi.InlineResponse200
• BitMexApi.Instrument
• BitMexApi.InstrumentInterval
• BitMexApi.Insurance
• BitMexApi.Leaderboard
• BitMexApi.Liquidation
• BitMexApi.Margin
• BitMexApi.Order
• BitMexApi.OrderBookL2
• BitMexApi.Position
• BitMexApi.Quote
• BitMexApi.QuoteFillRatio
• BitMexApi.Settlement
• BitMexApi.Stats
• BitMexApi.StatsHistory
• BitMexApi.StatsUSD
• BitMexApi.Trade
• BitMexApi.TradeBin
• BitMexApi.Transaction
• BitMexApi.User
• BitMexApi.UserCommissionsBySymbol
• BitMexApi.UserEvent
• BitMexApi.UserPreferences
• BitMexApi.Wallet
• BitMexApi.XAny

• 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