> For the complete documentation index, see [llms.txt](https://docs.synoptic.com/s/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.synoptic.com/s/readme.md).

# Introduction

Realtime streams of posts from X, Telegram, newswires, government releases and other sources, over WebSocket, REST and MCP. Start here to pick an API.

Synoptic is a platform for exchanging intel with the lowest latency. While we are actively developing our platform, we offer a small set of APIs for you to get started.

## When to use Synoptic

Use Synoptic when a task needs new posts from a specific source as soon as they appear:

* **Watch social accounts:** posts from X (Twitter) accounts, Telegram channels and Truth Social.
* **Follow government releases:** White House releases and executive orders, SEC EDGAR filings, federal court dockets, Supreme Court opinions, economic indicators (CPI, PPI, nonfarm payrolls), Department of Defense contracts and USPTO trademarks.
* **Follow news and press releases:** newswires, company announcements and news sites.
* **React to posts in code:** feed live posts into a trading bot, an alert, a dashboard or an AI agent.
* **Answer "what just happened":** read the latest posts of a stream inside an AI assistant.
* **Publish your own feed:** post to a stream that other people follow.

Each feed is a **stream**. Find one in the [stream catalog](https://synoptic.com/p/marketplace/streams) or with the MCP `search` tool. Search finds streams, not post text; post search works inside one stream.

## How to call Synoptic

| You want                        | Use                                                                                                                                                  | Auth                                                |
| ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
| Try a public stream now         | Guest WebSocket `wss://ws-preview.api.synoptic.com/v1/on-stream-post?streamIds=<id>` or `GET https://api.synoptic.com/v1/streams/{streamId}/preview` | None. Posts are 10 seconds late; 30 latest at most. |
| Read streams in an AI assistant | MCP server `https://mcp.api.synoptic.com/mcp`                                                                                                        | Optional OAuth sign-in                              |
| Realtime posts in your code     | WebSocket `wss://ws.api.synoptic.com/v1/on-stream-post?apiKey=<reader key>`                                                                          | Reader key                                          |
| History and search              | REST `https://api.synoptic.com/v1/streams/{streamId}/posts`                                                                                          | Reader key in `x-api-key`                           |
| Publish posts                   | WebSocket `add-stream-post` or REST create post                                                                                                      | Publisher key                                       |

Signed-in users create reader and publisher keys in [Settings → API & Keys](https://synoptic.com/p/settings/api-keys).

## Get started

* [AI onboarding](https://docs.synoptic.com/s/ai-onboarding.md): connect an AI agent or assistant.
* [Guest access](https://docs.synoptic.com/s/guest-access.md): read public streams with no key.
* [Quick starts](https://docs.synoptic.com/s/quick-starts/watch-a-stream-in-claude-code.md): copy-paste prompts and scripts.
* [Stream types](https://docs.synoptic.com/s/streams/overview.md): what a post looks like for each kind of stream.
* [Subscribe to posts](https://docs.synoptic.com/s/websocket/subscribe-to-posts.md): realtime WebSocket with a reader key.
* [Limits](https://docs.synoptic.com/s/reference/limits.md) and [errors and retries](https://docs.synoptic.com/s/reference/errors-and-retries.md).

## Docs for agents

* Docs index: `https://docs.synoptic.com/s/llms.txt`
* All docs in one file: `https://docs.synoptic.com/s/llms-full.txt`
* Any page as Markdown: add `.md` to its URL, or send `Accept: text/markdown`.
* One stream: `https://synoptic.com/p/streams/{slugOrId}/SKILL.md`
