Catalog

Your net prices for every TLD you can sell, in your account’s currency. This is also the list of TLDs available to you: a TLD that is not here cannot be registered or transferred through the API.

For each TLD, register and renew list every term you can buy (years from min_years to max_years) with its price; transfer lists only the minimum term, the one a transfer buys. grace_fee and redemption_fee are added to a renewal in grace and to a restore; null means none is charged. Prices are net of tax.

idn says whether the API accepts a Unicode name on the TLD (a Unicode name on a TLD with idn: false is refused as invalid_domain); it is not a statement about which scripts the registry supports. registrant_countries lists the registrant countries (ISO codes) the TLD accepts: a register or transfer with a registrant elsewhere is refused as invalid_contact before any credit is taken. null means the panel knows no country restriction, not that the registry has none. A transfer always requires auth_code, whatever the TLD.

dnssec says whether DNSSEC can be managed on the TLD’s domains and in which record form (ds or dnskey), so you know before registering. It is a per-TLD capability: the truth for one domain, including whether the zone is signed for you (enable), is the operations of that domain’s DNSSEC state (GET /client/domains/{domain}/dnssec).

The registry-specific data a TLD requires on POST /reseller/domains/register and /transfer, in extra_fields (e.g. the entity type and tax codes of .it). Read it to build your form instead of learning each field from a 422 invalid_contact. tld is the extension, with or without the dot (it, .it, edu.it). A TLD with no extra fields answers an empty fields list.

For each field: send it when visible_if holds (null: always); it is mandatory when required is true, or when required_if holds. A condition is {"field", "op", "value"} with op one of eq, ne (value a string) or in, not_in (value a list of strings), or a group {"all": [...]} / {"any": [...]} of conditions. field names another extra field or a registrant field, compared as a string; a field with no value counts as different for ne and not_in.

A select accepts only the value of one of its options. A text with a pattern must match it: a Unicode regular expression, already anchored, with no delimiters or flags (use it with the u flag). A ticked checkbox is sent as its checked_value, "1"; a mandatory one must be ticked. Labels and descriptions are English.

The answer is the same as the refusal a register would give: an unknown TLD, and one not on your price list, answer 422 tld_not_sellable.

This describes what a NEW registration or transfer of the extension needs, with its default registry connection. For an EXISTING domain the authoritative set is the extra_fields of GET /reseller/domains/{name}/contacts: a domain managed through another registry connection can use different keys.

Tells you whether name can be registered, with your register and transfer price for the TLD’s minimum term. Use it before POST /reseller/domains/register or /transfer.

available is null when the registry could not be asked right now: retry later. A name already held on this server is reported as not available. Nothing is reserved or charged.

A definite answer is reused for up to 2 minutes, so asking again for the same name costs no registry lookup; register and transfer always check afresh before charging.