Search domain availability

GET

/domains/search

Search domain availability and pricing for a query. Returns
{ configured, query, results }; configured:false when domain search isn't
set up. Prices shown are the price you'd pay. 404 if the feature is off.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200OK

application/json

Search results.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠429NotFound

🔴502Bad Gateway

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://upload.tf/api/v1/domains/search?q=mycoolsite' \
--header 'x-api-key: <api-key>'

Response Example

200 - Example 1

{
    "success": true,
    "data": {
        "configured": true,
        "query": "string",
        "results": [
            {
                "domain": "string",
                "available": true,
                "priceUsd": 0,
                "premium": true
            }
        ]
    }
}

Modified at 2026-08-08 15:20:28

Connect a custom domain

Rebind a domain to a different page