Domain Research API
Table of Contents
- What does the Domain Research API return?
- Why use the Domain Research API?
- How do I authenticate requests?
- Is there a usage limit?
- Have more questions?
The Domain Research API tells you whether a domain name is available for registration before you try to register or transfer it. Each request returns one of three availability values: available, unavailable, or unknown. The Domain Research API is only available on the Enterprise plan.
Note
The Domain Research API is in private beta. To request access, contact sales.
What does the Domain Research API return?
You send a request with the domain name you want to research. The response includes an availability value:
-
available: the domain can be registered. -
unavailable: the domain is already registered, or a restriction prevents registration. -
unknown: the availability could not be determined. The response can include error messages explaining why.
For the request format, parameters, response attributes, and errors, see the Domain Research API documentation on the DNSimple Developer site.
Why use the Domain Research API?
Use the Domain Research API to:
- Confirm availability before starting a registration or transfer flow.
- Show availability in your own app or portal without sending users elsewhere.
- Reduce failed attempts by checking status first and handling unavailable domains before you try to register them.
How do I authenticate requests?
Call the Domain Research API with an API access token that has the Domain Research permission scope. The scope is read-only. It cannot be limited to specific domains, so a token with this scope can research any domain.
Is there a usage limit?
Yes. Each account can make up to 10,000 Domain Research requests per calendar month. When the account reaches its cap, further requests in the same calendar month return HTTP 429 Too Many Requests with the message Monthly request cap reached. The Retry-After header gives the start of the next calendar month, when the cap resets.
Track your usage on the API & Access page. The API Limits & Usage card has a Domain Research API section that shows your account’s requests this month. Domain Research requests also count toward the account’s hourly API rate limit.
Have more questions?
If you have additional questions or need any assistance with the Domain Research API, contact support, and we’ll be happy to help. You can also read more about DNSimple Enterprise.