Skip to main content
GET
/
api
/
auction_bids
JavaScript
import SnagSolutions from '@snagsolutions/sdk';

const client = new SnagSolutions({
  apiKey: 'My API Key',
});

const response = await client.auctions.listAuctionBids();

console.log(response.data);
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": "<any>",
      "status": "submitted",
      "auctionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "auctionItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "currencyAddress": "<string>",
      "currencyDecimals": 123,
      "updatedAt": "2023-11-07T05:31:56Z",
      "auctionItem": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "quantity": 123,
        "mintingContractAsset": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "isPhygitalItem": true,
          "shippingPrice": "<any>",
          "tokenId": 123,
          "revealedAt": "2023-11-07T05:31:56Z"
        }
      },
      "user": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "walletAddress": "<string>"
      },
      "loyaltyCurrency": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "symbol": "<string>",
        "decimals": 123,
        "imageUrl": "<string>",
        "apiGetUrl": "<string>",
        "apiGetTransactionEntryUrl": "<string>",
        "apiPostUrl": "<string>",
        "apiAuthType": "none",
        "apiAuthKey": "<string>",
        "apiAuthValue": "<string>"
      }
    }
  ],
  "hasNextPage": true
}

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
id
string<uuid>

The bid ID

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"

Response

200

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

Indicates if there is a next page of results