@barfinex/connectors
v1.0.5
Published
Connectors module for the Barfinex ecosystem. Provides integration with external market data providers (Binance, Alpaca, Tinkoff, etc.) via NestJS.
Maintainers
Readme
@barfinex/connectors
Exchange and broker integration layer for the Barfinex ecosystem — connect to Binance, Alpaca, and other venues for market data and order execution through a single abstraction.
This library gives your Barfinex services real-time and historical data, order placement, and subscriptions with a unified API. By centralizing connector logic, you get consistent behaviour across Provider, Detector, and any app that talks to exchanges.
What it does
- Unified API — one interface for candles, trades, orderbooks, and orders across supported exchanges.
- Live and historical data — stream subscriptions plus helpers for historical candles (e.g. Binance, Alpaca).
- NestJS-ready —
ConnectorModuleandConnectorServicefor dependency injection and lifecycle. - Type-safe — built on
@barfinex/typesso symbols, intervals, and orders match the rest of the stack.
Installation
npm install @barfinex/connectorsor
yarn add @barfinex/connectorsWhat's included
| Export | Purpose |
|--------|--------|
| ConnectorModule | NestJS module that registers connector providers. |
| ConnectorService | Main service: subscriptions, market data, order operations. |
| createRequestBinance | Binance historical data helper. |
| requestAlpaca | Alpaca historical data helper. |
Documentation
- Barfinex overview — First Steps, Architecture, Glossary.
- Provider (uses connectors) — Installation provider, Docker Compose for Provider, Understanding Provider Logs.
- Detector (consumes market data) — Installation detector.
- Studio — Terminal Configuration, Registering Provider in Studio.
- APIs — Provider API reference, Building with the API, Typical problems and solutions.
Contributing
New connectors (e.g. Bybit, OKX) and improvements are welcome. Open an issue or PR. Community: Telegram · GitHub.
License
Licensed under the Apache License 2.0 with additional terms. Attribution to Barfin Network Limited and a link to https://barfinex.com are required. Commercial use requires explicit permission. See LICENSE and the Barfinex site for details.
