check_domain
Check domain availability and price
Look up exact domain names: whether each can be registered now, and its per-year registration, renewal and transfer price in USD, premium names included, from a live registry check. Use it for names you already have and to confirm a search_domains suggestion. Up to 10 names per call; read-only. available is true, false, or null (the registry could not be asked; not the same as taken). An unavailable name says why in reason: taken, reserved, unavailable or unknown. purchasable is false for an available name OrbitFour can't sell now, and for a null one, and purchase_blocker says why. first_term is the shortest term (min_years: .ai is 2) and its total with the ICANN fee. A malformed name or an extension OrbitFour doesn't sell comes back with an error field. pricing_source says where the registration price came from: "registry" is a live quote for that name, "baseline" is the extension's standard rate and final for the name (the extension has no premium names, or the registry quoted none for it), and "unconfirmed" means the registry lookup did not finish, so the price is not final for a name that may be premium. pricing_sources breaks this out per action.
輸入參數names必填years
search_domains
Search for available domain names
Find domain names from a free-text idea, brand or phrase; a phrase yields short combinations of its words. top_picks answers "how does my name look": the name as typed (when its extension isn't .com/.net/.org) and the name on .com, .net and .org, or on each extension in tlds, with its real status, taken and unknown included, as check_domain reports it. suggestions are up to `limit` ranked names a live check found available, never repeating a top pick, with per-year prices in USD, premium names included unless include_premium is false; match is exact_sld or variation, and hack is true for a domain hack such as danger.zone. unchecked_names lists names whose check came back unknown, left_out counts why other names checked aren't suggested, and with tlds, each extension says why it found nothing. Search is advisory: confirm the chosen name with check_domain before quoting it, and a purchase checks again. Read-only, no side effects.
輸入參數tldslimitquery必填yearsmax_priceinclude_premium
get_tld_requirements
Get an extension's prices and registration rules
Look up what OrbitFour charges and requires for domain extensions (TLDs): standard per-year registration, renewal, transfer and restore prices in USD plus the ICANN fee, the shortest and longest term, the fixed transfer term, whether WHOIS privacy is allowed, any eligibility restriction, whether browsers require HTTPS for its websites (https_required: .app, .dev), and JSON Schemas for what a registration must include (.us, for example, needs Nexus data on the registrant contact). Up to 10 extensions per call; read-only. These are standard prices: when premium_possible is true a particular name can cost more, so quote it with check_domain. An extension OrbitFour does not sell comes back as tld_not_found.
輸入參數tlds必填
check_transfer
Check whether domains can be transferred in
Ask each name's registry whether it can be transferred to OrbitFour now (not locked, no transfer or delete pending) and quote the full first-term transfer price in USD: the per-year price plus the ICANN fee for the registry's transfer term. Up to 5 names per call; read-only. transferable is true, false, or null (the registry could not be asked just now; not the same as locked), and reasons says why: invalid_name, unsupported_tld, already_here, not_registered (nobody holds it, so register it instead), locked, pending_transfer, pending_delete, premium_over_cap, price_unconfirmed, unknown. The price is what the transfer would cost if it goes ahead. Never send a transfer authorization code here: the transfer itself asks for it.
輸入參數names必填