---
title: "Suggest an address for a site"
method: GET
path: "/sites/address-suggestions"
tags: ["Sites"]
---

# Suggest an address for a site

`GET /sites/address-suggestions`

## Request

- Base URL: `https://api.hypamoon.com/api/v1`
- URL: `https://api.hypamoon.com/api/v1/sites/address-suggestions`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://app.hypamoon.com/oauth/authorize`, token URL `https://api.hypamoon.com/oauth/token`, scopes: `sites:read`)

Checks the address the user wants (slug) and suggests up to three available ones based on name. Use it before POST /sites to show the user a suggestion and let them pick or change it. Nothing is reserved. Names that look like a bank, login, payment or support page, a brand, or anything with hypamoon in it are refused.

## Query parameters

- `name` string
- `slug` string

## Response `200`

The requested address, checked, and available suggestions.

- object: Address suggestions for a site.
  - `requested` object, nullable, required: The slug you sent, checked. null without slug.
    - `slug` string, required: The address you asked about, normalised (lowercase).
    - `available` boolean, required: true when you can use it now: nobody has it, or it is an old address of a site of this project.
    - `reason` string, nullable, required: Why not, when available is false.
    - `url` string, required: The address it would get.
  - `suggestions` object[], required: Up to three free addresses derived from name. Nothing is reserved: whoever uses one first gets it.
    - `slug` string, required
    - `url` string, required

## Other responses

- `401`: Unauthorized: unauthorized, missing_api_key, invalid_api_key, api_key_revoked, project_deleted.
- `403`: Forbidden: project_not_enabled, key_mode_mismatch, missing_scope, verification_required.
- `404`: Not Found: not_found.
- `422`: Unprocessable Content: validation_failed.
- `429`: Too Many Requests: rate_limited.
- `500`: Internal Server Error: internal_error.
- `503`: Service Unavailable: service_unavailable.

---

[API](https://skmtc.dev/hypamoon/apis/hypamoon-api.md) · [All operations](https://skmtc.dev/hypamoon/apis/hypamoon-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hypamoon/apis/hypamoon-api/revisions/9f0b90004c06?raw)