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

# Introduction

The Floral Social API lets your platform link Floral accounts, read public Floral data, and check whether a user completed a social action.

* **Floral Connect** is the account-linking flow, built on OAuth 2.0 with PKCE. Users sign in on Floral and approve exactly what your platform can see.
* **Verification** answers whether a linked user liked, commented on, reposted or quoted a post, followed an account, joined a community, or published a post matching your campaign rules.
* **Public data** returns public profiles, posts, communities and their engagement counts.

Your platform keeps control of its own quest rules, rewards and campaigns. Floral reports what happened.

## Start here

1. [Create your application](/getting-started/create-application.md) at [floral.fun/developers](https://floral.fun/developers). You sign in with a Floral account, or create one there, and no approval is needed.
2. Follow the [Quickstart](/getting-started/quickstart.md) to link an account and verify an action.
3. Add a [Connect with Floral button](/integration-guides/connect-with-floral.md) to your product.

The Developer Portal manages your applications and credentials. These docs explain how to integrate.

## What's in each version

| Version            | Adds                                                                                                                  |
| ------------------ | --------------------------------------------------------------------------------------------------------------------- |
| **v1.0**           | Floral Connect, public users, posts and communities, and verification of likes, comments, follows and community joins |
| **v1.1**           | The self-service Developer Portal, public clients, and verification of reposts, quotes and new posts                  |
| **v2.0** (current) | The public social graph, replies, quotes, reposts, search, analytics, bulk ingestion and signed webhooks              |

See the [Changelog](/developer-resources/changelog.md) for details.

## What the API doesn't expose

The API never returns wallet addresses, balances, positions, email addresses or direct messages, and it has no write access. A partner can't post or act for a user.

Search, historical time-series analytics, signed webhooks and bulk reading are documented in [V2](/api-v2/v2-overview.md).


---

# 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://docs.floral.fun/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.