{"_id":"@barfinex/detector-plugin-orderflow-trade-analytics","_rev":"5-13538f2545099f68cbec4e648fd75dcf","name":"@barfinex/detector-plugin-orderflow-trade-analytics","dist-tags":{"latest":"1.0.4"},"versions":{"1.0.0":{"name":"@barfinex/detector-plugin-orderflow-trade-analytics","version":"1.0.0","keywords":["barfinex","detector","plugin","orderflow","trade","analytics","orderflow-trade-analytics","trading","market-data","market-analysis","nestjs","nestjs-module","typescript","quant","backtesting"],"author":{"name":"Barfinex"},"license":"MIT","_id":"@barfinex/detector-plugin-orderflow-trade-analytics@1.0.0","maintainers":[{"name":"vvsur","email":"info@barfin.org"}],"homepage":"https://github.com/barfinex/detector-plugin-orderflow-trade-analytics#readme","bugs":{"url":"https://github.com/barfinex/detector-plugin-orderflow-trade-analytics/issues"},"dist":{"shasum":"4a0d23b532e4e014b18ec1cf92e53ed490abdcac","tarball":"https://registry.npmjs.org/@barfinex/detector-plugin-orderflow-trade-analytics/-/detector-plugin-orderflow-trade-analytics-1.0.0.tgz","fileCount":20,"integrity":"sha512-YqNJQqugOrR87CFFpS+7zdzxZhQ5BYtEJF/BWKik0ZQIPESzquAW5EuHQ3hZ/18KKfCMUhrXW3SmafleI/a2dQ==","signatures":[{"sig":"MEUCIQCyQoDmV36+Di22eAavbXAEDRvRJhwBpoLLF1p1PSG4jAIgXkfxWErNT9iydAPFXvd2M/29mdPpT1GYAEJX1n0ao4c=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":33571},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"331873fa681e9883ddea9ed1f5ef18eec571c4c6","private":false,"release":{"branches":["main"]},"scripts":{"build":"tsc -p tsconfig.app.json","clean":"rimraf dist","release":"semantic-release"},"_npmUser":{"name":"vvsur","email":"info@barfin.org"},"repository":{"url":"git+https://github.com/barfinex/detector-plugin-orderflow-trade-analytics.git","type":"git"},"_npmVersion":"10.9.4","description":"Detector plugin Orderflow Trade Analytics for the Barfinex ecosystem. Provides order flow analysis, trade monitoring, and advanced analytics capabilities for detectors.","directories":{},"_nodeVersion":"20.19.5","dependencies":{"@nestjs/common":"^10.0.0","@barfinex/types":"^1.0.14","@barfinex/utils":"^1.0.1","@nestjs/swagger":"^7.1.10","@barfinex/detector":"^1.0.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"rimraf":"^5.0.0","typescript":"^5.6.0","semantic-release":"^24.0.0","@semantic-release/git":"^10.0.0","@semantic-release/npm":"^12.0.0","@semantic-release/github":"^10.0.0","@semantic-release/commit-analyzer":"^13.0.0","@semantic-release/release-notes-generator":"^14.0.0"},"_npmOperationalInternal":{"tmp":"tmp/detector-plugin-orderflow-trade-analytics_1.0.0_1761302398912_0.15491903260098727","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@barfinex/detector-plugin-orderflow-trade-analytics","version":"1.0.1","keywords":["barfinex","detector","plugin","orderflow","trade","analytics","trading","nestjs","quant","typescript","orderflow-trade-analytics"],"author":{"name":"Barfinex"},"license":"MIT","_id":"@barfinex/detector-plugin-orderflow-trade-analytics@1.0.1","maintainers":[{"name":"vvsur","email":"info@barfin.org"}],"homepage":"https://github.com/barfinex/detector-plugin-orderflow-trade-analytics#readme","bugs":{"url":"https://github.com/barfinex/detector-plugin-orderflow-trade-analytics/issues"},"dist":{"shasum":"e1c8afa818a090d09a415f9e3ebce94610ea2890","tarball":"https://registry.npmjs.org/@barfinex/detector-plugin-orderflow-trade-analytics/-/detector-plugin-orderflow-trade-analytics-1.0.1.tgz","fileCount":20,"integrity":"sha512-gYam6k55aisBYZakDx9vSHS2rD1Ko+uYHmlQ2xcYOi4WpWaDjPgtJ4GHvuBP85E2vVPdKQdhgVeJYlCRgvWNwQ==","signatures":[{"sig":"MEQCIFYuNbORyR7KyX+zz/aKZlDwz6yZWumkVlnSm9DFR5y1AiAgZQkCQUrHnBvWXxny5tK59eusi+iDxEDD1qQhm8/m0g==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":33992},"main":"./dist/index.js","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.js"}},"gitHead":"2e6392b2166bee31eba08a06c2111387ca50ff81","private":false,"release":{"branches":["main"]},"scripts":{"build":"tsc -p tsconfig.app.json","clean":"rimraf dist tsconfig.tsbuildinfo","rebuild":"npm run clean && npm run build","release":"semantic-release","build:npm":"tsc -p tsconfig.build.json"},"_npmUser":{"name":"vvsur","email":"info@barfin.org"},"repository":{"url":"git+https://github.com/barfinex/detector-plugin-orderflow-trade-analytics.git","type":"git"},"_npmVersion":"10.9.4","description":"Detector plugin Orderflow Trade Analytics for the Barfinex ecosystem. Provides order flow analysis, trade monitoring, and advanced analytics capabilities for detectors.","directories":{},"sideEffects":false,"_nodeVersion":"20.19.5","dependencies":{"@barfinex/types":"^1.0.22","@barfinex/utils":"^1.0.6","@barfinex/detector":"^1.0.1"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"devDependencies":{"rimraf":"^5.0.5","typescript":"^5.6.3","@types/node":"^20.11.30","semantic-release":"^24.1.0","@semantic-release/git":"^10.0.1","@semantic-release/npm":"^12.0.0","@semantic-release/github":"^11.0.6","@semantic-release/commit-analyzer":"^13.0.0","@semantic-release/release-notes-generator":"^14.0.0"},"peerDependencies":{"rxjs":"^7.8.1","@nestjs/core":"^10.0.0","@nestjs/common":"^10.0.0","@nestjs/swagger":"^7.1.10","reflect-metadata":"^0.2.1"},"_npmOperationalInternal":{"tmp":"tmp/detector-plugin-orderflow-trade-analytics_1.0.1_1761680409689_0.4713138756760529","host":"s3://npm-registry-packages-npm-production"}},"1.0.2":{"name":"@barfinex/detector-plugin-orderflow-trade-analytics","version":"1.0.2","keywords":["barfinex","detector","plugin","orderflow","trade","analytics","trading","nestjs","quant","typescript","orderflow-trade-analytics"],"author":{"name":"Barfinex"},"license":"MIT","_id":"@barfinex/detector-plugin-orderflow-trade-analytics@1.0.2","maintainers":[{"name":"vvsur","email":"info@barfin.org"}],"homepage":"https://github.com/barfinex/detector-plugin-orderflow-trade-analytics#readme","bugs":{"url":"https://github.com/barfinex/detector-plugin-orderflow-trade-analytics/issues"},"dist":{"shasum":"7644bf2b37219afc2f01bbe52f835cc87b7c15c6","tarball":"https://registry.npmjs.org/@barfinex/detector-plugin-orderflow-trade-analytics/-/detector-plugin-orderflow-trade-analytics-1.0.2.tgz","fileCount":38,"integrity":"sha512-oJ3sw+tJ0tPq6ubA2wvwaiAEztkzG4yaWmuzVz+/fNfhaQyYCLXNLBtzjOz2G3BsAkBFXK3uoqwItYWywIa2nQ==","signatures":[{"sig":"MEUCIQC+DI2qkQ5erHd7072MjpYLbyLH2akVXgUBSsa/7rSBXwIgHRimcL5HE++MyLnQHSBSOM2ziE5qaIe9Hg8vDoV23Bk=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":52470},"main":"./dist/index.js","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.js"}},"gitHead":"e1cde73a0e76ca5ebc5efe4cc837347d398b8ea8","private":false,"release":{"branches":["main"]},"scripts":{"build":"tsc -p tsconfig.app.json","clean":"rimraf dist tsconfig.tsbuildinfo","rebuild":"npm run clean && npm run build","release":"semantic-release","prebuild":"node ../../../tools/hygiene/clean-compiled-in-src.js","build:npm":"tsc -p tsconfig.build.json","postbuild":"node ../../../tools/hygiene/verify-no-compiled-in-src.js","prebuild:npm":"node ../../../tools/hygiene/clean-compiled-in-src.js","postbuild:npm":"node ../../../tools/hygiene/verify-no-compiled-in-src.js"},"_npmUser":{"name":"vvsur","email":"info@barfin.org"},"buildDate":"2026-03-26T15:00:00","repository":{"url":"git+https://github.com/barfinex/detector-plugin-orderflow-trade-analytics.git","type":"git"},"_npmVersion":"10.8.2","description":"Detector plugin Orderflow Trade Analytics for the Barfinex ecosystem. Provides order flow analysis, trade monitoring, and advanced analytics capabilities for detectors.","directories":{},"sideEffects":false,"_nodeVersion":"20.20.1","dependencies":{"@barfinex/types":"latest","@barfinex/utils":"latest","@barfinex/detector":"latest"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"devDependencies":{"rimraf":"^5.0.5","typescript":"^5.6.3","@types/node":"^20.11.30","semantic-release":"^24.1.0","@semantic-release/git":"^10.0.1","@semantic-release/npm":"^12.0.0","@semantic-release/github":"^11.0.6","@semantic-release/commit-analyzer":"^13.0.0","@semantic-release/release-notes-generator":"^14.0.0"},"peerDependencies":{"rxjs":"^7.8.1","@nestjs/core":"^10.0.0","@nestjs/common":"^10.0.0","@nestjs/swagger":"^7.1.10","reflect-metadata":"^0.2.1"},"_npmOperationalInternal":{"tmp":"tmp/detector-plugin-orderflow-trade-analytics_1.0.2_1774512908338_0.730290445104226","host":"s3://npm-registry-packages-npm-production"}},"1.0.3":{"name":"@barfinex/detector-plugin-orderflow-trade-analytics","version":"1.0.3","keywords":["barfinex","detector","plugin","orderflow","trade","analytics","trading","nestjs","quant","typescript","orderflow-trade-analytics"],"author":{"name":"Barfinex"},"license":"MIT","_id":"@barfinex/detector-plugin-orderflow-trade-analytics@1.0.3","maintainers":[{"name":"vvsur","email":"info@barfin.org"}],"homepage":"https://github.com/barfinex/detector-plugin-orderflow-trade-analytics#readme","bugs":{"url":"https://github.com/barfinex/detector-plugin-orderflow-trade-analytics/issues"},"dist":{"shasum":"0a45dde6d44813052c4dd59220c8d347cd24ef97","tarball":"https://registry.npmjs.org/@barfinex/detector-plugin-orderflow-trade-analytics/-/detector-plugin-orderflow-trade-analytics-1.0.3.tgz","fileCount":38,"integrity":"sha512-PP9mr+4tjEKovnlfDlf2K1ttbsTIeUKUqOHyXUbz+oxwixM/WN5Vs6gGHDjb4hos+xP4wrKqFXVA2d7vPy5ZUw==","signatures":[{"sig":"MEQCIAzadwAGm2DL+Qyh2w4fbP0gAUjDDGmzL9EbDumakxDtAiAmn5YC6ci6ZdEz2CRLuQx/cXXPlcUylTVmovx8yZ4XCg==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":52470},"main":"./dist/index.js","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.js"}},"gitHead":"33f06e3eaba499eff0415cc1a6e8eb2e4a0b4332","private":false,"release":{"branches":["main"]},"scripts":{"build":"tsc -p tsconfig.app.json","clean":"rimraf dist tsconfig.tsbuildinfo","rebuild":"npm run clean && npm run build","release":"semantic-release","prebuild":"node ../../../tools/hygiene/clean-compiled-in-src.js","build:npm":"tsc -p tsconfig.build.json","postbuild":"node ../../../tools/hygiene/verify-no-compiled-in-src.js","prebuild:npm":"node ../../../tools/hygiene/clean-compiled-in-src.js","postbuild:npm":"node ../../../tools/hygiene/verify-no-compiled-in-src.js"},"_npmUser":{"name":"vvsur","email":"info@barfin.org"},"buildDate":"2026-03-26T17:00:00","repository":{"url":"git+https://github.com/barfinex/detector-plugin-orderflow-trade-analytics.git","type":"git"},"_npmVersion":"10.8.2","description":"Detector plugin Orderflow Trade Analytics for the Barfinex ecosystem. Provides order flow analysis, trade monitoring, and advanced analytics capabilities for detectors.","directories":{},"sideEffects":false,"_nodeVersion":"20.20.1","dependencies":{"@barfinex/types":"latest","@barfinex/utils":"latest","@barfinex/detector":"latest"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"devDependencies":{"rimraf":"^5.0.5","typescript":"^5.6.3","@types/node":"^20.11.30","semantic-release":"^24.1.0","@semantic-release/git":"^10.0.1","@semantic-release/npm":"^12.0.0","@semantic-release/github":"^11.0.6","@semantic-release/commit-analyzer":"^13.0.0","@semantic-release/release-notes-generator":"^14.0.0"},"peerDependencies":{"rxjs":"^7.8.1","@nestjs/core":"^10.0.0","@nestjs/common":"^10.0.0","@nestjs/swagger":"^7.1.10","reflect-metadata":"^0.2.1"},"_npmOperationalInternal":{"tmp":"tmp/detector-plugin-orderflow-trade-analytics_1.0.3_1774513484654_0.2584341559464298","host":"s3://npm-registry-packages-npm-production"}},"1.0.4":{"name":"@barfinex/detector-plugin-orderflow-trade-analytics","version":"1.0.4","private":false,"description":"Detector plugin Orderflow Trade Analytics for the Barfinex ecosystem. Provides order flow analysis, trade monitoring, and advanced analytics capabilities for detectors.","author":{"name":"Barfinex"},"license":"MIT","homepage":"https://github.com/barfinex/detector-plugin-orderflow-trade-analytics#readme","repository":{"type":"git","url":"git+https://github.com/barfinex/detector-plugin-orderflow-trade-analytics.git"},"bugs":{"url":"https://github.com/barfinex/detector-plugin-orderflow-trade-analytics/issues"},"main":"./dist/index.js","types":"./dist/index.d.ts","exports":{".":{"import":"./dist/index.js","require":"./dist/index.js","types":"./dist/index.d.ts"}},"sideEffects":false,"scripts":{"clean":"rimraf dist tsconfig.tsbuildinfo","prebuild":"node ../../../tools/hygiene/clean-compiled-in-src.js","build":"tsc -p tsconfig.app.json","postbuild":"node ../../../tools/hygiene/verify-no-compiled-in-src.js","prebuild:npm":"node ../../../tools/hygiene/clean-compiled-in-src.js","build:npm":"tsc -p tsconfig.build.json","postbuild:npm":"node ../../../tools/hygiene/verify-no-compiled-in-src.js","rebuild":"npm run clean && npm run build","release":"semantic-release"},"keywords":["barfinex","detector","plugin","orderflow","trade","analytics","trading","nestjs","quant","typescript","orderflow-trade-analytics"],"dependencies":{"@barfinex/detector":"latest","@barfinex/types":"latest","@barfinex/utils":"latest"},"peerDependencies":{"@nestjs/common":"^10.0.0","@nestjs/core":"^10.0.0","@nestjs/swagger":"^7.1.10","reflect-metadata":"^0.2.1","rxjs":"^7.8.1"},"devDependencies":{"typescript":"^5.6.3","rimraf":"^5.0.5","semantic-release":"^24.1.0","@semantic-release/npm":"^12.0.0","@semantic-release/git":"^10.0.1","@semantic-release/github":"^11.0.6","@semantic-release/commit-analyzer":"^13.0.0","@semantic-release/release-notes-generator":"^14.0.0","@types/node":"^20.11.30"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"release":{"branches":["main"]},"buildDate":"2026-03-26T17:00:00","_id":"@barfinex/detector-plugin-orderflow-trade-analytics@1.0.4","gitHead":"ffe9a3ddb61c13eb342801cd23d430885d1c1ede","_nodeVersion":"20.20.1","_npmVersion":"10.8.2","dist":{"integrity":"sha512-qdfIrOpzqpEcNwFk/gp7rV1ujwiaNWnMoFv09ksgKVppS9zaXY891IadM5PIUCyWw5DsiRCt8ihOxJsY8MWr/Q==","shasum":"d72ccba20258fba42e561edb2eefcb9f3f280687","tarball":"https://registry.npmjs.org/@barfinex/detector-plugin-orderflow-trade-analytics/-/detector-plugin-orderflow-trade-analytics-1.0.4.tgz","fileCount":38,"unpackedSize":52470,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCICvgy4w13KVlX5H5hmsvu1YMzggOS4vbVpZwhq3P98w6AiAxEazNN2bKV91gTICWRtfK0IMBrFotBcMu6vf2Lg05DQ=="}]},"_npmUser":{"name":"vvsur","email":"info@barfin.org"},"directories":{},"maintainers":[{"name":"vvsur","email":"info@barfin.org"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/detector-plugin-orderflow-trade-analytics_1.0.4_1774513923094_0.4601469261606572"},"_hasShrinkwrap":false}},"time":{"created":"2025-10-24T10:39:58.773Z","modified":"2026-03-26T08:32:03.356Z","1.0.0":"2025-10-24T10:39:59.092Z","1.0.1":"2025-10-28T19:40:09.877Z","1.0.2":"2026-03-26T08:15:08.508Z","1.0.3":"2026-03-26T08:24:44.791Z","1.0.4":"2026-03-26T08:32:03.232Z"},"bugs":{"url":"https://github.com/barfinex/detector-plugin-orderflow-trade-analytics/issues"},"author":{"name":"Barfinex"},"license":"MIT","homepage":"https://github.com/barfinex/detector-plugin-orderflow-trade-analytics#readme","keywords":["barfinex","detector","plugin","orderflow","trade","analytics","trading","nestjs","quant","typescript","orderflow-trade-analytics"],"repository":{"type":"git","url":"git+https://github.com/barfinex/detector-plugin-orderflow-trade-analytics.git"},"description":"Detector plugin Orderflow Trade Analytics for the Barfinex ecosystem. Provides order flow analysis, trade monitoring, and advanced analytics capabilities for detectors.","maintainers":[{"name":"vvsur","email":"info@barfin.org"}],"readme":"# @barfinex/detector-plugin-orderflow-trade-analytics\n\n**Orderflow and trade analytics plugin** for the [Barfinex](https://barfinex.com) Detector — analyze trade flow, order book imbalance, and market microstructure in real time.\n\nThis plugin extends the Detector with metrics that candles alone don’t show: delta, CVD-style aggregates, absorption, and liquidity shifts. Use it from your strategies to improve entries and risk.\n\n---\n\n## What it does\n\n- **Trade ingestion** — `ingestTrade` / `ingestOrderbook` to feed the plugin from detector market-data hooks.\n- **Metrics** — delta ratio, cumulative volume, order book imbalance, large-trade VWAP, and configurable thresholds.\n- **Plugin API** — `getMetrics`, `getDebugState`, `getOrderBookImbalanceFromState`, `getTradeDeltaByLastN` for strategy logic and debugging.\n- **Detector integration** — runs as a detector plugin via `@barfinex/plugin-driver`; registers with Provider so Studio can call its plugin API.\n\n---\n\n## Installation\n\n```sh\nnpm install @barfinex/detector-plugin-orderflow-trade-analytics\n```\n\nor\n\n```sh\nyarn add @barfinex/detector-plugin-orderflow-trade-analytics\n```\n\n---\n\n## What's included\n\n| Export | Purpose |\n|--------|--------|\n| `OrderflowTradeAnalyticsModule` | NestJS module for the plugin. |\n| `OrderflowTradeAnalyticsService` | Plugin service: ingest, metrics, state. |\n| `OrderflowTradeAnalyticsController` | REST/plugin API controller. |\n| `SymbolMetrics`, `OrderflowState`, `AnalyticsConfig`, etc. | Types for metrics and config. |\n\n---\n\n## Documentation\n\n- **Detector (host for this plugin)** — [Installation detector](https://barfinex.com/docs/installation-detector) — config and plugin list (e.g. `orderflow-trade-analytics`).\n- **Barfinex overview** — [First Steps](https://barfinex.com/docs/first-steps), [Architecture](https://barfinex.com/docs/architecture), [Glossary](https://barfinex.com/docs/glossary).\n- **APIs** — [Detector API reference](https://barfinex.com/docs/detector-api), [Provider API reference](https://barfinex.com/docs/provider-api), [Building with the API](https://barfinex.com/docs/frontend-api).\n- **Troubleshooting** — [Typical problems and solutions](https://barfinex.com/docs/troubleshooting).\n\n---\n\n## Contributing\n\nNew metrics and detection ideas welcome. Open an issue or PR. Community: [Telegram](https://t.me/barfinex) · [GitHub](https://github.com/barfinex).\n\n---\n\n## License\n\nLicensed under the [Apache License 2.0](LICENSE) with additional terms. Attribution to **Barfin Network Limited** and a link to [https://barfinex.com](https://barfinex.com) are required. Commercial use requires explicit permission. See [LICENSE](LICENSE) and the [Barfinex site](https://barfinex.com) for details.\n","readmeFilename":"README.md"}