import SnagSolutions from '@snagsolutions/sdk';
const client = new SnagSolutions({
apiKey: 'My API Key',
});
const response = await client.auctions.listAuctions();
console.log(response.data);
{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"websiteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mintingContractId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reservePrice": "<string>",
"minBidIncrement": "<string>",
"minBidAmount": "<string>",
"currencyAddress": "<string>",
"loyaltyCurrencyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"currencyDecimals": 123,
"startsAt": "2023-11-07T05:31:56Z",
"endsAt": "2023-11-07T05:31:56Z",
"extendedDurationInSeconds": 123,
"hideBids": true,
"type": "first_price",
"status": "in_progress",
"biddersOwnCollectionAddresses": [
"<string>"
],
"name": "<string>",
"description": "<string>",
"network": "ethereum",
"signature": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"loyaltyCurrency": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"symbol": "<string>",
"decimals": 123,
"imageUrl": "<string>"
},
"auctionBids": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
],
"auctionItems": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sortId": 123,
"quantity": 123,
"mintingContractAsset": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
]
}
],
"hasNextPage": true
}
Returns a list of auctions with optional filtering and pagination.
import SnagSolutions from '@snagsolutions/sdk';
const client = new SnagSolutions({
apiKey: 'My API Key',
});
const response = await client.auctions.listAuctions();
console.log(response.data);
{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"websiteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mintingContractId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reservePrice": "<string>",
"minBidIncrement": "<string>",
"minBidAmount": "<string>",
"currencyAddress": "<string>",
"loyaltyCurrencyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"currencyDecimals": 123,
"startsAt": "2023-11-07T05:31:56Z",
"endsAt": "2023-11-07T05:31:56Z",
"extendedDurationInSeconds": 123,
"hideBids": true,
"type": "first_price",
"status": "in_progress",
"biddersOwnCollectionAddresses": [
"<string>"
],
"name": "<string>",
"description": "<string>",
"network": "ethereum",
"signature": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"loyaltyCurrency": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"symbol": "<string>",
"decimals": 123,
"imageUrl": "<string>"
},
"auctionBids": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
],
"auctionItems": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sortId": 123,
"quantity": 123,
"mintingContractAsset": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
]
}
],
"hasNextPage": true
}
200
Schema for the response when fetching auctions
Was this page helpful?