> For the complete documentation index, see [llms.txt](https://runtimedesigns.gitbook.io/token-buzz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://runtimedesigns.gitbook.io/token-buzz/readme.md).

# TokenBuzz Documentation

Welcome to the official documentation for **TokenBuzz** — a crypto social-signal analytics platform that turns the noise of social media into clear, actionable intelligence for token traders and researchers.

## Where to start

* **New here?** Read [What is TokenBuzz?](/token-buzz/getting-started/what-is-tokenbuzz.md) for the big picture, then follow the [Quickstart](/token-buzz/getting-started/quickstart.md) to connect a data source and run your first query.
* **Connecting data sources?** See the [BYOK overview](/token-buzz/connecting-data-byok/overview.md) and the per-provider guides.
* **Evaluating security?** Start with the [Security & Compliance overview](/token-buzz/security-and-compliance/overview.md).
* **Building an integration?** See the [Developer / API overview](/token-buzz/developers-api/overview.md).

## Documentation map

| Section                    | What's inside                                                                                                                         |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| **Getting Started**        | Product overview, quickstart, account & billing.                                                                                      |
| **Product Guide**          | Every feature: Movers, Live Feed, Alerts, Watchlists & Dashboards, Analytics, Hum AI, Charts, Query History, and the command palette. |
| **Connecting Data (BYOK)** | How to bring your own keys for X (Twitter), Reddit, Telegram, Apify, and how Farcaster works out of the box.                          |
| **Security & Compliance**  | Security posture, CIS AWS Foundations Benchmark v6.0.0 alignment, data handling & encryption, and the shared-responsibility model.    |
| **Developers / API**       | The Query API, Analytics API, and authentication.                                                                                     |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://runtimedesigns.gitbook.io/token-buzz/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.