@barfinex/types
v1.0.31
Published
Core TypeScript type definitions and shared interfaces for the Barfinex ecosystem. Provides strongly-typed contracts for modules, services, and plugins.
Maintainers
Readme
@barfinex/types
Shared TypeScript contracts for the Barfinex ecosystem — accounts, orders, positions, signals, connectors, and API boundaries in one place.
Every Barfinex component (Provider, Detector, Advisor, Inspector, connectors, plugins) uses these types. That means one language for trading entities, fewer mismatches between services, and better autocomplete and refactoring in your IDE.
What it does
- Domain models —
Account,Order,Position,Candle,OrderBook,Trade,Signal, and related enums (e.g.OrderSide,MarketType,ConnectorType). - Service contracts — interfaces for detectors, advisors, inspectors, providers, and plugins so they can be composed and proxied.
- Subscriptions & config — types for market data subscriptions, detector config, and connector options.
- Consistency — same shapes in REST APIs, Redis events, and Studio; aligned with Provider API and Detector.
Installation
npm install @barfinex/typesor
yarn add @barfinex/typesWhat's included
Core interfaces and enums used across the platform, including:
- Trading —
Account,Order,Position,OrderSide,OrderType,OrderSource,MarketType,ConnectorType. - Market data —
Candle,Trade,OrderBook,Symbol, subscription types. - Signals & components —
Signal, detector/advisor/inspector/provider interfaces, plugin contracts. - Config & history — detector config, history requests, common primitives.
Documentation
- Barfinex overview — First Steps, Architecture, Glossary.
- APIs (types underpin these) — Provider API reference, Building with the API, Signals context API.
- Deployment — Installation provider, Installation detector, Terminal Configuration.
- Troubleshooting — Typical problems and solutions.
Contributing
Proposals for new domain types or refinements 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.
