---
title: "Get me"
method: GET
path: "/me"
tags: ["Identity"]
---

# Get me

`GET /me`

## Request

- Base URL: `https://arena-predictions.com/api/v1`
- URL: `https://arena-predictions.com/api/v1/me`
- Auth: HTTP bearer

Whose account the presented key acts for, which scopes it carries, and that it is paper only. limits is the plan's minute and month, the same numbers as the RateLimit and Arena-Quota headers. Needs a valid key and no particular scope, so an agent can discover its own permissions before trying anything that could fail.

## Response `200`

The key's identity and scopes.

- Me
  - `user` object, required
    - `id` string, uuid, required
    - `displayName` string, nullable, required
    - `private` boolean, nullable, required: Accounts are private by default: others see none of this account's trades or numbers until its owner makes the profile public in Settings on the website. Null when it could not be read.
  - `key` object, required
    - `prefix` string, required
    - `scopes` string[], required
  - `mode` 'paper', required
  - `paperOnly` true, required: This key is paper trading only. Paper trades fill in Arena's sandbox and are not sent to a venue.
  - `limits` object, nullable, required: The plan's minute and month. The same numbers as the RateLimit and Arena-Quota headers. Null when the server could not read them.
    - `minute` object, required
      - `limit` integer, required
      - `remaining` integer, required
    - `month` object, required
      - `limit` integer, required
      - `used` integer, required
    - `enforced` boolean, required: When false, a request over the limit is still answered and only the count is kept.

## Other responses

- `401`: Missing, malformed, unknown, revoked or expired key. Carries a WWW-Authenticate: Bearer challenge.
- `429`: rate_limited (over the plan's minute limit) or quota_exceeded (over the month). Only while the limits are enforced; until then requests are counted and the headers set, and nothing is refused. error.retryAfterSeconds equals Retry-After.
- `503`: The key could not be verified right now. Retry after the Retry-After seconds; the key may be perfectly good.

---

[API](https://skmtc.dev/arena-predictions/apis/arena-api.md) · [All operations](https://skmtc.dev/arena-predictions/apis/arena-api/llms.txt) · [OpenAPI document](https://skmtc.dev/arena-predictions/apis/arena-api/revisions/9d89d166dae6?raw)