# API Key Introspection

`GET https://api.astroway.info/v1/auth/keys/me`

Return metadata about the calling API key: plan, remaining credits, period end, bound domain, status. Useful for any SDK consumer that wants to surface plan and balance in its own UI. A key that is not metered (internal, or a custom plan without a limit) returns `credits_remaining` and `credits_total_this_period` as null with `unlimited: true`; a site key returns them as null with `limits.per_hour`.

Group: System. Auth: `X-Api-Key` header. Operation ID: `auth_keys_me_get`.

## Parameters

| Name | In | Required | Type | Description |
|---|---|---|---|---|
| `fields` | query | no | string | Comma-separated dotted paths, relative to `data`, to keep in the response. A path is applied to every element of an array, so `planets.name` means the name of each planet. Paths that match nothing come back in `_fields_unmatched`; a list where nothing matches at all is a 400, because an empty object would be a confident wrong answer. |
| `precision` | query | no | integer | Round every non-integer number in the response to this many decimal places. Integers are left alone, because an id is not a measurement. Ecliptic longitudes ship with fourteen decimals by default; 2 is about a tenth of an arcminute. |

## Responses

| Status | Meaning |
|---|---|
| 200 | Successful calculation |
| 400 | Validation error |
| 401 | Missing or invalid API key |

### Success fields, under `data`

| Field | Type | Required | Description |
|---|---|---|---|
| `key_prefix` | string | no |  |
| `plan` | string | no |  |
| `credits_remaining` | number | no |  |
| `credits_total_this_period` | number | no |  |
| `period_end` | string | no |  |
| `status` | string | no |  |
| `domain` | string | no |  |
| `domain_bound_at` | string | no |  |
| `created_at` | string | no |  |
| `referrer_source` | string | no |  |

## Example

```bash
curl -X GET https://api.astroway.info/v1/auth/keys/me \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json"
```

---

Rendered from https://api.astroway.info/v1/openapi.json. HTML page: https://api.astroway.info/docs/api/operations/auth_keys_me_get/