Getting started
💻 Studio Terminal Setup
Learn how to connect your local Provider and Detector to Barfinex Studio, safely render market data, and monitor strategies in real time.
⚠️ Important: The Studio terminal does not send or store your trading data in the cloud.
All information is rendered directly from your local or corporate environment.
This guarantees privacy, control, and security when working with accounts and strategies.
🚀 What is the Studio terminal?
The Studio terminal is a component that connects to your local Provider service and shows:
- 📈 real‑time market data (candles, trades, order books);
- 🧩 connection statuses and active subscriptions;
- 🧠 signals from Detector and active strategies;
- 📊 Redis channel state and internal topics.
🧭 1️⃣ Connecting to a local Provider
Make sure your
Provideris running and available athttps://....Open studio.barfinex.com.
In Connections → Providers click ➕ Add Provider.
Specify connection parameters:
Name: Local Provider URL: https://localhost:8081/api Token: <your access token, if configured>
After saving you should see a status similar to:
✅ Connected to Provider 🔌 WebSocket: Active
📸 [Placeholder for a screenshot: Provider creation dialog]
🔍 2️⃣ Adding Detector
Once Provider is connected, you can add Detector to observe strategy data and signals.
- Navigate to Connections → Detectors.
- Click ➕ Add Detector.
- Fill in the parameters:
Name: Local Detector URL: https://localhost:3002/api
- Studio will automatically detect active plugins and Redis status.
📸 [Placeholder for a screenshot: Detector connection]
📡 3️⃣ What you will see in Studio
| Section | Description |
|---|---|
| Market Data | Streams of candles (OHLCV), trades, and order books |
| Signals | Trading signals from Detector (entry / exit / stop‑loss) |
| Plugins | Active analytics plugins (Trade Journal, Orderflow, Volume Follow) |
| Redis Channels | PUB/SUB channels between services |
| Logs | Real‑time events: connections, errors, status changes |
| System Health | Redis ping, WebSocket status, CPU load |
📸 [Placeholder for a screenshot: Studio dashboard overview]
🔐 Security and privacy
Barfinex Studio is built with client‑side data rendering in mind —
all data is visualized only on the client side, without passing through cloud servers.
- ❌ No trading data, API keys or signals are sent to the cloud.
- 🔒 WebSocket connects directly to your local service.
- 🧠 Studio stores only connection metadata in your browser (LocalStorage).
- 🪄 After a restart, connections can be restored manually.
⚙️ 4️⃣ Example connection configuration
{
"providers": [
{
"id": "local-provider",
"name": "Binance Provider",
"url": "https://localhost:8081/api",
"ws": "wss://localhost:8081/ws"
}
],
"detectors": [
{
"id": "main-detector",
"name": "Volume Follow Detector",
"url": "https://localhost:3002/api"
}
]
}
📸 [Placeholder for a screenshot: JSON connection configuration]
🧠 5️⃣ Tips and tricks
| Task | How to do it |
|---|---|
| Refresh a connection | Click Reconnect in the Provider list |
| Check WebSocket | Open Network → WS in browser DevTools |
| Inspect Redis | Run docker exec -it redis redis-cli monitor |
| Update token | Open connection settings → Edit Token |
| Reset Studio configuration | Use the menu → Clear Local Storage |
💬 6️⃣ Frequently asked questions
🔹 Can I connect multiple Providers?
Yes, Studio supports multiple data sources (for example, Binance + Alpaca).
🔹 What if no data is shown?
Check that your local API is accessible over HTTPS and the port (8081/3001) is open.
🔹 Do I need an account?
No. Studio works autonomously and does not require authentication for local usage.
📘 Summary
- The Studio terminal is a secure client‑side interface for your local services.
- Data never leaves your environment.
- Connecting Provider and Detector takes less than a minute.
- Real‑time visualization of streams, signals, and strategies is available straight from your browser.
📸 [Placeholder for a final screenshot: overall Studio interface]
You’re all set! 🎯 Now you can monitor your trading data and strategies right from the browser — securely, conveniently, and with minimal configuration.