> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vibechain.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get one pack

> Returns one pack by contract and token ID, with optional metadata and game details.



## OpenAPI

````yaml /api-reference/vibemarket_openapi.yml get /
openapi: 3.0.3
info:
  title: vibe.market API
  version: 1.0.0
  description: |
    Production API for vibe.market packs, games, collections, creator drafts,
    allowlists, market activity, social features, recovery tools, and analytics.

    Most operations require a caller-specific VibeChain API key in the
    `API-KEY` header. Account-bound writes additionally require a vibe.market
    session token in `Authorization: Bearer <token>`. Public or Bearer-only
    exceptions are marked on the individual operation.
  contact:
    name: VibeChain developer support
    email: gm@vibechain.com
    url: https://docs.vibechain.com/api-reference/vibemarket-intro
servers:
  - url: https://build.vibechain.com/vibe/boosterbox
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Packs
    description: Read pack ownership, state, rarity, and metadata.
  - name: Collections
    description: Read collection holdings, statistics, and activity.
  - name: Games
    description: Discover games and read launch configuration.
  - name: Metadata
    description: Read published metadata and update launched collections.
  - name: Creator drafts
    description: Create, autosave, inspect, confirm, and delete launch drafts.
  - name: Allowlists
    description: Configure draft allowlists and generate Merkle proofs.
  - name: Activity
    description: Read recent packs and recover indexed transaction events.
  - name: Social
    description: Read chat, react to messages, and report collections.
  - name: Analytics
    description: Read price history, leaderboards, and platform totals.
  - name: Utility
    description: Resolve slugs, regions, prices, and processing readiness.
