API Module Domain suggestNameDomainRequest - Revision history

WikiSysop: /* Module Domain > Name Suggestion */

WikiSysop — Thu, 23 Oct 2025 06:33:00 GMT

Module Domain > Name Suggestion

← Older revision		Revision as of 06:33, 23 October 2025
Line 15:		Line 15:
	*name - the search term which will be used to generate matches		*name - the search term which will be used to generate matches
	*limit - maximum number of suggestions to return		*limit - maximum number of suggestions to return
-	*language - ~~the~~ three letter country code in which ~~suggestions~~ should be ~~returned~~ (ISO-~~3166 ALPHA-3 code~~ format)	+	*language - The three-letter country code for the language in which responses should be generated (ISO 639-2/B format). Allowed languages: English (eng), Dutch (dut), French (fre), German (ger), Hindi (hin), Indonesian (ind), Italian (ita), Japanese (jpn), Korean (kor), Chinese (Mandarin) (chi), Portuguese (por), Spanish (spa), Turkish (tur), Vietnamese (vie).
	*sensitive - 1/true to remove domain name suggestions deemed obscene by the supplier. 0/false to include obscene domain name suggestions.		*sensitive - 1/true to remove domain name suggestions deemed obscene by the supplier. 0/false to include obscene domain name suggestions.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"

WikiSysop: /* Module Domain > Name Suggestion */

WikiSysop — Thu, 13 May 2021 11:57:30 GMT

Module Domain > Name Suggestion

← Older revision		Revision as of 11:57, 13 May 2021
Line 13:		Line 13:
	\|'''Input'''		\|'''Input'''
	\|		\|
-	*name - the search term which will be used to ~~generating~~ matches	+	*name - the search term which will be used to generate matches
	*limit - maximum number of suggestions to return		*limit - maximum number of suggestions to return
-	*language - the 3 letter country code ~~for the desired search language~~ (ISO-3166 ALPHA-3 code format)	+	*language - the three letter country code in which suggestions should be returned (ISO-3166 ALPHA-3 code format)
-	*sensitive - 1 to remove domain name suggestions deemed obscene by the supplier. 0 to include obscene domain name suggestions.	+	*sensitive - 1/true to remove domain name suggestions deemed obscene by the supplier. 0/false to include obscene domain name suggestions.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\|'''Output'''		\|'''Output'''

WikiSysop: /* Module Domain > Name Suggestion */

WikiSysop — Tue, 11 May 2021 07:22:57 GMT

Module Domain > Name Suggestion

← Older revision		Revision as of 07:22, 11 May 2021
Line 13:		Line 13:
	\|'''Input'''		\|'''Input'''
	\|		\|
-	*name - the search term ~~for to match~~ to	+	*name - the search term which will be used to generating matches
-	*limit	+	*limit - maximum number of suggestions to return
-	*language	+	*language - the 3 letter country code for the desired search language (ISO-3166 ALPHA-3 code format)
-	*sensitive	+	*sensitive - 1 to remove domain name suggestions deemed obscene by the supplier. 0 to include obscene domain name suggestions.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\|'''Output'''		\|'''Output'''

WikiSysop: Created page with '==Module Domain > Name Suggestion == {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |domain |- style="background-color:#EEEEEE;" |'''Command nam…'

WikiSysop — Tue, 11 May 2021 07:16:22 GMT

Created page with '==Module Domain > Name Suggestion == {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |domain |- style="background-color:#EEEEEE;" |'''Command nam…'

New page

==Module Domain > Name Suggestion ==
{| border="1" cellpadding="4"
|- style="background-color:#BBBBBB;"
|'''Module'''
|domain
|- style="background-color:#EEEEEE;"
|'''Command name'''
|suggestNameDomainRequest
|-
|'''Use'''
|Returns a list of domain suggestions based on a search term
|- style="vertical-align:top;"
|'''Input'''
|
*name - the search term for to match to
*limit
*language
*sensitive
|- style="vertical-align:top;"
|'''Output'''
|returns array of domain suggestions with the following format:
*name (domain and TLD seperated by '.')
*domain (domain name, not including the tld)
*tld (only the tld )
|}

==Examples==
===Using PHP class===
$request = new OP_Request;
$request->setCommand('suggestNameDomainRequest')
->setAuth(array('username' => 'username', 'password' => 'password'))
->setArgs(array(
'name' => 'wac', //search term
'limit' => 3,
'language' => 'spa',
'sensitive' => 1,
));

===Raw XML===
''Please note that newlines and leading spaces are added only for readability. Those whitespaces should be excluded from your XML command before sending it to Openprovider.''
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<credentials>
<username>username</username>
<password>password</password>
</credentials>
<suggestNameDomainRequest>
<name>wac</name>
<limit>3</limit>
<language>spa</language>
<sensitive>1</sensitive>
<tlds>
<array>
<item>com</item>
<item>info</item>
<item>com.es</item>
</array>
</tlds>
</suggestNameDomainRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>"
<openXML>
<reply>
<code>0</code>
<desc></desc>
<data>
<array>
<item>
<name>SheWac.com</name>
<domain>SheWac</domain>
<tld>com</tld>
</item>
<item>
<name>HeWac.info</name>
<domain>HeWac</domain>
<tld>info</tld>
</item>
<item>
<name>HeWac.com.es</name>
<domain>HeWac</domain>
<tld>com.es</tld>
</item>
</array>
</data>
</reply>
</openXML>