https://github.com/andrewbarba/bitmex-node

Rest and Realtime Client for Bitmex
https://github.com/andrewbarba/bitmex-node

bitmex bitmex-api cryptocurrency cryptoexchange websockets

Last synced: 22 days ago
JSON representation

Rest and Realtime Client for Bitmex

• Host: GitHub
• URL: https://github.com/andrewbarba/bitmex-node
• Owner: AndrewBarba
• License: mit
• Created: 2018-10-17T13:25:38.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2020-05-02T15:09:58.000Z (over 4 years ago)
• Last Synced: 2024-10-25T08:34:55.235Z (2 months ago)
• Topics: bitmex, bitmex-api, cryptocurrency, cryptoexchange, websockets
• Language: JavaScript
• Size: 109 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# bitmex-node

[![wercker status](https://app.wercker.com/status/feb7e7d87d5a4a29ea9c04b4a1350a44/s/master "wercker status")](https://app.wercker.com/project/byKey/feb7e7d87d5a4a29ea9c04b4a1350a44)

> *Warning:* This is still in development and the API may change before the official 1.0.0 release.

A full-featured Bitmex API client for Node.js

- [x] Realtime and Rest clients

- [x] 100% unit-test coverage

- [x] Heavily documented

- [x] Promise based with async/await

## Initialize Client

#### Combined

```javascript

const Bitmex = require('bitmex-node')

let bitmex = new Bitmex({

  apiKey: '12345',

  apiSecret: 'abcde'

})

bitmex.rest.request(...)

bitmex.realtime.on('message', () => {})

```

#### Seperately

```javascript

const bitmex = require('bitmex-node')

let restClient = new bitmex.RestClient({

  apiKey: '12345',

  apiSecret: 'abcde'

})

let realtimeClient = new bitmex.RealtimeClient({

  apiKey: '12345',

  apiSecret: 'abcde'

})

```