Quick start

1. Read a public sampleCopy Anchor Link

This request needs no key. The fixture is an NBA sample game and pulse is its feed key.

curl --fail-with-body --silent --show-error 'https://api.live.storyos.ai/v1/fixtures/0042500401/feeds/pulse'

A 200 response contains fixtureId, feedKey, snapshotAt and items. This sample contains 13 Player Performance items at definition version 2. Each item includes its own id, revision, copy and supporting values.

2. Read a live gameCopy Anchor Link

Use the same route with a live game's NBA game ID. No key is needed. A live game returns 404 until its first item is published.

# A live game's feed: set FIXTURE_ID to its NBA game ID. No key.
: "${FIXTURE_ID:?Set a live NBA game ID}"
curl --fail-with-body --silent --show-error \
  "https://api.live.storyos.ai/v1/fixtures/$FIXTURE_ID/feeds/pulse"

3. Consume complete snapshotsCopy Anchor Link

Replace your displayed items after each successful 200, including a response with an empty items array. Preserve the last valid snapshot on 304 or a failed request. See Feed model and Polling and caching.

The examples have been exercised against the public API.