Forkast Data API
🔴 This API surface is actively being wired up. Names, filters, and even full routes may evolve before the public release.
Base URL and format
- Hostname:
https://data-api.forka.st - Protocol: HTTPS only; responses are JSON.
- Authentication: Not required for read operations. Rate limiting will be enforced once the API goes into production.
- Specification: All requests and sample payloads live inside
api-reference/openapi-data-api.json, which powers the panel on the right-hand side of each page.
Endpoint families
| Topic | Description | Sample endpoints |
|---|---|---|
| Health | Readiness probes for monitors. | GET / |
| Portfolio | Position snapshots, historical exits, and wallet totals. | GET /positions, GET /closed-positions, GET /value, GET /traded |
| Market metrics | Aggregate stats derived from Forkast liquidity. | GET /holders, GET /oi, GET /live-volume |
| Activity | Historical fills and ledger-like user activity. | GET /trades, GET /activity |
| Builders | Early endpoints that will summarize third-party builder performance. | GET /v1/builders/leaderboard, GET /v1/builders/volume |
Usage tips
- Prefer
marketfilters when you have known condition IDs. The API accepts CSV lists (market=0xabc,0xdef) using standardformencoding (explode=false). - Pagination is handled with
limitandoffsetpairs. Lower values keep response times predictable while the cache is still maturing. - Builder routes are placeholders until the attribution ETL ships; expect empty arrays for now.