# Get key

`GET https://api.unique.domains/v1/meta/key`

The calling key's own plan, allowances and month.

For a member key: the plan, the key's first characters, the UTC month with its reset day, and each figure of the month used against the plan's allowance, and whether the Investor endpoints are open, with the month's quota headers. For a RapidAPI subscription: the listing and the subscription, the rest null. Never counted against a member key's month and never cached; a call with no key answers 403.

- Access: A member key (Founder or Investor) or a paid RapidAPI subscription to this API.
- Billing: One call.
- Formats: JSON

## Request

| Field | Type | Needs | Where | Description |
| --- | --- | --- | --- | --- |
| `fields` | string | Optional | Query | Comma-separated top-level keys to keep; an unknown key answers 400 `unsupported_field`. |

## Sample request

```bash
curl -X GET "https://api.unique.domains/v1/meta/key" \
  -H "Authorization: Bearer YOUR_MEMBER_KEY"
```

## Response

| Field | Type | Description |
| --- | --- | --- |
| `access` | string |  |
| `plan` | string \| null |  |
| `keyPrefix` | string \| null |  |
| `listing` | string \| null |  |
| `subscription` | string \| null |  |
| `month` | string \| null |  |
| `resetsOn` | string \| null |  |
| `calls` | object \| null |  |
| `liveChecks` | object \| null |  |
| `appraisals` | object \| null |  |
| `intakes` | object \| null |  |
| `investorEndpoints` | boolean \| null |  |

## Errors

| Code | Status | What it means |
| --- | --- | --- |
| [`keyed_only`](https://unique.domains/api/problems/keyed_only) | 403 | A paid subscription is required |
| [`rate_limited`](https://unique.domains/api/problems/rate_limited) | 429 | Too many requests |
| [`internal`](https://unique.domains/api/problems/internal) | 500 | Unexpected error |

## Example answer

200, application/json

```json
{
  "data": {
    "access": "member",
    "plan": "founder",
    "keyPrefix": "ud_live_A1b2",
    "listing": null,
    "subscription": null,
    "month": "2026-11",
    "resetsOn": "2026-12-01",
    "calls": {
      "used": 412,
      "allowance": 10000
    },
    "liveChecks": {
      "used": 3,
      "allowance": 50
    },
    "appraisals": {
      "used": 0,
      "allowance": 0
    },
    "intakes": {
      "used": 0,
      "allowance": 0
    },
    "investorEndpoints": false
  },
  "meta": {
    "asOf": "2026-11-05T08:00:00Z",
    "cursor": null,
    "limit": null
  },
  "links": {
    "self": "https://api.unique.domains/v1/meta/key",
    "next": null,
    "register": null,
    "product": null,
    "dataset": null
  }
}
```

API status: https://uniquedomains.instatus.com

Full reference: https://unique.domains/api
