Skip to main content
GET
Get auction bids

Authorizations

X-API-KEY
string
header
required

Query Parameters

id

The bid ID(s) - accepts a single ID or an array of IDs

Example:

"123e4567-e89b-12d3-a456-426614174010"

userId
string<uuid>

ID of the user who made the bid

Example:

"123e4567-e89b-12d3-a456-426614174001"

walletAddress
string

Wallet address of the bidder

Example:

"0x1234567890abcdef1234567890abcdef12345678"

startingAfter
string<uuid>

Pagination cursor to start after a specific bid ID

Example:

"123e4567-e89b-12d3-a456-426614174020"

limit
integer

Maximum number of bids to return

Required range: 1 <= x <= 1000
Example:

50

organizationId
string<uuid>

ID of the organization

Example:

"123e4567-e89b-12d3-a456-426614174002"

websiteId
string<uuid>

ID of the website

Example:

"123e4567-e89b-12d3-a456-426614174003"

auctionId
string<uuid>

ID of the auction

Example:

"123e4567-e89b-12d3-a456-426614174004"

status
enum<string>

Status of the bid

Available options:
submitted,
accepted,
rejected,
fulfilled
Example:

"PENDING"

orderBy
enum<string>

Order bids by amount (ascending or descending). Defaults to desc.

Available options:
asc,
desc
Example:

"desc"

skip
integer | null

Number of bids to skip (for offset-based pagination)

Required range: x >= 0
Example:

1999

includeCount
boolean | null

Include total count of matching bids in response

Example:

true

statuses
enum<string>[]

Filter by multiple bid statuses (OR condition)

Available options:
submitted,
accepted,
rejected,
fulfilled
Example:

Response

200

data
Get Auction Bids Response Schema · object[]
required
hasNextPage
boolean
required

Indicates if there is a next page of results

count
number

Total count of matching bids (only present when includeCount=true)