GET /v1/me

Returns metadata only for the authenticated key. It never returns the complete API secret.

Required entitlement
usage:read Account and usage
Bearer key required · JSON · v1

Example request

curlCurrent API identity
curl "https://api.exchangedz.com/v1/me" \
  -H "Authorization: Bearer $EXDZ_API_KEY"

Response

json200 OK
{
  "data": {
	    "account": {
	      "id": "cm0customer..."
	    },
	    "grant": {
	      "id": "cm0grant...",
	      "provider": "manual",
	      "plan": "starter",
	      "status": "active",
	      "scopes": [
	        "assets:read",
	        "usage:read",
	        "rates:parallel:latest:read",
	        "rates:official:latest:read",
	        "market:premium:read",
	        "rates:parallel:history:read",
	        "rates:official:history:read",
	        "gold:latest:read",
	        "gold:history:read"
	      ],
	      "validFrom": "2026-08-01T00:00:00.000Z",
	      "validUntil": "2026-09-01T00:00:00.000Z",
	      "monthlyRequestLimit": 10000,
	      "requestsPerMinute": 60
	    },
	    "key": {
	      "publicId": "abcd1234efgh",
	      "prefix": "exdz_live_abcd1234efgh",
	      "label": "Production",
	      "environment": "live",
	      "scopes": [
	        "assets:read",
	        "usage:read",
	        "rates:parallel:latest:read",
	        "rates:official:latest:read",
	        "market:premium:read",
	        "rates:parallel:history:read",
	        "rates:official:history:read",
	        "gold:latest:read",
	        "gold:history:read"
	      ],
	      "status": "active",
	      "expiresAt": null,
	      "lastUsedAt": "2026-08-24T11:00:00.000Z"
	    },
	    "usage": {
	      "periodStart": "2026-08-01T00:00:00.000Z",
	      "resetAt": "2026-09-01T00:00:00.000Z",
	      "requestsUsed": 158,
	      "requestsRemaining": 9842,
	      "requestLimit": 10000,
	      "requestsPerMinute": 60,
	      "minuteRemaining": 54,
	      "minuteResetAt": "2026-08-24T11:01:00.000Z"
	    }
  },
  "meta": { "requestId": "req_01J6EXDZ..." }
}

The scope lists contain canonical entitlements, including for older keys that were issued with a legacy umbrella permission. Nullable timestamps may be omitted or returned as null when no request has used a new key.

Usage fields

account
The non-sensitive account ID that owns the credential. Billing contact data is omitted.
grant
The plan, access status and validity window currently authorizing requests.
grant.scopes
The canonical data entitlements enabled for the customer's access grant.
key
Safe key metadata including prefix and last-use timestamp. The full secret is never recoverable here.
key.scopes
The key's canonical entitlements. A request is allowed only when both this list and grant.scopes include the endpoint's required entitlement.
usage
Current monthly period and allowance plus the active per-minute burst-window state.