GET/v1/keys/self

API key required, sent as Authorization: Bearer snk_… or ?api_key=snk_….

Call it

bash

curl -fsS -X GET "https://api.mapmap.ai/v1/keys/self" \
  -H "Authorization: Bearer $MAPMAP_KEY"

Responses

200State, quota, usage, credits and expiry of the calling key

Field	Type	Required	Description
allowed_origins	string[]	yes	Origins this key may be called from. Empty means unrestricted — the key works from anywhere, including from a server with no origin at all.
credits_millipence	integer	yes	Prepaid credit balance in internal millipence (1p = 1000 millipence) — full precision for fractional, tiered per-call prices.
credits_pence	integer	yes	Prepaid credit balance of the owning identity, in pence (floor of the internal millipence balance).
download_allowance_mib	integer	yes	Monthly offline-download allowance in MiB (identity-bound). A plan or the SDK licence raises this above the free evaluation default.
download_used_mib	integer	yes	Offline download bytes served this calendar month, in MiB (rounded up), identity-wide.
email	string	no	Delivery email of the owning identity — the key holder already proved control of the key, and the website's checkout derives the billing identity from this rather than trusting client input. Absent on operator (`admin`) keys, which have no identity.
expires_at	string	no	RFC 3339 expiry — present on provisional keys only.
first_success_at	string	no	RFC 3339 timestamp of this key's first successful (2xx) metered API call — the activation event — or `null` if it has never had one. The stamp is written by a buffered task, so it can lag the first success by a moment.
identity_keys	integer	yes	Number of active keys sharing this identity (including this one).
key_id	string	yes	Key id (UUID).
mau_included	integer	yes	Included monthly active users per calendar month (identity-bound). A plan or the admin API raises this above the free default.
mau_overdrawn	boolean	yes	Whether a new distinct user beyond the included count could not be covered by the prepaid ledger this month. Fail-open: requests keep being served regardless; sustained overdraw is a commercial conversation, not a hard stop.
mau_this_month	integer	yes	Distinct monthly active users (`X-MapMap-User` identifiers) recorded this calendar month, identity-wide. Flushed rows only — the buffered writer lags by at most the flush interval.
monthly_quota	integer	yes	Requests allowed per calendar month (identity-bound for self-served keys).
remaining	integer	yes	Free-tier requests remaining this month.
scope	string	yes	`"full"` or `"maps"`. A `maps` key may draw tiles, read styles/fonts/sprites, geocode and read its own status; everything else answers 403 `scope-insufficient`.
state	string	yes	Lifecycle state: `admin`, `provisional` or `verified`.
used_this_month	integer	yes	Requests used this month (identity-wide for self-served keys, including not-yet-flushed ones for this key).

401Missing, unknown, revoked or expired key

Error bodies follow the shared problem model documented on API conventions.

Also under self-serve

GET /v1/jobs GET /v1/jobs/{id}POST /v1/keys POST /v1/keys/self/webhook-secret GET /v1/keys/verify GET /v1/usage POST /v1/x402/topup

Generated from https://api.mapmap.ai/openapi.json on 2026-09-17 · operationId self_status