Skip to main content
GET
/
range
Get BoosterBoxes by range or token IDs
curl --request GET \
  --url https://build.wield.xyz/vibe/boosterbox/range \
  --header 'API-KEY: <api-key>'
{
  "success": true,
  "boosterBoxes": [
    {
      "tokenId": 123,
      "contractAddress": "<string>",
      "chainId": 123,
      "owner": "<string>",
      "status": "minted",
      "rarity": 2,
      "randomValue": "<string>",
      "tokenSpecificRandomness": "<string>",
      "mintedAt": "2023-11-07T05:31:56Z",
      "openedAt": "2023-11-07T05:31:56Z",
      "latestUpdateTimestamp": "2023-11-07T05:31:56Z",
      "metadata": {
        "name": "<string>",
        "description": "<string>",
        "image": "<string>",
        "external_url": "<string>",
        "attributes": [
          {
            "trait_type": "<string>",
            "value": "<string>",
            "display_type": "<string>"
          }
        ]
      },
      "contractDetails": {
        "gameId": "<string>",
        "tokenAddress": "<string>",
        "tokenName": "<string>",
        "tokenSymbol": "<string>",
        "nftName": "<string>",
        "nftSymbol": "<string>",
        "description": "<string>",
        "imageUrl": "<string>",
        "websiteUrl": "<string>",
        "isGraduated": true,
        "marketCap": "<string>",
        "marketCapUsd": "<string>",
        "preorderProgress": 123,
        "pricePerPack": "<string>",
        "pricePerPackUsd": "<string>",
        "dropContractAddress": "<string>",
        "ownerAddress": "<string>",
        "slug": "<string>",
        "bgColor": "<string>",
        "featuredImageUrl": "<string>",
        "packImage": "<string>",
        "isActive": true,
        "isFeatured": true,
        "isVerified": true,
        "isVerifiedArtist": true,
        "disableFoil": true,
        "disableWear": true,
        "links": {
          "twitter": "<string>",
          "discord": "<string>",
          "website": "<string>"
        },
        "version": "<string>",
        "chainId": 123,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "totalPages": 123
  }
}

Headers

API-KEY
string
default:DEMO_REPLACE_WITH_FREE_API_KEY
required

Free API key needed to authorize requests. Get one at: https://docs.wield.xyz/api-reference/vibemarket-intro

Query Parameters

contractAddress
string
required

The contract address

tokenIds
string

Comma-separated list of token IDs

startTokenId
integer

Start of token ID range

endTokenId
integer

End of token ID range

chainId
integer

The chain ID

status
enum<string>

Filter by status

Available options:
minted,
rarity_assigned,
burned
rarity
integer

Filter by rarity

Required range: 0 <= x <= 4
page
integer
default:1

Page number

limit
integer
default:50

Results per page

sortBy
string
default:latestUpdateTimestamp

Sort field

sortOrder
enum<string>
default:desc

Sort order

Available options:
asc,
desc
includeMetadata
boolean
default:false

Whether to include metadata

includeContractDetails
boolean
default:false

Whether to include contract details from VibeMarketGame

Response

200 - application/json

Successful response

success
boolean
boosterBoxes
object[]
pagination
object