Function   /buyer/caught/list

Function invocation

Function description

Returns list of domains caught for user.

Input parameters

This function takes the following input parameters:

ParameterTypeRequiredDefault valueDescription
name string "" String to be searched in domain names
order string "name" List sorting (can be sorted by name, expires, time)
size integer 5000 Paging: number of list elements
start integer 0 Paging: starting list element

Return value

List of domains caught for user (list of structures with the following fields):

Field nameTypeDescription
name string Domain name (in Punycode)
nameIDN string Domain name (internationalized)
note string Domain to catch user note
status string Domain status (one of pending, topay, auction, paid, otheruser, unpaid)
time integer Time as Unix timestamp when domain was added to catch
expires integer Domain expiration time as Unix timestamp