Skip to content

docs: add GET /v1/network/volume endpoint #6

@SPIKESPIGEL404

Description

@SPIKESPIGEL404

Endpoint

GET /v1/network/volume

Returns USDC volume data over time, grouped by model, provider, or user.

Auth: Required (Authorization: Bearer <JWT>)

Query Parameters

Param Type Default Values
from YYYY-MM-DD 30 days ago Start date (inclusive)
to YYYY-MM-DD today End date (inclusive)
interval string auto day, week, month
group_by string model model, provider, user

Auto-interval: span ≤60d → day, ≤180d → week, >180d → month

Response

{
  "summary": {
    "total_volume_usdc": 15230.50
  },
  "timeseries": [
    {
      "timestamp": "2026-03-08T00:00:00Z",
      "total_volume": 1523.05,
      "groups": [
        { "id": "gpt-4o", "volume": 450.20 },
        { "id": "claude-sonnet-4", "volume": 380.10 }
      ]
    }
  ]
}

groups[].id contains model IDs, provider IDs, or wallet addresses depending on group_by.

Example

curl -H "Authorization: Bearer $TOKEN" \
  "https://node.bitrouter.ai/v1/network/volume?from=2026-01-01&to=2026-03-15&interval=week&group_by=model"

Error Responses

  • 401 — missing or invalid auth
  • 400 — invalid params (from >= to, bad interval or group_by)

Reference

PR: https://github.com/bitrouter/node/pull/126

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions