---
title: "TweetStream developer docs"
canonical_url: "https://tweetstream.io/docs"
last_updated: 2026-09-24
---

# TweetStream developer docs

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

Canonical URL: https://tweetstream.io/docs

## Start streaming

- [Complete WebSocket example](https://tweetstream.io/docs/examples#run): Download one file, run it with your API key, and watch events arrive.
- [Production consumer](https://tweetstream.io/docs/production-consumer): Add routing, reconnects, and checkpoints.
- [Event reference](https://tweetstream.io/docs/payloads-detections-ocr): Find the payload for each event operation.
- [REST reference](https://tweetstream.io/docs/history-api): Replay 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 details](https://tweetstream.io/docs/connection-auth-heartbeat#base-urls): Every endpoint, authentication method, and heartbeat rule.

## Use machine-readable contracts

- [OpenAPI 3.1](https://tweetstream.io/docs/openapi.json): Generate REST clients from the public endpoint contract.
- [AsyncAPI 3.0](https://tweetstream.io/docs/asyncapi.json): Inspect every WebSocket channel, operation, and payload schema.
- [LLM context](https://tweetstream.io/docs/llms-full.txt): Load the complete public docs as Markdown.