GET
/
api
/
auction_bids
import SnagSolutions from '@snagsolutions/sdk';

const client = new SnagSolutions({
  apiKey: process.env['X_API_KEY'], // This is the default and can be omitted
});

async function main() {
  await client.auctions.listAuctionBids();
}

main();
This response does not have an example.

Authorizations

X-API-KEY
string
header
required

Query Parameters

id
string

The bid ID

Example:

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

userId
string

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

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

ID of the organization

Example:

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

websiteId
string

ID of the website

Example:

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

auctionId
string

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"

Response

200

200