# bitmex-websocket-api

> Bitmex WebSocket Client

Latest version **1.0.2** (published 2020-04-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install bitmex-websocket-api
pnpm add bitmex-websocket-api
yarn add bitmex-websocket-api
bun add bitmex-websocket-api
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2020-04-07 |
| First published | 2020-04-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 28.5 KB |
| Known vulnerabilities | 0 (+25 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Felipe Mendes Braga |
| Maintainers | felipembbraga |

## Links

- npm: https://www.npmjs.com/package/bitmex-websocket-api
- Repository: https://github.com/felipembbraga/bitmex-websocket-api
- npm.io page: https://npm.io/package/bitmex-websocket-api

## Dependencies (8)

- [ws](https://npm.io/package/ws.md) ^7.2.3
- [axios](https://npm.io/package/axios.md) ^0.19.2
- [lodash](https://npm.io/package/lodash.md) ^4.17.15
- [@types/ws](https://npm.io/package/@types/ws.md) ^7.2.3
- [@types/node](https://npm.io/package/@types/node.md) ^13.11.0
- [query-string](https://npm.io/package/query-string.md) ^6.12.0
- [@types/lodash](https://npm.io/package/@types/lodash.md) ^4.14.149
- [eventemitter2](https://npm.io/package/eventemitter2.md) ^6.3.1

## Recent versions

- 1.0.2 (latest) — 2020-04-07
- 1.0.1 — 2020-04-07
- 1.0.0 — 2020-04-07

## README

# bitmex-websocket-api

Bitmex WebSocket Client

## install

```
npm install bitmex-websocket-api
```

## Usage

```typescript
import BitmexClient from "bitmex-websocket-api";

const ws = new BitmexClient({ apiKey: "api-key", apiSecret: "api-secret" });

ws.on("open", () => {
    console.log("is running...");
});

ws.on("close", () => {
    console.log("closing...");
});

ws.addStream("XBTUSD", "execution", async (data) => {
    console.log(data);
});
```

---
_Source: https://npm.io/package/bitmex-websocket-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._