Function   /domain/list

Function invocation

Function description

It returns the list of domains on user account.

Input parameters

This function takes the following input parameters:

ParameterTypeRequiredDefault valueDescription
hidden integer 0 Show only hidden domains (0 - all, 1 - only hidden domains, 2 - only visible domains)
name string "" String to search within domain names
expiring integer 0 Show expiring (0 - all, 1 - not expiring domains, 2 - expiring domains) (deprecated, please use 'expires' parameter)
expires integer 0 Show expiring domains (0 - all, 1 - only expiring domains, 2 - only not expiring domains)
group integer 0 Show only domain groups (0 - all, 1 - only groups of domains, 2 - only not grouped domains)
leased integer 0 Show only domains which you are selling in installment transaction or lending in lease transaction (0 - all, 1 - only domain which you are selling in installment or lending, 2 - only domain which you are not selling in installment or lending)
borrowed integer 0 Show only domains which you are buying in installment transaction or borrowing in lease transaction (0 - all, 1 - only domain which you are buying in installment or borrowing, 2 - only domain which you are not buying in installment or borrowing)
type integer 0 Domain type (one of DOMAINS_TYPE_*, 0 - all domains and groups, 1 - only internal domains, 2 - only external domains) (deprecated and unused, please use 'group' parameter)
external integer 0 Show external domains (0 - all, 1 - only external domains, 2 - only internal domains)
size integer 5000 Page size
start integer 0 List start (for paging)
order string "name" List sorting (can be sorted by name, added, expires, deletion, views, parkingEarnings, contactId, watching, catching, time, cost, marketPrice, purchasePrice)

Return value

The list of domains (list of structures with the following fields):

Field nameTypeDescription
added int Domain addition time to user account
active boolean Domain is set for sale (deprecated and unused)
advertDetails string Advert details (deprecated and unused)
advertId integer Advert id (deprecated and unused)
autorenew boolean Domain autorenewal
autorenewDays integer Days before domain expires when autorenewal process starts
cat1 string Domain category 1 (deprecated and unused)
cat2 string Domain category 2 (deprecated and unused)
cat3 string Domain category 3 (deprecated and unused)
cat4 string Domain category 4 (deprecated and unused)
category string Parking category (deprecated and unused)
catching int Domain catching members
clicks integer Statistics - Click in Last 30 days (deprecated, value given in 'parkingClicks' field)
contactId integer Domain contactId
cost float Domain costs
costNet float Domain costs (net amount)
costCurrency string Domain costs currency
currency string Domain currency (deprecated and unused)
deletion integer Domain deletion time
dummy1 string Domain old category 1 (deprecated and unused)
dummy2 string Domain old category 2 (deprecated and unused)
dummy3 string Domain old category 3 (deprecated and unused)
dummy4 string Domain old category 4 (deprecated and unused)
expires integer Domain expires time
ext string Domain extension
hasOption boolean Domain has option
header string Parking header (deprecated and unused)
hidden boolean Domain is hidden in managed list
hyphens boolean Domain name contains hyphens
inGroup boolean Domain is grouped on marketplace
internal boolean Domain is internal (deprecated and unused)
isFunctional boolean Is domain functional
isGroup boolean Is group on marketplace
isRegional boolean Domain is regional
isRented boolean Domain rented or is being sold in installments to another user
keyword string Parking keyword (deprecated, value given in 'parkingKeyword' field)
length integer Domain name length
letters boolean Domain name contains letters
marketCurrency string Marketplace price currency
marketHirePlanId integer Marketplace hire plan identifier
marketMinPrice float Marketplace minimum price
marketPrice float Marketplace Buy It Now price
marketRental float Marketplace rental installment price
marketStatus string Domain status on marketplace (one of listing, auction, escrow, rental, hire, loanauction, loan, none)
marketViews integer Visits on domain offer site on marketplace in last 30 days
md5 string Domain hash (deprecated and unused)
memberId integer Domain owner identifier (deprecated and unused)
method boolean Domain selling method (deprecated and unused)
minprice integer Minimum price (deprecated, value given in 'marketMinPrice' field)
name string Domain name
nameIDN string Domain name (internationalized)
national boolean Domain name contains national signs (deprecated, value is given in 'idn' field)
idn boolean Domain name contains national signs
note string Note
ns1 string Domain name server 1
ns2 string Domain name server 2
ns3 string Domain name server 3
ns4 string Domain name server 4
numbers boolean Domain name contains numbers
offers15 integer Domain offers in last 15 days (deprecated and unused)
offers180 integer Domain offers in last 180 days (deprecated and unused)
offers30 integer Domain offers in last 30 days (deprecated and unused)
offers360 integer Domain offers in last 360 days (deprecated and unused)
offers60 integer Domain offers in last 60 days (deprecated and unused)
offers7 integer Domain offers in last 7 days (deprecated and unused)
offers90 integer Domain offers in last 90 days (deprecated and unused)
parking string Parking
parkingEarnings float Parking - Earnings in last 30 days
parkingCurrency string Parking - Earnings currency
parkingClicks integer Parking - Clicks in last 30 days
parkingViews integer Parking - Visits on site in last 30 days
parkingKeyword string Parking - Keyword
pendingOffers integer Domain pending offers
price integer Domain price (deprecated, value is given in 'marketPrice' field)
priceReseller integer Domain price on reseller sites (deprecated and unused)
private boolean Domain hidden in WHOIS
purchaseCurrency string Purchase currency
purchasePrice float Domain purchase price
purchasePriceNet float Domain purchase price (net amount)
rcurrency string Parking - Earnings currency (deprecated, this value is now given in 'parkingCurrency' field)
redirType string Redirection type
redirUrl string Redirection Url
registry string Domain registry
rentalPercent integer Rental percentage (deprecated and unused)
rentalRulesId integer Rental rules schema ID (deprecated and unused, value given in 'marketHirePlanId' field)
revenue float Parking - Earnings in last 30 days (deprecated, value is given in 'parkingEarnings' field)
source string Domain source
status string Domain sale status (deprecated, this value is now given in 'marketStatus' field)
syncedId integer Synced doamin identifier (deprecated and unused)
tags string Domain tags
template string Parking template (deprecated and unused)
time integer Domain creation time
tocatch integer Domain catching members (deprecated, value is given in 'catching' field)
utfname string Domain name (deprecated, value is given in 'nameIDN' field)
views integer Domain visits in last 30 days
watching integer Number of followers
isExternal boolean Is external domain