bit_mex_api v1.2.1

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

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.