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

# Welcome to Posynt

**Posynt** watches X (Twitter) around the clock and delivers every new post published on the hashtags and accounts you choose — in **real time**, via **API**, **Discord** or **Telegram**.

This documentation walks you through:

* getting and using your **API key**,
* configuring the **hashtags and accounts** to track, and optionally their **engagement** (RT/like/comment counts + who),
* fetching the **posts** we detect,
* wiring up **Discord / Telegram** notifications.

{% hint style="info" %}
Don't have an account yet? Pick a plan on the [Posynt homepage](https://posynt.win/#pricing). Your API key is generated automatically after checkout.
{% endhint %}

## In short

| What you want to do              | Where to go                                          |
| -------------------------------- | ---------------------------------------------------- |
| Make your first API call         | [Quickstart](/getting-started/quickstart.md)         |
| Understand authentication        | [Authentication](/getting-started/authentication.md) |
| List / add hashtags              | [Tracked hashtags](/api-reference/tracks.md)         |
| List / add accounts              | [Tracked accounts](/api-reference/accounts.md)       |
| Fetch posts                      | [Fetching posts](/api-reference/posts.md)            |
| Set up Discord / Telegram alerts | [Notifications](/guides/notifications.md)            |
| Check plan limits & rate limits  | [Overview](/api-reference/overview.md)               |

## Base URL

```
https://api.posynt.win/v1
```

Every endpoint is prefixed with `/v1` and returns **JSON**.


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.posynt.win/readme.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.