paths:
  /:
    get:
      tags:
        - Packs
      summary: Get one pack
      description: >-
        Returns one pack by contract and token ID, with optional metadata and
        game details.
      operationId: getVibeMarketPack
      parameters:
        - $ref: '#/components/parameters/ContractAddressQuery'
        - $ref: '#/components/parameters/TokenIdQuery'
        - $ref: '#/components/parameters/ChainId'
        - $ref: '#/components/parameters/IncludeMetadata'
        - $ref: '#/components/parameters/IncludeContractDetails'
        - $ref: '#/components/parameters/BypassImageProxy'
      responses:
        '200':
          description: The requested pack
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - boosterBox
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  boosterBox:
                    $ref: '#/components/schemas/BoosterBox'
        '400':
          $ref: '#/components/responses/InvalidInput'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/ApiKeyOrRateLimit'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    ContractAddressQuery:
      in: query
      name: contractAddress
      required: true
      schema:
        $ref: '#/components/schemas/EvmAddress'
    TokenIdQuery:
      in: query
      name: tokenId
      required: true
      schema:
        type: integer
        minimum: 0
    ChainId:
      in: query
      name: chainId
      description: EVM chain ID. Defaults to Base mainnet.
      schema:
        type: integer
        minimum: 1
        default: 8453
    IncludeMetadata:
      in: query
      name: includeMetadata
      schema:
        type: boolean
        default: false
    IncludeContractDetails:
      in: query
      name: includeContractDetails
      schema:
        type: boolean
        default: false
    BypassImageProxy:
      in: header
      name: X-Bypass-Image-Proxy
      description: >-
        Set to `true` to keep original recognized CDN URLs instead of
        vibe.market proxy URLs. Cache this response variant separately.
      schema:
        type: boolean
        default: false
  schemas:
    BoosterBox:
      type: object
      required:
        - tokenId
        - owner
        - contractAddress
        - chainId
        - status
        - rarity
      additionalProperties: true
      properties:
        tokenId:
          type: integer
          minimum: 0
        owner:
          $ref: '#/components/schemas/EvmAddress'
        contractAddress:
          $ref: '#/components/schemas/EvmAddress'
        chainId:
          type: integer
          example: 8453
        status:
          $ref: '#/components/schemas/PackStatus'
        batchId:
          type: string
        rarity:
          $ref: '#/components/schemas/RarityCode'
        rarityName:
          $ref: '#/components/schemas/RarityName'
        tokenSeed:
          type: string
        randomValue:
          type: string
        mintTxHash:
          $ref: '#/components/schemas/TransactionHash'
        burnTxHash:
          $ref: '#/components/schemas/TransactionHash'
        rarityAssignedTxHash:
          $ref: '#/components/schemas/TransactionHash'
        openedTxHash:
          $ref: '#/components/schemas/TransactionHash'
        mintBlockNumber:
          type: integer
        burnBlockNumber:
          type: integer
        rarityAssignedBlockNumber:
          type: integer
        openedBlockNumber:
          type: integer
        rewardAmount:
          $ref: '#/components/schemas/Wei'
        acquiredAtPackPrice:
          $ref: '#/components/schemas/Wei'
        mintTimestamp:
          type: string
          format: date-time
        burnTimestamp:
          type: string
          format: date-time
        rarityAssignedTimestamp:
          type: string
          format: date-time
        openedTimestamp:
          type: string
          format: date-time
        latestUpdateTimestamp:
          type: string
          format: date-time
        isVibefit:
          type: boolean
        isFirstEdition:
          type: boolean
        metadata:
          $ref: '#/components/schemas/MetadataItem'
        contract:
          $ref: '#/components/schemas/Game'
        userData:
          $ref: '#/components/schemas/UserSummary'
    EvmAddress:
      type: string
      pattern: ^0x[a-fA-F0-9]{40}$
      example: '0x1111111111111111111111111111111111111111'
    PackStatus:
      type: string
      enum:
        - minted
        - opened
        - rarity_assigned
        - burned
    RarityCode:
      type: integer
      minimum: 0
      maximum: 5
      description: 0 not assigned, 1 Common, 2 Rare, 3 Epic, 4 Legendary, 5 Mythic.
    RarityName:
      type: string
      enum:
        - NOT_ASSIGNED
        - COMMON
        - RARE
        - EPIC
        - LEGENDARY
        - MYTHIC
        - UNKNOWN
    TransactionHash:
      type: string
      pattern: ^0x[a-fA-F0-9]{64}$
      example: '0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'
    Wei:
      type: string
      pattern: ^[0-9]+$
      description: Unsigned integer amount denominated in Wei.
      example: '1000000000000000'
    MetadataItem:
      allOf:
        - $ref: '#/components/schemas/MetadataItemInput'
        - type: object
          additionalProperties: true
          properties:
            id:
              type: string
            contractAddress:
              $ref: '#/components/schemas/EvmAddress'
            chainId:
              type: integer
            txHash:
              $ref: '#/components/schemas/TransactionHash'
            creator:
              $ref: '#/components/schemas/EvmAddress'
            metadataSource:
              type: string
              enum:
                - user
                - default
            isActive:
              type: boolean
            isDraft:
              type: boolean
            version:
              type: integer
            effectiveFrom:
              type: string
              format: date-time
            effectiveUntil:
              type: string
              format: date-time
              nullable: true
            bgColor:
              type: string
            slug:
              type: string
            featuredImageUrl:
              type: string
              format: uri
            disableFoil:
              type: boolean
            disableWear:
              type: boolean
            odds:
              type: number
              format: double
            oddsFormatted:
              type: string
            wear:
              $ref: '#/components/schemas/Wear'
            foil:
              $ref: '#/components/schemas/Foil'
    Game:
      type: object
      required:
        - gameId
        - tokenAddress
        - nftName
        - nftSymbol
        - ownerAddress
        - chainId
      additionalProperties: true
      properties:
        gameId:
          type: string
        tokenAddress:
          $ref: '#/components/schemas/EvmAddress'
        tokenName:
          type: string
        tokenSymbol:
          type: string
        nftName:
          type: string
        nftSymbol:
          type: string
        description:
          type: string
        imageUrl:
          type: string
          format: uri
        websiteUrl:
          type: string
          format: uri
        isGraduated:
          type: boolean
        marketCap:
          $ref: '#/components/schemas/Wei'
        marketCapUsd:
          description: Formatted USD value returned by the market service.
          oneOf:
            - type: string
            - type: number
        preorderProgress:
          type: number
          minimum: 0
          maximum: 100
        bgColor:
          type: string
        featuredImageUrl:
          type: string
          format: uri
        slug:
          type: string
        ownerAddress:
          $ref: '#/components/schemas/EvmAddress'
        pricePerPack:
          $ref: '#/components/schemas/Wei'
        pricePerPackUsd:
          oneOf:
            - type: string
            - type: number
        dropContractAddress:
          $ref: '#/components/schemas/EvmAddress'
        chainId:
          type: integer
          example: 8453
        disableFoil:
          type: boolean
        disableWear:
          type: boolean
        packImage:
          type: string
          format: uri
        isActive:
          type: boolean
        links:
          $ref: '#/components/schemas/LinkSet'
        isNSFW:
          type: boolean
        isVerified:
          type: boolean
        isVerifiedArtist:
          type: boolean
        isFeatured:
          type: boolean
        isVibefit:
          type: boolean
        version:
          type: integer
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        potentialCards:
          type: array
          items:
            $ref: '#/components/schemas/MetadataItem'
    UserSummary:
      type: object
      additionalProperties: true
      properties:
        id:
          type: string
        username:
          type: string
        displayName:
          type: string
        profileImage:
          type: string
          format: uri
        address:
          $ref: '#/components/schemas/EvmAddress'
    Error:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          enum:
            - false
        message:
          type: string
        error:
          description: >-
            Optional diagnostic detail. Do not depend on this field being
            present in production.
          oneOf:
            - type: string
            - type: object
              additionalProperties: true
    MetadataItemInput:
      type: object
      required:
        - name
        - imageUrl
        - rarity
      properties:
        name:
          type: string
          minLength: 1
        imageUrl:
          type: string
          format: uri
        unopenedImageUrl:
          type: string
          format: uri
        firstEditionImageUrl:
          type: string
          format: uri
        description:
          type: string
        rarity:
          $ref: '#/components/schemas/CardRarity'
        externalLink:
          type: string
          format: uri
        privateExternalLink:
          type: string
          format: uri
        metadataDescription:
          type: string
        traits:
          type: array
          maxItems: 20
          items:
            $ref: '#/components/schemas/Trait'
        startId:
          type: integer
          minimum: 0
        endId:
          type: integer
          minimum: 0
    Wear:
      type: string
      enum:
        - Pristine
        - Mint
        - Lightly Played
        - Moderately Played
        - Heavily Played
    Foil:
      type: string
      enum:
        - None
        - Standard
        - Prize
        - Any Foil
    LinkSet:
      type: object
      properties:
        twitter:
          type: string
          format: uri
        website:
          type: string
          format: uri
    CardRarity:
      type: string
      enum:
        - Common
        - Rare
        - Epic
        - Legendary
        - Mythic
    Trait:
      type: object
      required:
        - key
        - value
      properties:
        key:
          type: string
          maxLength: 100
        value:
          type: string
          maxLength: 100
  responses:
    InvalidInput:
      description: Invalid or incomplete request input
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            message: Invalid contract address
    NotFound:
      description: Requested resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            message: Resource not found
    ApiKeyOrRateLimit:
      description: API key missing/invalid or the caller's rate allowance is exhausted
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            message: >-
              Too many requests or invalid API key! See docs.vibechain.com for
              more info.
    InternalError:
      description: The server could not complete the operation
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            message: Failed to complete request
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: API-KEY
      description: Caller-specific VibeChain API key used for quota and abuse control.

````