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
| Name | In | Type | Required |
id | path | integer (int32) | yes |
Responses
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
| Name | In | Type | Required |
AuctionId | query | integer (int32) | no |
AuctionTypeId | query | integer (int32) | no |
CategoryId | query | integer (int32) | no |
OwnerId | query | integer (int32) | no |
HotLot | query | boolean | no |
SearchTerms | query | string | no |
Sort | query | string | no |
Descending | query | boolean | no |
Page | query | integer (int32) | no |
PageSize | query | integer (int32) | no |
LanguageCode | query | string | no |
ShowClosedLots | query | boolean | no |
CombiId | query | integer (int32) | no |
MetaDataProperties | query | object | no |
vatFree | query | boolean | no |
StartLotNumber | query | integer (int32) | no |
EndLotNumber | query | integer (int32) | no |
Responses
GET /v1/lots/search
Free-text lot search.
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
| Name | In | Type | Required |
q The search terms. | query | string | no |
page 1-based page number. | query | integer (int32) | no |
Responses
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
| Name | In | Type | Required |
page 1-based page number. | query | integer (int32) | no |
type Watch type to filter by. Omit for all. | query | string | no |
Responses
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
| Name | In | Type | Required |
lotId | path | integer (int32) | yes |
Request body · application/json · AddTrackerRequest
| Property | Type | Required |
Id | integer (int32) | no |
MemberId | integer (int32) | no |
Responses
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
| Name | In | Type | Required |
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. | path | integer (int32) | yes |
Responses
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
| Name | In | Type | Required |
OnlyOpenLots | query | boolean | no |
BidType | query | string | no |
Skip | query | integer (int32) | no |
Take | query | integer (int32) | no |
LanguageCode | query | string | no |
AuctionType | query | integer (int32) | no |
Responses
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
| Name | In | Type | Required |
auctionId | query | integer (int32) | no |
Responses
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
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
| Name | In | Type | Required |
id | path | integer (int32) | yes |
Responses
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
| Name | In | Type | Required |
fieldname | path | string | yes |
id | path | integer (int32) | yes |
Responses