Getting Started

The ByteTree API provides real-time and historical data for FX rates, global stocks, crypto assets, and computed ByteTrend metrics.

Base URL

All endpoints are served from:

https://api.bytetree.io

Authentication

Every endpoint except GET /api/health requires an API key, sent as a bearer token:

curl https://api.bytetree.io/api/assets \
-H "Authorization: Bearer YOUR_API_KEY"

See Authentication for how to obtain a key and the full scope and error model.

Response Format

All endpoints return JSON by default. You can request alternative formats using the format query parameter:

# CSV
curl "https://api.bytetree.io/api/rates?format=csv"

# TOON
curl "https://api.bytetree.io/api/rates?format=toon"

Unsupported format values return 400 Bad Request.

Response Conventions

Paginated list envelope

List endpoints that support consumer-driven pagination return:

{
  "count":  10,
  "total":  4287,
  "limit":  10,
  "offset": 0,
  "data":   [ /* records on this page */ ]
}

Endpoints currently on this envelope: GET /api/assets.

Other list endpoints (rates, prices, metrics, universes) are bounded reads and ship the legacy {count, data} shape — they will adopt the full envelope if/when they need consumer-driven pagination.

Compatibility: the envelope is additive. Callers that read only count and data are unaffected. See the Changelog for the cutover note.

Single-record reads

Single-record endpoints — e.g. GET /api/assets/:id, GET /api/rates/:pair — return { data: ... } and may include the lookup key as a sibling field (e.g. { pair, count, data } for symbol-scoped reads). They are not paginated.

Available Endpoints

Data Sources

All market data is sourced from institutional-grade data providers and updated daily. FX pairs are quoted as XXXUSD (e.g. GBPUSD = 1.27 means 1 GBP buys 1.27 USD).

Quick Example

Fetch the latest rate for GBP/USD:

curl https://api.bytetree.io/api/rates/GBPUSD

{
  "pair": "GBPUSD",
  "count": 365,
  "data": [
    {
      "date": "2025-02-17T00:00:00.000Z",
      "open": 1.2580,
      "high": 1.2620,
      "low": 1.2560,
      "close": 1.2601
    }
  ]
}