# Get OpenAPI

`GET https://api.unique.domains/v1/meta/openapi.json`

The OpenAPI document of the API, whole or for one listing, in its 3.1 or 3.0 form.

Built from the typed endpoint catalog, served bare (no envelope). Each RapidAPI listing imports its own document with `listing`, in the 3.0 form (`oas=3.0`), the one RapidAPI's import accepts.

- Access: Free, no per-address limit
- Billing: One call.
- Formats: JSON

## Request

| Field | Type | Needs | Where | Description |
| --- | --- | --- | --- | --- |
| `listing` | string: names, words, catalog, tlds, registrars, market, trends, agenda, availability, whois, appraisal, expired, auctions, sales-history, price-comparison, trending-topics | Optional | Query | One RapidAPI listing's paths (the eight APIs and the eight focused listings) plus the shared ones; every path when absent. |
| `oas` | string: 3.1, 3.0 | Optional | Query | The OpenAPI version: `3.1` (the default) or `3.0`, the same paths and operations with 3.0 schemas (`nullable` for a null type). |

## Sample request

```bash
curl -X GET "https://api.unique.domains/v1/meta/openapi.json"
```

## Errors

| Code | Status | What it means |
| --- | --- | --- |
| [`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
{
  "openapi": "3.1.0",
  "info": {
    "title": "Unique Domains API",
    "version": "1.0.0"
  }
}
```

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

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