Skip to content

StreamData / API reference

API-001 design target

Proposed API reference.
Not callable.

This page tests resource names and trust disclosures without creating an endpoint contract.

No endpoint exists for any path below These paths are design targets for API-001. A deployed prototype must return a genuine 404 for each one. Resource names, fields, filters, pagination, cache behavior, limits, and versioning are not frozen.

GET/api/v1/campaigns

Bounded campaign summaries.

Illustrative · unavailable · no endpoint exists

GET/api/v1/campaigns/{campaignId}

One campaign, reward references, and a source/freshness projection.

Illustrative · unavailable · no endpoint exists

GET/api/v1/rewards/{rewardId}

One reward plus only known, display-permitted acquisition facts.

Illustrative · unavailable · no endpoint exists

GET/api/v1/games/{gameId}

One game with bounded campaign references.

Illustrative · unavailable · no endpoint exists

GET/api/v1/provenance/{factId}

A candidate safe provenance projection, never the raw internal envelope.

Illustrative · unavailable · no endpoint exists

Illustrative envelope

not a public schema

This JSON parses as a fixture-grounded design example. It is not returned by any URL.

Illustrative envelope — not a public schemaJSON

{
  "example": true,
  "data": {
    "type": "campaign",
    "id": "fixture-campaign-watch-chain",
    "name": "Example Quest Launch Rewards",
    "statusAtObservation": "active",
    "currentStatus": "not_asserted",
    "game": {
      "id": "fixture-game-example-quest",
      "name": "Example Quest"
    },
    "startsAt": "2026-08-10T00:00:00.000Z",
    "endsAt": "2026-08-20T00:00:00.000Z",
    "rewardIds": [
      "fixture-drop-watch-120",
      "fixture-drop-watch-30",
      "fixture-drop-watch-60"
    ]
  },
  "meta": {
    "sampleOnly": true,
    "fixture": "LEGACY-001 sanitized compatibility fixture",
    "syntheticIdentifiers": true,
    "observedAt": "2026-08-12T06:31:07.706Z",
    "current": false,
    "limitations": [
      "Illustrative envelope; not an API contract.",
      "No current platform state is asserted.",
      "Eligibility and archive-lineage v2 are still under review."
    ]
  }
}

Required before launch

exact behavior TBD by API-001

Future API behavior requirements
Concern	Launch requirement	Current state
Errors	Typed JSON errors and true route status	Contract TBD
Collections	Bounded pagination and filters	Contract TBD
Caching	ETag and conditional-request policy	Contract TBD
Abuse	Throttling, limits and incident handling	Contract TBD
Browsers	Explicit CORS decision	Contract TBD
Operations	Monitoring, correction path and runbook	Contract TBD