Skip to main content
GET
/
range
Get BoosterBoxes by range or token IDs
curl --request GET \
  --url https://build.vibechain.com/vibe/boosterbox/range \
  --header 'API-KEY: <api-key>'
import requests

url = "https://build.vibechain.com/vibe/boosterbox/range"

headers = {"API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'API-KEY': '<api-key>'}};

fetch('https://build.vibechain.com/vibe/boosterbox/range', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://build.vibechain.com/vibe/boosterbox/range",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://build.vibechain.com/vibe/boosterbox/range"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("API-KEY", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://build.vibechain.com/vibe/boosterbox/range")
.header("API-KEY", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://build.vibechain.com/vibe/boosterbox/range")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "success": true,
  "boosterBoxes": [
    {
      "tokenId": 123,
      "contractAddress": "<string>",
      "chainId": 123,
      "owner": "<string>",
      "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.vibechain.com/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