API (Pro)
API overview
A read-only HTTP API for Pro subscribers. Use it to index pools, power dashboards, or build integrations without running your own RPC.
What the API is for
The on-chain contract is already a public API — anyone with an RPC endpoint can read pool state. The HTTP API exists to save you from running that infrastructure: indexed queries, aggregated stats, pagination over funders and events, and a single webhook feed per key.
What it is not
- Not a transaction relayer.Funding and withdrawing still happen on-chain, signed by the user's wallet. The API never takes custody and never signs. To deploy, fund, or withdraw, use the app — the quickstart walks through each flow (including how to get Sepolia test ETH).
- Not a free tier. Keys require a Pro subscription. See pricing.
Base URL
All requests are served from a single base URL (TBD — will be api.communitypool.xyz or similar). Versioning is path-based: /v1/.
Quick reference
- Authentication — API keys via
Authorization: Bearer. - Rate limits — per-key quotas and how to read the response headers.
- Endpoints — the full resource list.
Creating a key
Pro subscribers create keys from /api-keys inside the dashboard. The page lists existing keys and exposes two actions: View API docs (sends you back here) and Create API key. A newly created key is shown exactly once — store it somewhere safe before dismissing the dialog.