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
| Name | In | Type | Required |
id | path | integer (int32) | yes |
Responses
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
| Name | In | Type | Required |
status Auction status to list, e.g. current or closed. | query | string | no |
page 1-based page number. | query | integer (int32) | no |
pageSize Omit to use the tenant's configured page size. | query | integer (int32) | no |
Responses
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
| Name | In | Type | Required |
id | path | integer (int32) | yes |
Responses
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
| Name | In | Type | Required |
id | path | integer (int32) | yes |
Responses
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
| Name | In | Type | Required |
id | path | integer (int32) | yes |
Responses
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
| Name | In | Type | Required |
id The auction whose terms are being accepted. | path | integer (int32) | yes |
Responses
| Status | Meaning | Body |
200 | Acceptance recorded. | — |
401 | No member token, or the member no longer exists. | — |