Quickstart

1. Get a FutPicks account with the right entitlement.

   Data API calls require a Pro subscription or admin account. Operations API calls require admin/operator access.

2. Create or collect a token.

   Browser sessions use FutPicks auth. Integrations should use bearer tokens obtained through the login flow. Admin users can inspect their identity via /api/v1/ops/me.

3. Call a low-risk endpoint.

Data API

curl "https://futpicks.com/api/v1/data/catalog" \
  -H "Authorization: Bearer $FUTPICKS_TOKEN" \
  -H "Accept: application/json"

Operations API

curl "https://futpicks.com/api/v1/ops/meta" \
  -H "Authorization: Bearer $FUTPICKS_ADMIN_TOKEN" \
  -H "Accept: application/json"

Typical integration flow

1. Read /api/v1/data/catalog to discover resources.
2. Query paginated resources with explicit filters and whitelisted sorting.
3. Each Data API response includes freshness metadata. Admins can also check /api/v1/ops/health/data-freshness.
4. For larger pulls, create an export job instead of paging aggressively.
5. Subscribe to webhooks for signal and export events when polling is not appropriate.

Local schema

The OpenAPI schema used by this site is stored at docs-site/schemas/api.json. Refresh it with:

cd docs-site
npm run refresh:openapi