Skip to main content

Kline data

GET /api/klines/data

Retrieve raw kline data with flexible filtering.
symbol
string
required
Symbol name.
interval
string
Kline interval (1m, 5m, 15m, 1h, 4h, 1d).
start
string
Start time (ISO 8601).
end
string
End time (ISO 8601).
Example request
curl "https://api.hyperoru.com/api/klines/data?symbol=BTC&interval=1h&start=2026-04-01&end=2026-04-09"
Example response
[
  { "timestamp": "2026-04-01T00:00:00Z", "open": 67000.0, "high": 67500.0, "low": 66800.0, "close": 67200.0, "volume": 500.0 }
]

Coverage

GET /api/klines/coverage

Check kline data coverage across all tracked symbols. Example request
curl https://api.hyperoru.com/api/klines/coverage
Example response
[
  { "symbol": "BTC", "interval": "1h", "earliest": "2025-01-01T00:00:00Z", "latest": "2026-04-09T12:00:00Z", "total_candles": 12000 }
]

Supported symbols

GET /api/klines/supported-symbols

List all symbols with available kline data. Example request
curl https://api.hyperoru.com/api/klines/supported-symbols
Example response
{
  "symbols": ["BTC", "ETH", "SOL", "ARB"]
}

List backfill tasks

GET /api/klines/backfill-tasks

List all kline backfill tasks. Example request
curl https://api.hyperoru.com/api/klines/backfill-tasks
Example response
[
  { "id": "bf-001", "symbol": "BTC", "interval": "1h", "status": "completed", "progress_pct": 100.0 }
]

Create backfill

POST /api/klines/backfill

Start a new kline data backfill task.
symbol
string
required
Symbol to backfill.
interval
string
required
Kline interval.
start_date
string
Backfill start date.
end_date
string
Backfill end date.
Example request
curl -X POST https://api.hyperoru.com/api/klines/backfill \
  -H "Content-Type: application/json" \
  -d '{"symbol": "BTC", "interval": "1h", "start_date": "2025-06-01"}'
Example response
{
  "id": "bf-002",
  "status": "running"
}

Backfill status

GET /api/klines/backfill/status/

Check progress of a specific backfill task.
task_id
string
required
Backfill task ID.
Example request
curl https://api.hyperoru.com/api/klines/backfill/status/bf-002
Example response
{
  "id": "bf-002",
  "status": "running",
  "progress_pct": 62.5,
  "candles_fetched": 5000
}

Delete backfill task

DELETE /api/klines/backfill-tasks/

Delete a backfill task record.
task_id
string
required
Task ID.
Example request
curl -X DELETE https://api.hyperoru.com/api/klines/backfill-tasks/bf-001
Example response
{
  "status": "ok"
}

Detect data gaps

GET /api/klines/gaps/

Detect missing data gaps for a symbol.
symbol
string
required
Symbol name.
interval
string
Kline interval to check.
Example request
curl "https://api.hyperoru.com/api/klines/gaps/BTC?interval=1h"
Example response
{
  "symbol": "BTC",
  "gaps": [
    { "start": "2026-03-15T00:00:00Z", "end": "2026-03-15T06:00:00Z", "missing_candles": 6 }
  ]
}

Create AI analysis

POST /api/klines/ai-analysis

Run an AI-powered analysis on kline data.
symbol
string
required
Symbol to analyze.
interval
string
Kline interval for analysis.
prompt
string
Custom analysis prompt.
Example request
curl -X POST https://api.hyperoru.com/api/klines/ai-analysis \
  -H "Content-Type: application/json" \
  -d '{"symbol": "BTC", "interval": "4h"}'
Example response
{
  "analysis_id": "analysis-001",
  "status": "running"
}

AI analysis history

GET /api/klines/ai-analysis/history

List past AI kline analyses. Example request
curl https://api.hyperoru.com/api/klines/ai-analysis/history
Example response
[
  { "id": "analysis-001", "symbol": "BTC", "status": "completed", "created_at": "2026-04-09T10:00:00Z" }
]

AI analysis detail

GET /api/klines/ai-analysis/

Get the full result of an AI kline analysis.
analysis_id
string
required
Analysis ID.
Example request
curl https://api.hyperoru.com/api/klines/ai-analysis/analysis-001
Example response
{
  "id": "analysis-001",
  "symbol": "BTC",
  "status": "completed",
  "analysis": "BTC is showing a bullish divergence on the 4h chart...",
  "created_at": "2026-04-09T10:00:00Z"
}

Backfill tasks list (alternate)

GET /api/klines/backfill/tasks

Alternative endpoint to list backfill tasks. Example request
curl https://api.hyperoru.com/api/klines/backfill/tasks
Example response
[
  { "id": "bf-001", "symbol": "BTC", "status": "completed" }
]