Getting Started
The FLOWSCALP.AI API provides programmatic access to our advanced order flow and market analysis tools. Our RESTful API allows you to:
- Access real-time market data
- Analyze order flow patterns
- Receive trading signals
- Monitor market microstructure
API Key Authentication
All API requests require authentication using your API key. You can generate an API key from your dashboard.
curl -H "X-API-Key: your_api_key_here" \
https://api.flowscalp.ai/v1/market/data
GET Market Data
/v1/market/data
Parameters
| Parameter | Type | Description |
|---|---|---|
| symbol | string | Trading pair symbol (e.g., BTC-USDT) |
| interval | string | Time interval (1m, 5m, 15m, 1h, 4h, 1d) |
| limit | integer | Number of records to return (default: 100, max: 1000) |
cURL
Python
Node.js
curl -H "X-API-Key: your_api_key_here" \
"https://api.flowscalp.ai/v1/market/data?symbol=BTC-USDT&interval=1m&limit=100"
Response
{
"status": "success",
"data": {
"symbol": "BTC-USDT",
"interval": "1m",
"candles": [
{
"timestamp": "2025-02-14T12:00:00Z",
"open": 52345.67,
"high": 52400.00,
"low": 52300.00,
"close": 52380.45,
"volume": 123.45,
"orderflow_delta": 0.75
}
// ...more candles
]
}
}GET Order Flow Analysis
/v1/orderflow/analysis
cURL
Python
Node.js
curl -H "X-API-Key: your_api_key_here" \
"https://api.flowscalp.ai/v1/orderflow/analysis?symbol=BTC-USDT&timeframe=1h"
Response
{
"status": "success",
"data": {
"symbol": "BTC-USDT",
"timestamp": "2025-02-14T12:00:00Z",
"analysis": {
"buy_pressure": 0.85,
"sell_pressure": 0.15,
"large_orders": [
{
"side": "buy",
"size": 10.5,
"price": 52350,
"timestamp": "2025-02-14T12:00:00Z"
}
],
"key_levels": [
{
"price": 52400,
"type": "resistance",
"strength": 0.8
},
{
"price": 52200,
"type": "support",
"strength": 0.75
}
],
"volume_profile": {
"poc": 52350,
"value_area_high": 52400,
"value_area_low": 52300
}
}
}
}GET Trading Signals
/v1/signals
Parameters
| Parameter | Type | Description |
|---|---|---|
| symbol | string | Trading pair symbol (e.g., BTC-USDT) |
| signal_type | string | Type of signal (orderflow, liquidity, momentum) |
| timeframe | string | Signal timeframe (5m, 15m, 1h, 4h) |
cURL
Python
Node.js
curl -H "X-API-Key: your_api_key_here" \
"https://api.flowscalp.ai/v1/signals?symbol=BTC-USDT&signal_type=orderflow&timeframe=1h"
Response
{
"status": "success",
"data": {
"signals": [
{
"timestamp": "2025-02-14T12:00:00Z",
"symbol": "BTC-USDT",
"type": "orderflow",
"direction": "long",
"strength": 0.85,
"trigger_price": 52350,
"confidence": 0.78,
"indicators": {
"orderflow_delta": 0.75,
"volume_imbalance": 0.82,
"liquidity_score": 0.68
}
}
]
}
}WebSocket Feeds
Connect to our WebSocket API for real-time market data and order flow analysis:
wss://ws.flowscalp.ai/v1/stream
const ws = new WebSocket('wss://ws.flowscalp.ai/v1/stream');
ws.onopen = () => {
ws.send(JSON.stringify({
"action": "subscribe",
"channel": "orderflow",
"symbol": "BTC-USDT"
}));
};
ws.onmessage = (event) => {
const data = JSON.parse(event.data);
console.log(data);
};
Available Channels
| Channel | Description |
|---|---|
| orderflow | Real-time order flow analysis and market microstructure |
| trades | Live trade execution data with size and price analysis |
| signals | Real-time trading signals and market alerts |
| liquidity | Live liquidity map and significant order book updates |
Rate Limits
1000
Requests / Minute
50000
Requests / Hour
1000000
Requests / Day
Rate Limit Exceeded Response
{
"status": "error",
"code": 429,
"message": "Rate limit exceeded. Please try again in 60 seconds.",
"reset_at": "2025-02-14T12:01:00Z"
}Error Handling
| Error Code | Description |
|---|---|
| 400 | Bad Request - Invalid parameters |
| 401 | Unauthorized - Invalid API key |
| 403 | Forbidden - Insufficient permissions |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Internal Server Error |