Meta · Endpoint

Me

Identity, callable endpoints, limits and live quota usage for the calling key.

GET/v1/me

The endpoint allow-list is the only gate: a key whose allow.endpoints is a list must name meta.me, or the call is 403 endpoint_not_allowed. Every self-service key names it.

Example request

curl

curl -H "Authorization: Bearer sxk_live_4f9c…" \
  "https://api.simicx.com/v1/me"

Try it

Execute GET /v1/me against the live API using your key. Paste a key below to send without signing in, or sign in to auto-fill from your profile — either way, the call counts towards your rate limits. Whether the route answers depends on your key's endpoint allow-list — /v1/me lists what is in force; a new key starts with only the self-service routes until an administrator grants more.

API key

Remember on this device

Base URL

Sent server-side via a same-origin proxy; only the documented host(s) are allowed.

Request

GEThttps://api.simicx.com/v1/me

Example response

JSON · synthetic values, real schema

{
  "data": {
    "key_id": "9f2c4ab8d1e3f0a2",
    "key_name": "notebook",
    "user_id": "usr_8d21c0",
    "email": "quant@acme-capital.com",
    "role": "user",
    "is_admin": false,
    "allow": {
      "endpoints": { "mode": "list", "ids": ["meta.health", "meta.keys", "meta.me"] },
      "alphas":    { "mode": "all", "ids": [] },
      "runs":      { "mode": "all", "ids": [] }
    },
    "field_policy": { "expose_raw_book": false },
    "rate_limit": { "per_second": 5, "per_minute": 60, "per_day": 5000, "monthly_requests": 100000 },
    "usage": {
      "second": 0, "minute": 1, "day": 12, "month": 48,
      "remaining_second": 5, "remaining_minute": 59,
      "remaining_day": 4988, "remaining_month": 99952
    },
    "callable_endpoints": ["meta.health", "meta.keys", "meta.me"],
    "registry_version": "2.2.0",
    "ip": "203.0.113.10"
  },
  "meta": {
    "request_id": "req_7f3a2c",
    "generated_at": "2026-07-28T14:03:12Z",
    "source": "platform_accounts"
  }
}

Response fields

Every field the response can carry, what it means, and how it is computed.

Field

Type

Meaning

How it is computed

key_id

string

Public identifier of the calling key.

A token reads sxk_<env>_<key_id>.<secret>: key_id is the 16 characters between the second underscore and the dot. It identifies which key made the call without exposing secret material.

key_name

string

Human label given at issuance.

Use it to tell production from notebook keys.

user_idemail

string

The user the key belongs to.

One user may hold several keys — see /v1/me/keys.

roleis_admin

string / boolean

The user's platform role, and whether it confers admin powers.

Read from the live user record at call time; an admin's key additionally reaches the administrative endpoints.

allow.endpointsalphasruns

allow-list

What this key may call, and which alphas it may address.

endpoints is deny-by-default: a new key carries {"mode":"list","ids":["meta.health","meta.keys","meta.me"]} until an administrator grants more. {"mode":"all"} on endpoints is a deliberate wide grant (an open account ceiling, or an operator key) — not the self-service default — and still cannot invent routes outside the registry. alphas and runs default to {"mode":"prefix","prefixes":["Test_"]} (testing alphas only); {"mode":"all"} or a named list is an administrator grant.

field_policy.expose_raw_book

boolean

Whether raw_* fields and raw_ books are served to this key.

Per-key flag for unconditioned signal access.

rate_limit.per_secondper_minuteper_daymonthly_requests

integer | null

The rate envelopes on the key.

Whatever the key carries, falling back to the self-service defaults — 5 per second, 60 per minute, 5000 per day and 100000 per month. The example above uses those defaults.

usage.secondminutedaymonth

integer

Live consumption against each envelope.

Peeked from the same limiter that enforces them; windows roll independently.

usage.remaining_secondremaining_minuteremaining_dayremaining_month

integer | null

Headroom left in each envelope.

envelope minus usage, floored at 0; remaining_month is null only on a key issued with no monthly quota.

callable_endpoints

string[]

Every endpoint id this key may actually call.

Live registry endpoints filtered by the endpoints allow-list (and the owner's ceiling) — nothing else narrows it. A freshly minted key lists only the three meta ids until further grants.

registry_version

string

Version of the endpoint registry serving the call.

Matches /v1/health.

ip

string

Your caller IP as the service sees it.

Resolved through the configured number of trusted proxy hops.

key_idstring
Public identifier of the calling key.
How it is computed
A token reads sxk_<env>_<key_id>.<secret>: key_id is the 16 characters between the second underscore and the dot. It identifies which key made the call without exposing secret material.
key_namestring
Human label given at issuance.
How it is computed
Use it to tell production from notebook keys.
user_idemailstring
The user the key belongs to.
How it is computed
One user may hold several keys — see /v1/me/keys.
roleis_adminstring / boolean
The user's platform role, and whether it confers admin powers.
How it is computed
Read from the live user record at call time; an admin's key additionally reaches the administrative endpoints.
allow.endpointsalphasrunsallow-list
What this key may call, and which alphas it may address.
How it is computed
endpoints is deny-by-default: a new key carries {"mode":"list","ids":["meta.health","meta.keys","meta.me"]} until an administrator grants more. {"mode":"all"} on endpoints is a deliberate wide grant (an open account ceiling, or an operator key) — not the self-service default — and still cannot invent routes outside the registry. alphas and runs default to {"mode":"prefix","prefixes":["Test_"]} (testing alphas only); {"mode":"all"} or a named list is an administrator grant.
field_policy.expose_raw_bookboolean
Whether raw_* fields and raw_ books are served to this key.
How it is computed
Per-key flag for unconditioned signal access.
rate_limit.per_secondper_minuteper_daymonthly_requestsinteger | null
The rate envelopes on the key.
How it is computed
Whatever the key carries, falling back to the self-service defaults — 5 per second, 60 per minute, 5000 per day and 100000 per month. The example above uses those defaults.
usage.secondminutedaymonthinteger
Live consumption against each envelope.
How it is computed
Peeked from the same limiter that enforces them; windows roll independently.
usage.remaining_secondremaining_minuteremaining_dayremaining_monthinteger | null
Headroom left in each envelope.
How it is computed
envelope minus usage, floored at 0; remaining_month is null only on a key issued with no monthly quota.
callable_endpointsstring[]
Every endpoint id this key may actually call.
How it is computed
Live registry endpoints filtered by the endpoints allow-list (and the owner's ceiling) — nothing else narrows it. A freshly minted key lists only the three meta ids until further grants.
registry_versionstring
Version of the endpoint registry serving the call.
How it is computed
Matches /v1/health.
ipstring
Your caller IP as the service sees it.
How it is computed
Resolved through the configured number of trusted proxy hops.

The recommended way to verify a key: one call tells you what it may call and how much quota is left.
Endpoint access is deny-by-default. A key you create for yourself starts with meta.health, meta.me and meta.keys only; catalogue, signals, portfolio, performance, benchmarks and analytics answer only after an administrator opens them on your account (or on the key). Customers never receive every endpoint by default.
allow.endpoints mode "all" means the key inherits a wide ceiling — every customer endpoint the account may reach — not that every registered route is public. Administrative ids remain effective only on an operator's key. When you mint a key and omit endpoint_allow (or send mode "all"), the key receives your account ceiling as-is; a meta-only ceiling stays meta-only.
The self-service rate defaults are 5 requests per second, 60 per minute, 5,000 per day and 100,000 per month — read rate_limit rather than assuming any other figure.