Skip to main content

General Info

Base URL​

https://api.pipai.org

The host serves two route families: a transparent Binance mirror under /fapi/v1/* (nginx forwards verbatim to fapi.binance.com), and the FastAPI gateway for everything else. See the Market Data overview for which family each endpoint uses.

Request and response format​

  • All requests and responses use JSON.
  • Two timestamp conventions coexist:
    • Platform-owned resources (e.g. strategies) return ISO 8601 UTC strings such as 2026-04-29T12:00:00.
    • Market-data passthroughs preserve Binance's Unix-millisecond integers.
  • Numeric prices and quantities returned by market-data passthroughs are strings (Binance convention).
  • Path parameters and query parameters use the casing the backend declares. Most market-data query params are camelCase (startTime, endTime); a few legacy endpoints use snake_case (start_time, end_time) — each page calls this out.

Rate limits​

  • Per-IP, sliding 60-second window, 1000 requests per minute.
  • Exceeding the limit returns HTTP 429 with {"detail": "请求过于频繁。每个 IP 每分钟最多允许 1000 次请求。"} and triggers a one-hour block on that IP.
  • Subsequent requests during a block return HTTP 429 with {"detail": "IP <ip> 已被暂时封锁。请求过于频繁，请稍后再试。"}.
  • / and /health are excluded from rate limiting.

Health check​

GET /health

Returns {"status": "healthy", "timestamp": "<ISO 8601>"}. No auth, not rate-limited.