Разработка REST API для исторических рыночных данных
REST API для исторических данных — это интерфейс между хранилищем временных рядов и потребителями: торговыми ботами, аналитическими системами, бэктестерами. Качество API определяется скоростью ответа, гибкостью фильтрации и надёжностью под нагрузкой.
Дизайн эндпоинтов
Базовый набор эндпоинтов для маркет-данных:
GET /v1/ohlcv/{exchange}/{symbol}
?from=2024-01-01T00:00:00Z
&to=2024-01-31T23:59:59Z
&interval=1h
&limit=1000
GET /v1/trades/{exchange}/{symbol}
?from=1704067200000
&to=1704153600000
&limit=10000
GET /v1/orderbook/{exchange}/{symbol}/snapshot
?timestamp=1704067200000
&depth=20
GET /v1/tickers/{exchange}/{symbol}/history
?from=2024-01-01
&to=2024-01-02
&fields=close,volume
Использование ISO 8601 для пользовательского интерфейса и Unix timestamp (milliseconds) для программного доступа. Поддержка обоих форматов через автоматическое определение.
Параметры и валидация
from fastapi import FastAPI, Query
from datetime import datetime
from typing import Optional
@app.get("/v1/ohlcv/{exchange}/{symbol}")
async def get_ohlcv(
exchange: str,
symbol: str,
interval: str = Query("1h", regex="^(1m|5m|15m|1h|4h|1d|1w)$"),
from_time: datetime = Query(..., alias="from"),
to_time: datetime = Query(..., alias="to"),
limit: int = Query(1000, ge=1, le=50000),
):
if (to_time - from_time).days > 365:
raise HTTPException(400, "Date range cannot exceed 365 days")
data = await candle_service.get_candles(
exchange, symbol, interval, from_time, to_time, limit
)
return {"data": data, "count": len(data)}
Пагинация для больших датасетов
Cursor-based пагинация эффективнее offset для временных рядов:
{
"data": [...],
"cursor": {
"next": "eyJ0aW1lc3RhbXAiOiAxNzA0MDY3MjAwMDAwfQ==",
"has_more": true
}
}
Cursor — base64-encoded JSON с последним timestamp в текущей странице. При следующем запросе клиент передаёт ?cursor=... вместо ?from=....
Кэширование
Исторические данные неизменны — идеальный кандидат для агрессивного кэширования:
-
HTTP Cache-Control:
public, max-age=3600для данных старше суток - Redis Cache: для часто запрашиваемых диапазонов (популярные символы, последние 30 дней)
- Query Cache в TimescaleDB / ClickHouse для тяжёлых агрегаций
Стратегия: если запрошенный диапазон полностью в прошлом (закрыт) — кэшируем на 24 часа. Если включает текущий момент — кэшируем на 60 секунд.
Rate Limiting и аутентификация
from slowapi import Limiter
from slowapi.util import get_remote_address
limiter = Limiter(key_func=get_remote_address)
@app.get("/v1/ohlcv/{exchange}/{symbol}")
@limiter.limit("100/minute")
async def get_ohlcv(...):
...
Для коммерческого API — тарифные планы через API-ключи с разными лимитами: free (10 req/min, 30 дней истории), paid (1000 req/min, полная история).
Документация через OpenAPI
FastAPI автоматически генерирует OpenAPI схему. Дополнительно — примеры запросов/ответов в документации, описание форматов, коды ошибок. Swagger UI и ReDoc из коробки — клиенты смогут тестировать API прямо в браузере без дополнительных инструментов.