# Account

- Method: `GET`
- Path: `/account`
- Credits: 0
- HTML docs: https://docs.hiddensystems.ai/nebula/reference/get-account/
- Interactive docs: https://docs.hiddensystems.ai/nebula/api/#endpoint=get-account

## Description

Your plan, limits, and credits right now: the history window, the per-minute rate limit, and how many credits are left in the current cycle, plan and purchased, with the cycle's dates. It is free and does not count against your credits, so check it as often as you need.

The same numbers arrive on every response as the RateLimit-* and X-Credits-* headers; this is the place to read them without making a data request.

## cURL Example

```bash
curl --request GET \
  --url 'https://nebula-api.hiddensystems.ai/api/v1/public/account' \
  --header 'X-API-Key: YOUR_API_KEY'
```

## Path Parameters

No path parameters for this endpoint.

## Query Parameters

No query parameters for this endpoint.

## Response

OK

- `credits` (object): The account's credit position this cycle; absent for keys that are not metered.
- `credits.cycle_end` (string (date-time), required): UTC end of the current credit cycle, when plan credits renew.
- `credits.cycle_start` (string (date-time), required): UTC start of the current credit cycle.
- `credits.plan_credits` (integer (int64), required): Credits the plan includes this cycle.
- `credits.plan_credits_remaining` (integer (int64), required): Plan credits left this cycle.
- `credits.plan_credits_used` (integer (int64), required): Plan credits spent this cycle.
- `credits.purchased_credits_remaining` (integer (int64), required): Unexpired purchased credits left, spent after plan credits.
- `credits.total_remaining` (integer (int64), required): Everything left to spend: plan plus purchased credits.
- `history_window_days` (integer, required): How many days back the plan can read; null when unbounded.
- `plan` (string, required): The account's API plan, such as free or pro.
- `rate_limit_per_minute` (integer, required): Requests allowed per minute; null when the key is not rate limited.

Media type: `application/json`

## JSON Response

```json
{
  "history_window_days": 3650,
  "plan": "pro",
  "rate_limit_per_minute": 300
}
```