Function   /seller/listing/list

Function invocation

Function description

Returns the list of domains for sale listed on user account.

Input parameters

This function takes the following input parameters:

ParameterTypeRequiredDefault valueDescription
active integer 0 Group filter: 0 - all, 1 - active only, 2 - inactive only
group integer 0 Group filter: 0 - all, 1 - groups only, 2 - without groups
idn integer 0 IDN filter: 0 - all, 1 - IDN domain only, 2 - non-IDN domain only
name string "" String to search within domain names
order string "name" List sorting (can be sorted by name, time, price, offers, visits)
search string "" Text to be searched within domain names (deprecated and unused, please use 'name' parameter)
size integer 5000 Page size
start integer 0 List start (for paging)
sort integer 0 Sort type (deprecated and unused, please use 'order' parameter)
what integer 0 Type of domains for search (deprecated and unused, please use 'active' parameter)
where integer 0 Scope of search (deprecated and unused, please use 'group' paramater)

Return value

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

Field nameTypeDescription
active boolean Domain is set for sale
allegroId integer Allegro auction identifier (deprecated and unused)
auctionBids integer Number of bids in an auction (deprecated and unused)
auctionBinPrice integer Auction Buy Now price (deprecated and unused)
auctionCurrency string Auction currency (deprecated and unused)
auctionDutch boolean Auction is dutch (deprecated and unused)
auctionEndTime integer Auction end time as an Unix timestamp (deprecated and unused)
auctionId integer Auction identifier (deprecated and unused)
auctionPrice integer Current price in an auction (deprecated and unused)
auctionReserve boolean Auction has reserve price (deprecated and unused)
auctionStartTime integer Auction start time as an Unix timestamp (deprecated and unused)
buyNowURL string External Buy It Now URL (deprecated and unused)
cat1 string Category 1
cat2 string Category 2
cat3 string Category 3
cat4 string Category 4
cat5 string Category 5
cat6 string Category 6
cat7 string Category 7
cat8 string Category 8
cat9 string Category 9
cat1Editable boolean Category 1 editable (deprecated and unused)
cat2Editable boolean Category 2 editable (deprecated and unused)
cat3Editable boolean Category 3 editable (deprecated and unused)
cat4Editable boolean Category 4 editable (deprecated and unused)
categoriesEditable string Categories editable (deprecated and unused)
currency string Listing currency
earnings float Earnings
earningsCurrency string Earnings currency
featured boolean Listing is featured
groupSaleId integer Group sale ID (deprecated and unused)
homepage boolean Domain is promoted on homepage
internal boolean Is domain registered with (deprecated and unused)
listingId integer Listing identifier
makeOfferURL string External Make Offer Url (deprecated and unused)
method integer Domain transfer method (deprecated and unused)
minprice float Minimum price (deprecated, offer minimum price is now given in 'priceMinimum' field)
priceMinimum float Minimum price (only for listings)
name string Domain name
nameIDN string Domain name (internationalized)
note string Domain description
offers integer Number of received offers
pendingRental integer The domain is currently being rented (deprecated and unused)
portal string Marketplace portal where the auction is visible (deprecated and unused)
price float Current domain price
priceReseller integer Domain price on reseller sites (deprecated and unused)
priceRental float Monthly rental cost
hirePlanId integer Hire plan identifier
saleType boolean Sale document type (vat - invoice with VAT only, novat - invoice with VAT or invoice without VAT, person - invoice with VAT or sale without document)
sellerId string Seller identifier
status string Listing status (deprecated and unused)
time integer Listing date as an Unix timestamp
typo string Domain typo detection (deprecated and unused)
utfname string Domain name (internationalized) (deprecated, this value is given in 'nameIDN' field)
views integer Number of listing views in past 30 days
visits integer Number of domain visits in past 30 days