Skip to main content
Read contract logs or block headers over SSE or JSON polling. Read endpoints use an account RPC key; saved-stream management uses an account management Bearer token. Start with the quickstart for a working request.
The full machine-readable contract is in OpenAPI.

Read endpoints

Block headers accept no address or topic filters. latest includes the current published tip block. cursor= is invalid; send next as from.

Page response

Polling returns one page with status 200, never 204. SSE returns a sequence of frames with id: <next> and data: <JSON page>, no event field. Empty pages are also sent. Quiet SSE waits after the first page have a one-second minimum. An unreached position returns items: [], through: null and unchanged next. Item quantities are JSON-RPC hex; page numbers are decimal. See consuming pages for the required atomic apply rule, all error codes and reconnect behavior. A temporary handoff may return 307 with no Location; retry the same request.

Saved-stream management

Send Authorization: Bearer <account-management-token> and JSON bodies with Content-Type: application/json. RPC keys cannot manage streams. Profile-scoped agents cannot manage streams; read-only agents can read but cannot mutate. All management routes require beta access (403 not_in_beta otherwise). A recipe has id, name (1 to 100 characters), integer chain_id, source (logs or blocks), parameters, credential-free url_template, inserted_at and updated_at. Substitute your key into the template locally. Recipe parameters accepts address and topic0 through topic3 as strings or arrays of strings; from as a block number or latest; wait as 0 to 30; and label. A recipe never stores a consumer cursor. Create a new recipe to change its source. Duplicate names are allowed. Usage endpoints accept inclusive from_day and through_day UTC dates, defaulting to seven days with a maximum range of 31 days. Totals are flushed in the background. Identical normalized filters share source attribution. Account-day minimums belong to the account: never sum the repeated days charges across saved recipes.

Limits

At most 100 saved recipes per account; exceeding the cap returns 409 stream_limit. Read limits are 10 concurrent readers and two history builds per key. Page boundaries are at most 10,000 whole blocks, targeting 1 MiB of items with a 4 MiB ceiling; a larger single block is served alone or returns 503.

Next