Function /buyer/catch/list
Function invocation
https://json.aftermarket.pl/buyer/catch/list
Function description
Returns the list of user domains to catch.
Input parameters
This function takes the following input parameters:
| Parameter | Type | Required | Default value | Description |
|---|---|---|---|---|
| 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 user domains to catch (list of structures with the following fields):
| Field name | Type | Description |
|---|---|---|
| string | Expire date (deprecated, domain expiration time is given in expires field) | |
| string | Domain name (in Punycode) (deprecated, domain name in Punycode is given in 'name' field) | |
| string | Domain name (internationalized) (deprecated, domain internationalized name is given in 'nameIDN' field) | |
| name | string | Domain name (in Punycode) |
| nameIDN | string | Domain name (internationalized) |
| note | string | Domain to catch user note |
| integer | Catch priority (deprecated and unused) | |
| 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 |
| integer | To catch domain identifier (deprecated and unused) |