# API Status

`GET https://api.astroway.info/v1/status`

Status of the key you authenticate with: its plan and rate limit, request counts for today, this week and this month, the top endpoints it calls, and a daily series. Authenticate with the `X-Api-Key` header; without one the answer is 400 MISSING_KEY. The `?key=` query parameter still works but is deprecated and answers carry a `Deprecation` header: a URL ends up in access logs, CDN logs and browser history, so a key passed that way stops being secret.

Group: System. Auth: `X-Api-Key` header. Operation ID: `status_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` | object | no |  |
| `key.name` | string | no |  |
| `key.plan` | string | no |  |
| `key.rateLimit` | number | no |  |
| `key.requestsTotal` | number | no |  |
| `key.lastUsedAt` | string | no |  |
| `key.createdAt` | string | no |  |
| `usage` | object | no |  |
| `usage.today` | number | no |  |
| `usage.week` | number | no |  |
| `usage.month` | number | no |  |
| `limits` | object | no |  |
| `limits.plan` | string | no |  |
| `limits.requestsPerMinute` | number | no |  |
| `limits.dailyEstimate` | number | no |  |
| `limits.monthlyEstimate` | number | no |  |
| `limits.usagePercent` | object | no |  |
| `limits.onExceeded` | string | no |  |
| `endpoints` | object[] | no |  |
| `daily` | object[] | no |  |

## Example

```bash
curl -X GET https://api.astroway.info/v1/status \
  -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/status_get/