since 1999

Home / Documentation / API / Lots

API reference · 18.08.2026

Lots

Retrieve and search lots, read the latest bids, and manage the signed-in bidder's watchlist and consignments.

GET /v1/lots/{id}

A single lot, with its attributes.

Api-Key headeranonymous token

Anonymous. No sign-in, but this shared host cannot tell which auction house you mean, so it needs a tenant token from POST /v1/tokens/anonymous. Always send Api-Key as well.

Parameters

NameInTypeRequired
idpathinteger (int32)yes

Responses

StatusMeaningBody
200OK
GET /v1/lots

Lots, filtered.

Api-Key headeranonymous token

The lot collection, in the standard paged envelope: Items, TotalCount, Page, PageSize, TotalPages.

Filter with auctionId, categoryId, searchTerms, astartLotNumber/endLotNumber range, and sort with sort anddescending. Closed lots are excluded unless you ask for them. Everything is a query parameter, so any result is a URL you can link to, bookmark and putbehind a CDN — these responses carry no member data and cache well. For free-text search across an auction house use GET /v1/lots/search, which ranksby relevance rather than lot order.

Parameters

NameInTypeRequired
AuctionIdqueryinteger (int32)no
AuctionTypeIdqueryinteger (int32)no
CategoryIdqueryinteger (int32)no
OwnerIdqueryinteger (int32)no
HotLotquerybooleanno
SearchTermsquerystringno
Sortquerystringno
Descendingquerybooleanno
Pagequeryinteger (int32)no
PageSizequeryinteger (int32)no
LanguageCodequerystringno
ShowClosedLotsquerybooleanno
CombiIdqueryinteger (int32)no
MetaDataPropertiesqueryobjectno
vatFreequerybooleanno
StartLotNumberqueryinteger (int32)no
EndLotNumberqueryinteger (int32)no

Responses

StatusMeaningBody
200OK
GET /v1/me/watchlist

The lots the caller is watching.

Api-Key headermember token

Signed-in member. Send the token from POST /v1/sessions. Always send Api-Key as well.

Parameters

NameInTypeRequired
page
1-based page number.
queryinteger (int32)no
type
Watch type to filter by. Omit for all.
querystringno

Responses

StatusMeaningBody
200OK
PUT /v1/me/watchlist/{lotId}

Adds a lot to the caller's watchlist.

Api-Key headermember token

Idempotent, hence PUT: watching a lot twice is the same as watching it once, so a client retrying after a dropped response does not have to know which happened.

The body carries only the watch type, which decides what the member is notified about —omit it for the default. The lot comes from the URL and the member from your token. Read the list back with GET /v1/me/watchlist and remove withDELETE /v1/me/watchlist/{lotId}, which is equally safe to repeat.

Parameters

NameInTypeRequired
lotIdpathinteger (int32)yes

Request body · application/json · AddTrackerRequest

PropertyTypeRequired
Idinteger (int32)no
MemberIdinteger (int32)no

Responses

StatusMeaningBody
200OK
DELETE /v1/me/watchlist/{lotId}

Removes a lot from the caller's watchlist.

Api-Key headermember token

Signed-in member. Send the token from POST /v1/sessions. Always send Api-Key as well.

Parameters

NameInTypeRequired
lotId
The lot, not the watch record. A caller knows which lot it is looking at; it should not have to have kept hold of an internal tracker id to stop watching it.
pathinteger (int32)yes

Responses

StatusMeaningBody
200OK
GET /v1/bids/latest

HttpGet! Get list of bids

Api-Key headeranonymous token

Anonymous. No sign-in, but this shared host cannot tell which auction house you mean, so it needs a tenant token from POST /v1/tokens/anonymous. Always send Api-Key as well.

Parameters

NameInTypeRequired
OnlyOpenLotsquerybooleanno
BidTypequerystringno
Skipqueryinteger (int32)no
Takequeryinteger (int32)no
LanguageCodequerystringno
AuctionTypequeryinteger (int32)no

Responses

StatusMeaningBody
200OK
GET /v1/me/consignments

The lots the caller has consigned to an auction.

Api-Key headermember token

Signed-in member. Send the token from POST /v1/sessions. Always send Api-Key as well.

Parameters

NameInTypeRequired
auctionIdqueryinteger (int32)no

Responses

StatusMeaningBody
200OK
GET /v1/me/consignments/auctions

The auctions the caller has consigned lots to.

Api-Key headermember token

Signed-in member. Send the token from POST /v1/sessions. Always send Api-Key as well.

Responses

StatusMeaningBody
200OK
GET /v1/auctions/{id}/lot-numbers

Every lot number in an auction, for a jump-to control.

Api-Key headeranonymous token

Anonymous. No sign-in, but this shared host cannot tell which auction house you mean, so it needs a tenant token from POST /v1/tokens/anonymous. Always send Api-Key as well.

Parameters

NameInTypeRequired
idpathinteger (int32)yes

Responses

StatusMeaningBody
200OK
GET /v1/lots/{id}/documents/{fieldname}

A document attached to a lot, generated on first request if it does not exist yet.

Api-Key headeranonymous token

Anonymous. No sign-in, but this shared host cannot tell which auction house you mean, so it needs a tenant token from POST /v1/tokens/anonymous. Always send Api-Key as well.

Parameters

NameInTypeRequired
fieldnamepathstringyes
idpathinteger (int32)yes

Responses

StatusMeaningBody
200OK