since 1999

Home / Documentation / API / Auctions

API reference · 18.08.2026

Auctions

Retrieve an auction, list auctions by status, download the catalogue or a spreadsheet export, fetch translated copy, record acceptance of the terms.

GET /v1/auctions/{id}

A single auction.

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/auctions

Auctions, filtered by status.

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
status
Auction status to list, e.g. current or closed.
querystringno
page
1-based page number.
queryinteger (int32)no
pageSize
Omit to use the tenant's configured page size.
queryinteger (int32)no

Responses

StatusMeaningBody
200OK
GET /v1/auctions/{id}/catalogue

The auction catalogue as a PDF.

Api-Key headeranonymous token

Opened with a plain link, so language comes from ?lang= where a browser cannot be made to send Accept-Language.

Parameters

NameInTypeRequired
idpathinteger (int32)yes

Responses

StatusMeaningBody
200OK
GET /v1/auctions/{id}/export

The auction's lots as a spreadsheet.

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/auctions/{id}/translations

Translated copy for one auction.

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
POST /v1/auctions/{id}/terms-acceptance

Records the caller's acceptance of an auction's terms.

Api-Key headermember token

Send this once the member has agreed to the auction's terms and conditions. There is no request body — the auction comes from the URL and the member from your token.

Some auctions require accepted terms before a registration request will be granted; theterms themselves are among the documents returned byGET /v1/auctions/{id}/documents. Sending it twice is harmless.

Parameters

NameInTypeRequired
id
The auction whose terms are being accepted.
pathinteger (int32)yes

Responses

StatusMeaningBody
200Acceptance recorded.
401No member token, or the member no longer exists.