Function   /buyer/auction/list

Function invocation

Function description

Returns the list of auctions where the user is bidding or watching.

Input parameters

This function takes the following input parameters:

ParameterTypeRequiredDefault valueDescription
name string "" String to be searched in domain names
size integer 5000 Paging: number of list elements
start integer 0 Paging: starting list element
state integer 0 State of auctions to show (deprecated and unused, please use 'status' parameter)
status string "active" Auction status (one of active, canceled, finished)
mystate integer 0 Select filter of auctions to show (0 - user is observer or bidder, 1 - user is observer, 2 - user is bidder, 3 - user is a bidder but not a winner, 4 - where user is winner)
order string "endtime" List sorting (can be sorted by name, bids, endtime, starttime, price, watches)

Return value

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

Field nameTypeDescription
auctionId integer Auction identifier
bids integer Number of bids in the auction
binPrice integer Auction Buy It Now price (deprecated, Buy It Now price is given in 'priceBuyNow' field)
priceBuyNow float Auction Buy It Now price
bottomPrice integer Auction bottom price for dutch auctions (deprecated and unused)
cat1 string Auction category 1
cat2 string Auction category 2
cat3 string Domain category 3
cat4 string Domain category 4
cat5 string Domain category 5
cat6 string Domain category 6
cat7 string Domain category 7
cat8 string Domain category 8
cat9 string Domain category 9
currency string Auction currency
description string Auction description
dutchAuction boolean Dutch auction (deprecated and unused)
endtime integer Auction end time as a Unix timestamp
featured boolean Auction is featured
homepage boolean Auction is promoted on homepage
internal boolean Internal domain auction (deprecated and unused)
memberId string Winning user identifer
method integer Domain transfer method (deprecated and unused)
name string Domain name (in Punycode)
utfname string Domain name (internationalized) (deprecated, this value is given in 'nameIDN' field)
nameIDN string Domain name (internationalized)
paid boolean Whether the buyer has paid for the domain (deprecated and unused)
portal boolean Marketplace portal where the auction is visible (deprecated and unused)
price float Actual auction price
private boolean Auction is private
promoted boolean Auction is promoted
reserveMet boolean Minimum price is met
reservePrice integer Auction reserve price (deprecated and unused)
priceMinimum float Auction minimum price (deprecated and unused)
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)
sellerId string Auction seller identifier
startPrice integer Auction starting price (deprecated, Start price is given in 'priceStart' field)
priceStart float Auction starting price
starttime integer Auction start time as a Unix timestamp
status string Auction status (one of active, canceled, finished)
topay boolean Whether auction has active payment (deprecated and unused)
views integer Number of auction views in past 30 days
visits integer Number of domain visits in past 30 days
watched integer Number of users who are watching the auction
hasMinimum boolean Minimum price is set
winning boolean Whether you wins the auction
myBid float Your highest bid in the auction
note string Your note to the auction
catch boolean Auction of a caught domain
minBid float Minimal amount of next bid in auction