Auction
Get auctions
API Documentation
Identity
- POSTCreate user device
- GETGet user metadata
- POSTCreate user metadata
- GETGet users
- GETUser count
- POSTConnect a user to User Group
- POSTDisconnect a user from User Group
- GETConnect Auth
- POSTPost apiusersverify
- GETGet all website user attributes
- POSTCreate a new website user attribute
- DELDelete a website user attribute
- GETGet all website user attribute values
- POSTCreate a new website user attribute value
Loyalty
- GETGet loyalty accounts
- GETGet the rank of a user based on their loyalty points
- GETGet loyalty currencies
- POSTCreate a loyalty currency
- GETGet Loyalty Multipliers
- POSTCreate Loyalty Multiplier
- DELDelete Loyalty Multiplier by External Identifier
- POSTUpdate Loyalty Multiplier
- DELDelete Loyalty Multiplier by ID
- GETGet Loyalty Rule Edits
- POSTRestore Loyalty Rule Edit
- GETGet Loyalty Rule Groups
- POSTCreate Loyalty Rule Groups
- POSTUpdate Loyalty Rule Group
- DELDelete Loyalty Rule Group
- GETGet Loyalty Rules
- POSTCreate Loyalty Rule
- POSTUpdate Loyalty Rule
- DELDelete Loyalty Rule
- POSTComplete Loyalty Rule
- GETGet Processing status for a specific user on loyalty rules
- POSTCreate Loyalty Transaction
- GETGet Loyalty Transaction Entries
- GETGet Loyalty Rule Chains
- GETGet Loyalty Rule Statuses
- POSTUpdate Loyalty Rule Status
Badge
Minting
Question
Website
Landing Page
Auction
Get auctions
Returns a list of auctions with optional filtering and pagination.
GET
/
api
/
auctions
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() {
const response = await client.auctions.listAuctions();
console.log(response.data);
}
main();
{
"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
}
Authorizations
Response
200
application/json
200
Schema for the response when fetching auctions
Available options:
first_price
, second_price
, english
Available options:
in_progress
, completed
, cancelled
Available options:
ethereum
, zksync
Was this page helpful?
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() {
const response = await client.auctions.listAuctions();
console.log(response.data);
}
main();
{
"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
}