API Queries - List Domains

The list_domains function lists domains in your Monetization account. Additional parameters are optional for this function.

Additional Parameters

• folder - The name of the folder to show domains from. If this parameters is omitted, all domains in your account will be shown. (Optional)
• only_owned - Flag to only include owned domains in the result. (Optional)
• exclude_trash_domains - Flag to exclude domains from Trash folder when using w/o any folder name. (Optional)
• start - The starting offset for results. Default is 0 (Optional)
• num - The number of results to show from the report. Default is 100, maximum is 1,000 (Optional)

Note: Make sure to URL encode all values.

Example query and response:

In this example, we will retrieve a list of all domains in the folder "parked domains" (folder=parked%20domains).

Example query:
https://www.above.com/api.php?username=user&api_key=key&mode=list_domains&folder=parked%20domains&start=0&num=100

Response:

<results>
    <![CDATA[
Domain,Owner
a-domain123456.com,yes
a-domain123456-2.com,yes
a-domain123456-3.com,no
a-domain123456-4.com,yes

]]>
</results>

Error Responses:

Possible error responses for this function are:

• 413 - Folder Not Found
• General errors, such as 200 - Internal Error or 300 - Username invalid.