> ## Documentation Index
> Fetch the complete documentation index at: https://docs.alphaengine.trade/llms.txt
> Use this file to discover all available pages before exploring further.

# API Overview

> Current public Strategy Arena API surface.

The public API is owned by `api-router`. It is endpoint-driven, family-first,
and versioned under `/v1`.

<CardGroup cols={3}>
  <Card title="Endpoint-driven" icon="file-check">
    Public behavior is exposed through explicit HTTP routes, not internal module
    imports.
  </Card>

  <Card title="Family-first" icon="table">
    The implemented public family is `strategy-arena`.
  </Card>

  <Card title="Thin client safe" icon="shield">
    Clients parse envelopes and call routes; they do not reimplement scoring or
    simulation internals.
  </Card>
</CardGroup>

## Implemented public surface

<AccordionGroup>
  <Accordion title="Public utility routes">
    | Method | Path               | Purpose                 |
    | ------ | ------------------ | ----------------------- |
    | `GET`  | `/healthz`         | public health check     |
    | `GET`  | `/openapi/v1.json` | public OpenAPI document |
  </Accordion>

  <Accordion title="Discovery routes">
    | Method | Path                                                             | Purpose                             |
    | ------ | ---------------------------------------------------------------- | ----------------------------------- |
    | `GET`  | `/v1/families`                                                   | list supported and planned families |
    | `GET`  | `/v1/families/strategy-arena`                                    | Strategy Arena metadata             |
    | `GET`  | `/v1/families/strategy-arena/strategies`                         | list strategies                     |
    | `GET`  | `/v1/families/strategy-arena/strategies/{strategyId}`            | read one strategy                   |
    | `GET`  | `/v1/families/strategy-arena/strategies/{strategyId}/parameters` | read parameter schema               |
    | `GET`  | `/v1/families/strategy-arena/markets`                            | list markets                        |
  </Accordion>

  <Accordion title="Computation routes">
    | Method | Path                                              | Purpose                           |
    | ------ | ------------------------------------------------- | --------------------------------- |
    | `POST` | `/v1/families/strategy-arena/simulations`         | run full simulation               |
    | `POST` | `/v1/families/strategy-arena/simulations/summary` | run compact simulation view       |
    | `POST` | `/v1/families/strategy-arena/simulations/trades`  | run trade-focused simulation view |
    | `POST` | `/v1/families/strategy-arena/evaluations`         | evaluate one simulation result    |
  </Accordion>
</AccordionGroup>

## Not implemented in public v1

The current public API does not expose:

* server-owned leaderboard endpoints,
* public wallet or encryption flows,
* public AMM endpoints,
* public swap endpoints,
* operator runtime endpoints.

## Response envelope

Successful `/v1/**` responses use:

```json theme={null}
{
  "requestId": "req_123",
  "status": "ok",
  "data": {}
}
```

Errors use `application/problem+json` with AlphaEngine extensions. See
[Errors](/api/errors).

## Thin client ownership

A thin client should:

* set `x-api-key`,
* parse success envelopes,
* parse problem details,
* expose ergonomic methods such as `listMarkets`, `runSimulation`, and `runEvaluation`,
* assemble beta leaderboard rows locally from evaluation results.

It should not reimplement strategy math, simulation logic, evaluation logic,
contest ranking, or operator runtime behavior.

## Related pages

<CardGroup cols={2}>
  <Card title="Authentication" icon="lock" href="/api/authentication">
    API key behavior, error cases, and beta limit semantics.
  </Card>

  <Card title="Simulations" icon="chart-line" href="/api/simulations">
    Full, summary, and trade-focused simulation endpoints.
  </Card>

  <Card title="Evaluations" icon="file-check" href="/api/evaluations">
    How one simulation result becomes score and diagnostics.
  </Card>

  <Card title="How the arena works" icon="table" href="/arena/how-it-works">
    Product flow behind the public API surface.
  </Card>
</CardGroup>