Skip to docs content
Browse and search
On this page

TweetStream developer docs

Connect first, then use focused references for the WebSocket protocol, events, REST APIs, and complete consumers.

Run the complete example
Open in chat
ChatGPTClaudeCursorView as Markdown
Reviewed against product code on September 24, 2026

Start streaming

Complete WebSocket exampleDownload one file, run it with your API key, and watch events arrive.Production consumerAdd routing, reconnects, and checkpoints.Event referenceFind the payload for each event operation.REST referenceReplay stored events and manage account settings.

Choose a base URL

Connect to wss://ws-iad.tweetstream.io/ws in the USA or wss://ws-global.tweetstream.io/ws elsewhere. REST requests use https://api.tweetstream.io.

Connection detailsEvery endpoint, authentication method, and heartbeat rule.

Use machine-readable contracts

OpenAPI 3.1Generate REST clients from the public endpoint contract.AsyncAPI 3.0Inspect every WebSocket channel, operation, and payload schema.LLM contextLoad the complete public docs as Markdown.