Skip to content
Highlight Docs

Get ranked-auction live standings

GET
/collection/{highlightId}/sales/{saleId}/standings

Public read-model for a ranked auction: the current clearing price and each bid’s winning/losing status (provisional while live, frozen once settled). Includes the authenticated viewer’s winning-bid count and tokens left to claim when a bearer token is supplied.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
highlightId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
saleId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Ranked auction standings

object
saleId
required
string
settled
required
boolean
clearingBidAmount
required
Any of:
string
currency
required
string
maxWinners
required
integer
<= 9007199254740991
totalBids
required
integer
<= 9007199254740991
bids
required
Array<object>
object
bidId
required
integer
>= -9007199254740991 <= 9007199254740991
bidderAddress
required
string
bidAmount
required
string
won
required
boolean
viewer
required
Any of:
object
address
required
string
numWinningBids
required
integer
<= 9007199254740991
numClaimed
required
integer
<= 9007199254740991
tokensLeftToClaim
required
integer
<= 9007199254740991

400

Section titled “400 ”

Invalid request

404

Section titled “404 ”

Not found