API Reference
Overview & Auth

API Reference

⚠️

This reference reflects the /v1/* API design spec drafted for the project's Phase 3 build-out. Before publishing this publicly, confirm each endpoint below is actually deployed and matches this shape — some may still be pending or may have changed during implementation. Treat this page as a draft until verified against the live API.

Base URL

https://shelbyanalytics.site/v1

Authentication

TierAuthRate limit
FreeNone required100 requests/hour, limited by IP
ProAPI key5,000 requests/hour

For authenticated (Pro) requests, pass the key as a bearer token:

GET /v1/network/stats
Authorization: Bearer sa_live_xxxxxxxxxxxx

Response format

All endpoints return JSON. Error responses use a generic shape and do not leak internal details:

{ "error": "message" }

Sections

  • Network — network-wide stats, timeseries, and health
  • Providers — storage provider listings, detail, and leaderboard
  • Epoch — current epoch state and countdowns
  • Explorer — transactions and blobs
  • Calculator — storage cost and SP reward estimates
  • Export — bulk CSV/JSON data export