# Account and index API

2 endpoints under `https://apexvol.com/api/mcp/data`. Every call needs `Authorization: Bearer avmcp_<token>`; tokens are issued to paid and trial accounts under Account, then API Access. Web version: https://apexvol.com/developers/account-api

| Endpoint | Plan | What it answers |
|---|---|---|
| `GET /` | Basic | Which endpoints does the ApexVol API expose, and what does each one need? |
| `GET /me/usage` | Basic | How much of my monthly API allowance is left, and which endpoints have I been calling? |

## GET /

Returns the whole token surface as one JSON list. For each endpoint you get the HTTP method, the full path with its placeholders, the family it belongs to, the plan it needs, a one-line description, the query parameters with their defaults, the developer page that documents it and a request line that works as written. The family list, the endpoint count and links to the OpenAPI spec and the Markdown reference come with it. The list is read from the same records that build the developer pages, so it can never lag them. A client that holds a token can discover the API from this one call instead of a bookmarked docs page, and an unknown path answers with did_you_mean entries in this same shape.

- **Units:** No market data is involved. The response is the catalogue itself, and the call costs nothing against the monthly allowance.
- **Basis:** Generated from the endpoint records at request time. The version and updated fields say which weekly capture the example requests come from.
- **Markdown:** https://apexvol.com/developers/account-api/index.md

No parameters.

```bash
curl -H "Authorization: Bearer avmcp_YOUR_TOKEN" \
     "https://apexvol.com/api/mcp/data/"
```

- `endpoint_count`: How many endpoints the list holds.
- `endpoints[].method, path`: The HTTP method and the full path. {ticker} marks a path parameter.
- `endpoints[].tier`: The lowest plan whose tokens can call it: basic, premium or pro.
- `endpoints[].params`: The query parameters with their defaults, on one line.
- `endpoints[].docs`: The developer page for the endpoint.
- `endpoints[].example`: A request line that works as written, the one the docs sample was captured from.
- `families[]`: The endpoint families with their page and endpoint count.
- `openapi, markdown`: The OpenAPI 3.1 spec and the single-file Markdown reference.

## GET /me/usage

Returns the calling account's usage for the current month in the same unit the allowance is enforced in: data requests used, the plan's allowance, what remains and when the counter resets. It adds the live rate-limit position for this token, the number of calls per endpoint this month with each endpoint's docs page, the count of active tokens on the account, and the unknown paths this token has hit in the last seven days, which is the quickest way to spot a client built against a path that does not exist. The same numbers appear on the account page. The call costs nothing against the allowance.

- **Units:** used, limit and remaining count upstream data requests, not API calls; one call can spend more than one and a cached call spends none. Times are ISO 8601 in UTC.
- **Basis:** The account's counter is the one the 429 budget gate reads; per-endpoint counts come from the per-month usage hash the account page also shows. Integration tokens issued by an admin have no allowance and report limit null.
- **Markdown:** https://apexvol.com/developers/account-api/me-usage.md

No parameters.

```bash
curl -H "Authorization: Bearer avmcp_YOUR_TOKEN" \
     "https://apexvol.com/api/mcp/data/me/usage"
```

- `used, limit, remaining, percent_used`: The month's meter. limit is null for an admin-issued integration token.
- `resets_at`: When the counter returns to zero: the first of next month, UTC.
- `rate_limits`: per_minute, per_hour and what remains of each for this token right now.
- `calls_this_month, endpoints[]`: Calls per endpoint rule, most-called first, each with its docs page.
- `tokens_active`: Active tokens on the account, this one included.
- `this_token.unknown_paths_7d`: Paths under /api/mcp/data that 404d for this token in the last seven days, with counts.

Conventions: https://apexvol.com/developers/conventions. Errors: https://apexvol.com/developers/errors. Whole API in one file: https://apexvol.com/docs/api/apexvol-api.md