Requires (mandatory)
domain | domain name to check |
Accepts (optional)
check-price | If provided, specifically check the price for: create, renew, transfer, restore |
period |
If provided, price will be calculated based on specified period. Period may be specified in years (values from 1 to 10) or in traditional for DMAPI months (>= 12, must be a multiple of 12). |
language |
Relevant only for IDN domains, specifies language as 2 letter (ISO 639.1) or 3 letter (ISO 639.2) code: |
With this request you can check if a domain is available for registration, and what type of domain pricing will be applied for different types of orders.
Returns one or more lines with key-value pairs as follows:
domain-status: <status>
<status> can be one of:
available | regular domain (non-premium) available for registration |
premium | premium domain available for registration |
unavailable | domain is not available for registration |
If <status> is "unavailable", then domain-register request will fail, though domain-transfer-* and domain-renew (if domain is with Joker.com) are possible, of course.
domain-status-reason: <status-reason>
Provides human-readable description why domain is unavailable for registration, like blocked, reserved, registered etc.
May be absent if registry does not provide specific reason. Should not be parsed as value is registry dependent and could be virtually anything.
domain-class: <class>
Specifies price-class. Anything but "standard" is considered "premium", though some registries use "tier-1", "premium", "BBB" etc.
Mostly a hint, values except "standard" should not be interpreted as they have no useful meaning and vary among registries.
domain-price-<type>: <price> <currency> <period>y
Reports domain price, where <type> will be value provided in check-price parameter, i.e. create, renew, transfer, restore.
- <price> is the final price, i.e. amount that will be deducted from the user's account, considering all discounts, promos etc.
- <currency> is a 3-letter currency code, serves only as information.
- <period> is reported in years and suffixed by "y", like "5y", and it may be different from "period" parameter value (depends on registry), for instance when requested period is not available, too low or too high.
The price reported is valid only for specified period, i.e. if price is 100 for 2 years it does not necessarily mean that price for 1 year is 50, thus it only makes sense to check price for the period which will be used verbatim in subsequent request of specified <type>.
domain-price-promo: <start> <end>
<start> and <end> are ISO timestamps in format like 2019-07-01T00:00:00.000Z
For domains that have promotional pricing, this provides start and end timestamps of promotional period. Usually its mere presence means that promo-pricing is in effect, but to be sure values have to be checked explicitly.
If "domain-status" returned "premium" or "domain-class" returned anything but "standard", then the parameter max-price must be present in register/transfer/renew requests.
Full response example (web.blog):
domain-status: unavailable
domain-status-reason: blocked
domain-class: standard
domain-price-create: 8.21 USD 1y
domain-price-promo: 2019-09-01T00:00:00.000Z 2019-12-31T23:59:59.000Z
Example:
https://dmapi.joker.com/request/domain-check?domain=example.com&auth-sid=<your-current-session-id>