Domains

Search available domains

Search for available domain names to register. Returns availability and pricing information.

post/domains/search

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/domains/search
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://shipmail.to/api/auth/oauth2/authorize, token URL https://shipmail.to/api/auth/oauth2/token)

Headers

X-Shipmail-Organizationstring

OAuth access tokens only. The organization ID this request acts on. Required when the OAuth connection was approved for several organizations (400 validation_error without it); optional with one. An organization the connection was not approved for returns 403 authorization_error. Ignored for API keys, which belong to one organization.

Request body

keywordstring required

Keyword to search for available domains.

Response

Search results.

Example response

{
  "results": [
    {
      "domain_name": "example.com",
      "currency": "USD"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.