Function   /listing/list

Function invocation

Function description

Returns the list of domains offered for sale. The marketplace is searched according to specified criteria. All criteria are optional and can be omitted.

Input parameters

This function takes the following input parameters:

ParameterTypeRequiredDefault valueDescription
catalogId integer 0 Catalog Id
category string "" Marketplace category
endtime integer 0 Auction endtime
language string "" Domain language (deprecated and unused)
name string "" String to search within domain names (at least 3 sign should be given, otherwise parameter will be ignored)
leftAnchor boolean false Left anchor for search text
rightAnchor boolean false Right anchor for search text
lengthFrom integer 0 Minimum domain length
lengthTo integer 0 Maximum domain length
market string "" Domain market (deprecated and unused)
noHyphens boolean false Exclude domains with hyphens
noIDN boolean false Exclude IDN domains
noNumbers boolean false Exclude domains with numbers
noLetters boolean false Exclude domains with letters
onlyFeatured boolean false Show only featured domains
onlyIDN boolean false Show only IDN domains
onlyInstallments boolean false Show only domains with in installments
onlyLease boolean false Show only domains with lease
onlyPackages boolean false Show only domain packages
onlyWithOffers boolean false Show only domains which received offers
withInstallments boolean false Show only domains with installments (deprecated, please use 'onlyInstallments' parameter)
withLease boolean false Show only domains with installments (deprecated, please use 'onlyLease' parameter)
tld string "" Domain extension
priceFrom float 0 Minimum domain price
priceTo float 0 Maximum domain price
currency string "PLN" Price filter currency
negotiation boolean false With price restrictions, return only domains that have no Buy It Now price
sellerId string "" Seller identifier
what integer 0 What listings are to be shown (1 - Listing, 2 - Auction, 3 - Last Minute auction, 4 - Caught domains auction, 5 - Cheap auction (started from 1 PLN)
size integer 5000 Page size
start integer 0 List start (for paging)
order string "name" List sorting (can be sorted by name, endtime, price, offers, length, views)

Return value

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

Field nameTypeDescription
active boolean Domain is set for sale (deprecated and unused)
allegroId integer Allegro auction identifier (deprecated and unused)
auctionBids integer Number of bids in an auction (deprecated, this value is given in 'offers' field)
auctionBinPrice float Auction Buy Now price (deprecated, this value is given in 'auctionPriceBuyNow' field)
auctionPriceBuyNow float Auction Buy Now price
auctionCurrency string Auction currency (deprecated, this value is given in 'currency' field)
auctionDutch boolean Auction is dutch (deprecated and unused)
auctionEndTime integer Auction end time as an Unix timestamp
auctionId integer Auction identifier
auctionPrice float Current price in an auction (deprecated, this value is given in 'price' field)
auctionReserve boolean Auction has reserve price
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)
sellerId string Seller identifier (null if user wants to be anonymus)
saleType string Possible selling document (vat - invoice with VAT only, novat - invoice with VAT or invoice without VAT, person - invoice with VAT or sale without document)
status string Listing status (deprecated and unused)
type string Listing type (auction or listing)
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 (-1 if user hides traffic information)