# Get word endings

`GET https://api.unique.domains/v1/words/{word}/endings`

A word's endings as the nightly update holds them: counts, the key endings and open names per ending.

Reads the `WordEndings` row. A word with no count (not scanned, or not counted yet) answers `byGroup` and `openByEnding` null; zeros are real. The cheapest ending is a keyed include only: a name chosen by price never reaches the free tier.

- Access: No key. Limited per address; a key adds the paid fields.
- Billing: One call.
- Formats: JSON
- API: Word Intelligence API

## Request

| Field | Type | Needs | Where | Description |
| --- | --- | --- | --- | --- |
| `word` | string | Required | Path | The catalog slug, the word, or `wrd_<id>`. |
| `fields` | string | Optional | Query | Comma-separated top-level keys to keep; an unknown key answers 400 `unsupported_field`. |
| `include` | string | Optional | Query | Comma-separated optional blocks, listed under the answer. |

## Sample request

```bash
curl -X GET "https://api.unique.domains/v1/words/harbor/endings"
```

## Response

| Field | Type | Description |
| --- | --- | --- |
| `byGroup` | object \| null | Null for a word with no count (not scanned, or not counted yet); zeros are real. |
| `keyEndings` | object[] |  |
| `openByEnding` | object \| null | `{ ending: count }`; null for a word with no count (not scanned, or not counted yet); zeros are real. |
| `cheapest` | object | Keyed `include=cheapest` only. |

## Optional blocks

| Block | Needs | Description |
| --- | --- | --- |
| `cheapest` | Paid | The cheapest ending and its price. |

## Errors

| Code | Status | What it means |
| --- | --- | --- |
| [`not_found`](https://unique.domains/api/problems/not_found) | 404 | Not found |
| [`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": {
    "byGroup": {
      "scanned": 96,
      "taken": 71,
      "available": 18,
      "forSale": 7
    },
    "keyEndings": [
      {
        "ending": "com",
        "status": "taken",
        "price": null
      },
      {
        "ending": "io",
        "status": "available",
        "price": 34.98
      }
    ],
    "openByEnding": {
      "io": 1,
      "co": 1,
      "studio": 1
    }
  },
  "meta": {
    "asOf": "2026-11-05T08:00:00Z",
    "cursor": null,
    "limit": null
  },
  "links": {
    "self": "https://api.unique.domains/v1/words/harbor/endings",
    "next": null,
    "register": null,
    "product": null,
    "dataset": null
  }
}
```

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

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