| The Dynadot API allows you to search for and register domain names programatically, using your own software and server. This API is still under development, and will probably change over the next few months. The register and delete commands are still under development. The API is only available to accounts that qualify for bulk pricing. |
OverviewRequests to the API are sent to the following url. Note that requests should be sent over https (secure socket) for security.
https://www.dynadot.com/api.html
Only one request can be processed at a time. So please wait for your current request to finish before sending another request. The request should have the following parameters.
| Request Parameter |
Explanation |
| version |
Version of the API; enter '1.0' which is the only version right now |
| key |
Your key to access the API, available in your account control panel |
| command |
The commands supported right now are 'search' and 'register' |
The results are sent as a comma delimited text file. The first line is the result of the command. This line has 2 fields.
| Result Field |
Explanation |
| 1 |
The result of this API call.
ok - the command was successful
error - the command was not successful
|
| 2 |
More information about the result. Only used when result is 'error'. |
The second line is empty. Subsequent lines are the results of the command, for example your search results.
Search CommandIf calling the search command, the following parameters should be included:
| Search Request Parameter |
Explanation |
| domain0 - domain99 |
The domain name you are searching for; you can specify up to 100 domains |
| language0 - language99 |
The language tag for the respective domain; only use this for IDNs |
There will be one result line for each domain submitted. Each line will have 5 fields.
| Search Result Field |
Explanation |
| 1 |
The domain parameter. For example: domain0 |
| 2 |
The domain name searched for. For example: mydomain.com |
| 3 |
The language if any. For example: spa |
| 4 |
The result of the search:
yes - the domain is available
no - the domain is not available
error - there was a syntax or registry error processing this domain
offline - the central registry for this domain is currently offline
|
| 5 |
More information about the result. Only used when result is 'error'. |
Search ExampleRequest
https://www.dynadot.com/api.html?version=1.0&key=8S7I2s6Qd8g&
command=search&domain0=mydomain.com&domain1=mydomain.net Response
ok,
domain0,mydomain.com,,no,
domain1,mydomain.net,,yes,
Register CommandCalling the register command will create and process a registration order. You must have enough account balance to pay for the order. If calling the register command, the following parameters should be included:
| Register Request Parameter |
Explanation |
| domain |
The domain name you want to register; only one domain can be registered per request |
| language |
The language tag for the requested domain; only needed if the domain is an IDN |
| duration |
How long to register the domain for |
There will be one result line for each domain submitted. Each line will have 3 fields.
| Register Result Field |
Explanation |
| 1 |
The result of the register request:
success - the domain was successfully registered
not_available - the domain is not available
error - there was a syntax or registry error processing this request
offline - the central registry for this domain is currently offline
insufficient_funds - not enough account balance to process this registration
|
| 2 |
More information about the result. Only used when result is 'error'. |
| 3 |
Expiration date in unix time (milliseconds since midnight UTC of January 1, 1970). Only used when result is 'success'. |
Register ExampleRequest
https://www.dynadot.com/api.html?version=1.0&key=8S7I2s6Qd8g&
command=register&domain=mydomain.com&duration=1 Response
ok,
success,,1180897681932
LanguagesAfrikaans:afr Albanian:alb Arabic:ara Aragonese:arg Armenian:arm Assamese:asm Asturian:ast Avestan:ave Awadhi:awa Azerbaijani:aze Balinese:ban Baluchi:bal Basa:bas Bashkir:bak Basque:baq Belarusian:bel Bengali:ben Bhojpuri:bho Bosnian:bos Bulgarian:bul Burmese:bur Carib:car Catalan:cat Chechen:che Chinese:chi Chuvash:chv Coptic:cop Corsican:cos Croatian:scr Czech:cze Danish:dan Divehi:div Dogri:doi Dutch:dut Estonian:est Faroese:fao Fijian:fij Finnish:fin French:fre Frisian:fry Gaelic:gla Georgian:geo German:ger Gondi:gon Greek:gre Gujarati:guj Hebrew:heb Hindi:hin Hungarian:hun Icelandic:ice Indic:inc Indonesian:ind Ingush:inh Irish:gle Italian:ita Japanese:jpn Javanese:jav Kashmiri:kas Kazakh:kaz Khmer:khm Kirghiz:kir Korean:kor Kurdish:kur Lao:lao Latvian:lav Lithuanian:lit Luxembourgish:ltz Macedonian:mac Malayalam:mal Malay:may Maltese:mlt Maori:mao Moldavian:mol Mongolian:mon Nepali:nep Norwegian:nor Oriya:ori Ossetian:oss Panjabi:pan Persian:per Polish:pol Portuguese:por Pushto:pus Rajasthani:raj Romanian:rum Russian:rus Samoan:smo Sanskrit:san Sardinian:srd Serbian:scc Sindhi:snd Sinhalese:sin Slovak:slo Slovenian:slv Somali:som Spanish:spa Swahili:swa Swedish:swe Syriac:syr Tajik:tgk Tamil:tam Telugu:tel Thai:tha Tibetan:tib Turkish:tur Ukrainian:ukr Urdu:urd Uzbek:uzb Vietnamese:vie Welsh:wel Yiddish:yid
|
