Skip to Content
API ReferenceOverview

API Reference

The v1 API exposes anonymous catalog routes, self-serve free-tier signup, and API-key or x402-paid observation, insight, and signal routes.

Contract

Use the OpenAPI document for generated clients, schema validation, and endpoint discovery:

Authentication

Catalog endpoints are anonymous. POST /v1/signup issues a free-tier API key. Observation, insight, and signal endpoints accept either an API key or an x402 payment.

curl "https://api.creativeforesight.io/v1/observations?indicator=UNRATE" \ -H "Authorization: Bearer $CF_API_KEY"

API keys can be sent as Authorization: Bearer cf_live_... or X-API-Key: cf_live_....

Endpoints

EndpointAuthDescription
POST /v1/signupAnonymousCreate a free-tier API key.
GET /v1/sourcesAnonymousList data sources.
GET /v1/indicatorsAnonymousSearch and page through indicators.
GET /v1/indicators/{code}AnonymousFetch indicator detail by code.
GET /v1/regionsAnonymousList regions and filter by type or parent.
GET /v1/observationsAPI key or x402List observations for an indicator.
GET /v1/observations/latestAPI key or x402Fetch the latest observation for an indicator.
GET /v1/insightsAPI key or x402Compute deterministic facts and active signals for an indicator.
GET /v1/signalsAPI key or x402List signal interval history.
GET /v1/signals/activeAPI key or x402List currently open signal intervals.
GET /v1/pingAPI keyValidate bearer API key connectivity.

Response conventions

Successful list and detail responses use { "data": ..., "meta": ... } when pagination or query metadata is available. Errors use { "error": { "code": "...", "message": "...", "details": ... } }.

Last updated on