Function /auction/list
Function invocation
https://json.aftermarket.pl/auction/list
Function description
Returns the list of auctions listed in the marketplace. 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:
Parameter | Type | Required | Default value | Description |
---|---|---|---|---|
bids | integer | 0 | 0 - all auctions, 1 - only auctions with bids, 2 - only auctions without bids | |
integer | 0 | Catalog Id (deprecated and unused) | ||
category | string | "" | Auction category | |
endDays | integer | 0 | Number of days before end of auction | |
string | "" | Domain language (deprecated and unused) | ||
name | string | "" | String to search within domain names | |
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 | |
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 | |
tld | string | "" | Domain extension | |
priceFrom | float | 0 | Minimum domain price | |
priceTo | float | 0 | Maximum domain price | |
currency | string | "PLN" | Price filter currency | |
sellerId | string | "" | Seller identifier | |
size | integer | 5000 | Page size | |
start | integer | 0 | List start (for paging) | |
order | string | "name" | 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 name | Type | Description |
---|---|---|
auctionId | integer | Auction identifier |
bids | integer | Number of bids in the auction |
integer | Auction Buy It Now price (deprecated, Buy It Now price is given in 'priceBuyNow' field) | |
priceBuyNow | float | Auction Buy It Now price |
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 |
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 |
boolean | Internal domain auction (deprecated and unused) | |
memberId | string | Winning user identifer |
integer | Domain transfer method (deprecated and unused) | |
name | string | Domain name (in Punycode) |
string | Domain name (internationalized) (deprecated, this value is given in 'nameIDN' field) | |
nameIDN | string | Domain name (internationalized) |
boolean | Whether the buyer has paid for the domain (deprecated and unused) | |
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 |
integer | Auction reserve price (deprecated and unused) | |
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 |
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) |
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 (-1 if user hides traffic information) |
watched | integer | Number of users who are watching the auction |
hasMinimum | boolean | Minimum price is set |
minBid | float | Minimal amount of next bid in auction |
catch | boolean | Auction of a caught domain |