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

# The API

Flox exposes a REST API. `GET /assess/:symbol` is the whole product in one call — a trading system can hit it before executing and skip anything that comes back `REFUSE`.

## Endpoints

| Route                     | Returns                                              |
| ------------------------- | ---------------------------------------------------- |
| `GET /health`             | mode, chain, log head, counts                        |
| `GET /ruleset`            | the exact thresholds in force                        |
| `GET /assets`             | the watchlist                                        |
| `GET /assess/:symbol`     | a fresh assessment, committed to the log *(metered)* |
| `GET /depth/:symbol`      | per-venue depth breakdown                            |
| `GET /log`                | the public record                                    |
| `GET /log/verify`         | chain integrity                                      |
| `GET /stats`              | verdict distribution and refusal rate                |
| `GET /forecasts/accuracy` | hit rate, Brier score, calibration                   |
| `GET /credits/:address`   | on-chain credit balance                              |

## Metering

`GET /assess/:symbol` is metered. Without valid credentials it returns `402` with instructions. To authenticate, sign the auth message with your wallet and pass `address`, `nonce`, and `signature` as query parameters. The server recovers your address and checks your on-chain balance.

Everything else is free and unauthenticated — reading the log, verifying the chain, and checking stats never cost anything.

## As a pre-trade gate

The intended integration is simple: before your system executes a trade on a tokenized asset, call `GET /assess/:symbol`. If the verdict is `REFUSE`, skip the trade. If it's a size band, scale your position by the multiplier. Flox does not execute trades or take custody — it answers one question and leaves the action to you.


---

# 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.tryflox.xyz/using-flox/api.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.