Socket
Socket
Sign inDemoInstall

bfx-api-node-ws1

Package Overview
Dependencies
9
Maintainers
3
Versions
5
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    bfx-api-node-ws1

Legacy WSv1 transport for the Bitfinex Node API


Version published
Weekly downloads
375
increased by17.55%
Maintainers
3
Install size
2.57 MB
Created
Weekly downloads
 

Readme

Source

Bitfinex WSv1 Reference Implementation for Node.JS

Build Status

This repo contains the reference implementation for version 1 of the websocket Bitfinex API. It is deprecated in favour of version 2, and should no longer be used.

For the version 2 API library, see bitfinex-api-node

Features

  • Emits API data as events from the class instance
  • Provides methods for channel management & listening to incoming data

Installation

npm i --save bfx-api-node-ws1

Quickstart & Example

const WSv1 = require('bfx-api-node-ws1')
const ws = new WSv1()

ws.open()

ws.on('open', () => {
  ws.subscribeTrades('BTCUSD')
})

ws.on('trades', (pair, trade) => {
  console.log(JSON.stringify({ pair, trade }, null, 2))
})

Docs

For JSDoc-generated API documentation, see docs/ws1.md

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Keywords

FAQs

Last updated on 22 Nov 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc