https://github.com/ilanfrumer/bitmex-nodejs
An unofficial BitMEX API connector written with typescript
https://github.com/ilanfrumer/bitmex-nodejs
api bitmex bitmex-api cryptocurrency-exchanges typescript
Last synced: about 1 month ago
JSON representation
An unofficial BitMEX API connector written with typescript
- Host: GitHub
- URL: https://github.com/ilanfrumer/bitmex-nodejs
- Owner: IlanFrumer
- Created: 2018-07-12T00:43:45.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T20:56:55.000Z (almost 3 years ago)
- Last Synced: 2025-04-05T20:33:50.183Z (6 months ago)
- Topics: api, bitmex, bitmex-api, cryptocurrency-exchanges, typescript
- Language: TypeScript
- Homepage:
- Size: 188 KB
- Stars: 30
- Watchers: 3
- Forks: 16
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
### BitMEX-nodejs - An unofficial BitMEX API connector written with typescript
*All types and methods are automatically generated from BitMEX official Swagger Specification*
#### Installation
- CLI installation: `npm install bitmex-node`
- Create API keys: https://www.bitmex.com/app/apiKeys
- Recommended code editor: [Visual studio code](https://code.visualstudio.com/)
#### Live Example
#### Code Example
```typescript
import { BitmexAPI } from "bitmex-node";
const bitmex = new BitmexAPI({
"apiKeyID": "NXTy391NCdhrrSWzsJE_xktb",
"apiKeySecret": "bPVQ51-xxI7bRcuAAOlvH0wUFpPvusfmC1dF6zyy4s3v8Mgd",
// "proxy": "https://cors-anywhere.herokuapp.com/"
});
!async function () {
const chatMessage = await bitmex.Chat.new({ message: 'Pump incoming !!! ' });
}()
```
#### Features:
- [BitMEX API Explorer](https://www.bitmex.com/api/explorer/#/)
- [Authentication](https://www.bitmex.com/app/apiKeysUsage)
- [Native promises](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
- [Rate limiting](https://www.bitmex.com/app/restAPI#Request-Rate-Limits)
###### Donate
- (BTC) 1CUjz7EF1iqgJPi3MPW6Nb556tQwPNryM3