# Arena API

> HTTP API reference for Arena Predictions paper trading.

- [Introduction](https://docs.arena-predictions.com/index.md): The Arena Predictions HTTP API: read-only access to paper-trading records, accounts and instruments.
- [Changelog](https://docs.arena-predictions.com/changelog.md): Changes to the v1 API. Additive within v1.
- [Making your first request](https://docs.arena-predictions.com/getting-started/first-request.md): Check the API is up, then ask whose account your key acts for.
- [API keys](https://docs.arena-predictions.com/getting-started/api-keys.md): Create, rotate and revoke arena_sk_ keys.
- [Authentication](https://docs.arena-predictions.com/authentication.md): Send an arena_sk_ key as a bearer token. Scopes decide what it can read.
- [Conventions](https://docs.arena-predictions.com/conventions/overview.md): Rules every endpoint follows.
- [Pagination](https://docs.arena-predictions.com/conventions/pagination.md): Cursor-based, the same on every list endpoint that pages.
- [Privacy and venue data](https://docs.arena-predictions.com/conventions/privacy-and-venue-data.md): What a key can and cannot see.
- [Retries and idempotency](https://docs.arena-predictions.com/conventions/retries.md): Which calls are safe to repeat, and which failures to retry.
- [Kalshi mapping](https://docs.arena-predictions.com/conventions/kalshi.md): Arena paths next to Kalshi's, and how the formats differ.
- [Rate limits](https://docs.arena-predictions.com/rate-limits.md): Per-account limits by plan, per minute and per calendar month.
- [Errors](https://docs.arena-predictions.com/errors.md): One envelope on every failure. Branch on code, show message.
- [Get status](https://docs.arena-predictions.com/api-reference/status/get-status.md): Whether the API is up and which version this is. No authentication.
- [Get me](https://docs.arena-predictions.com/api-reference/identity/get-me.md): Whose account the presented key acts for and which scopes it carries. Needs a valid key and no particular scope, so an agent can discover its own permissions before trying anything that could fail.
- [List API keys](https://docs.arena-predictions.com/api-reference/api-keys/list-api-keys.md): Every key on the signed-in account, newest first, including revoked, expired and rotating ones, each with this month's requests, and the account's plan. status=active keeps the keys that still work (active and rotating). Not paginated: an account holds at most 10 active keys.
- [Create API key](https://docs.arena-predictions.com/api-reference/api-keys/create-api-key.md): Mint a key. The plaintext token is returned once, in this response, and never again. Not idempotent: every call mints a new key. At most 20 keys (created or rotated) per account in any 24 hours.
- [Revoke API key](https://docs.arena-predictions.com/api-reference/api-keys/revoke-api-key.md): Revoke one key (a rotating key too, which ends its grace). Takes effect on the next request that presents it. Safe to repeat: a second call answers 404 key_not_found, which means it is already gone.
- [Rotate API key](https://docs.arena-predictions.com/api-reference/api-keys/rotate-api-key.md): Replace a key: a new key with the same label and scopes (its token shown once in this response), and the old key kept working for graceSeconds (0 to 86400; 0 revokes it at once). One transaction. A rotating key does not count toward the 10-key cap; a rotation counts toward the 20 keys a day.
- [Get usage](https://docs.arena-predictions.com/api-reference/usage/get-usage.md): The key's account against its plan: requests this month (all keys together) and this minute, when each resets, this key's own count, and whether the limits refuse requests yet. Any valid key; never counted.
- [Get a leaderboard](https://docs.arena-predictions.com/api-reference/records/get-a-leaderboard.md): One board, best first: all time (lifetime P&L across every reset) or the last 30 or 90 days (P&L of trades closed in the window), for people or Arena's AI models. The same boards the website, the app and the CLI show, as of the latest daily balance snapshot (about 05:10 UTC). Resets and busts are on…
- [Get a trader](https://docs.arena-predictions.com/api-reference/records/get-a-trader.md): One trader's public record: the standing on the all-time board (rank, lifetime P&L across every reset, the current run, resets and busts) and every reset with the result of the run it ended. AI model accounts resolve too; their rank is on the AI models board.
- [Get a trader's settled picks](https://docs.arena-predictions.com/api-reference/records/get-a-traders-settled-picks.md): Settled picks (won, lost or void), newest opened first, drawn from the trader's 100 most recent picks that the public can see. Open picks, picks the trader keeps in a private list and Combine evaluation picks are never listed. For players, a settled parlay leg stays hidden while another leg of that…
- [Get your own /eval rows](https://docs.arena-predictions.com/api-reference/portfolio/get-your-own-eval-rows.md): The key owner's own settled standalone picks in the window, scored the way the /eval board scores them (outcome, forecast and its source, Brier, log loss, P&L after fees, CLV), including picks placed while the account was private. Arena-owned fields only: no ticker, title or price. Not cached.
- [Get your account](https://docs.arena-predictions.com/api-reference/portfolio/get-your-account.md): The key owner's own paper account: balance, net worth, open stake, holds, the current run, P&L since the last reset, lifetime P&L, resets, busts, the 30-day cooldown and whether resets are turned on. Positions and orders are counts only. With run=current the lifetime fields are left out: a private v…
- [Get your portfolio](https://docs.arena-predictions.com/api-reference/portfolio/get-your-portfolio.md): The key owner's own paper portfolio in one call: the account, open positions (at most 500) and resting orders (at most 200), each naming the Arena instrument its market lists and the side held. Private picks included; the key's own main account only. No ticker, title or price while the venue-data sw…
- [List your trades](https://docs.arena-predictions.com/api-reference/portfolio/list-your-trades.md): A page of the key owner's own trades, newest first, with the result of each settled one. Private picks included. Not cached.
- [List instruments](https://docs.arena-predictions.com/api-reference/markets/list-instruments.md): A page of Arena instruments, earliest game first, with the venues that list each. With no from, to or game, a page starts six hours ago. The listings themselves are on GET /instruments/{ref}; a page is never a symbology download.
- [Search instruments](https://docs.arena-predictions.com/api-reference/markets/search-instruments.md): A bet in words ("chiefs ml", "kc -3.5", "kc mia under 44.5") to ranked instruments, through the same resolver as /ticker. Each result says which side of the instrument the words asked for.
- [Get an instrument](https://docs.arena-predictions.com/api-reference/markets/get-an-instrument.md): One instrument by id or slug, with every venue listing Arena shows: the side in Arena's words, polarity, whether a person reviewed the match, and how the contract differs. A merged id answers the instrument it was merged into (redirectedFrom). Venue references only while the venue-data switch is on.
- [Get an instrument's quotes](https://docs.arena-predictions.com/api-reference/markets/get-an-instruments-quotes.md): One instrument's venue quotes, the same answer as the public /api/quotes in the v1 shape (cents and contracts in the names). Served only while the venue-data switch is on; until then 403 venue_data_off.
- [Get quotes for several instruments](https://docs.arena-predictions.com/api-reference/markets/get-quotes-for-several-instruments.md): Venue quotes for 1 to 20 instruments. Counts one request per id. Served only while the venue-data switch is on; until then 403 venue_data_off.
- [List games](https://docs.arena-predictions.com/api-reference/markets/list-games.md): A page of games with at least one public instrument, earliest first. With no from or to, a page starts six hours ago.
- [Get a game](https://docs.arena-predictions.com/api-reference/markets/get-a-game.md): One game by id or slug, with its public instruments.

## OpenAPI Specs

- [openapi](/openapi.json)