> ## 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.

# Resolve rarity assignments from a transaction

> Parses pack token IDs and rarity assignments from a transaction receipt.
A missing receipt or still-pending assignment is represented by HTTP 200;
inspect `receiptFound`, `rarityCode`, and `isPending`.




## OpenAPI

````yaml /api-reference/vibemarket_openapi.yml get /rarity
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:
  /rarity:
    get:
      tags:
        - Packs
        - Activity
      summary: Resolve rarity assignments from a transaction
      description: >
        Parses pack token IDs and rarity assignments from a transaction receipt.

        A missing receipt or still-pending assignment is represented by HTTP
        200;

        inspect `receiptFound`, `rarityCode`, and `isPending`.
      operationId: getVibeMarketRarityByTransaction
      parameters:
        - in: query
          name: transactionHash
          required: true
          schema:
            $ref: '#/components/schemas/TransactionHash'
        - in: query
          name: contractAddress
          required: true
          schema:
            $ref: '#/components/schemas/EvmAddress'
      responses:
        '200':
          description: Receipt and rarity parsing result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RarityResponse'
        '400':
          $ref: '#/components/responses/InvalidInput'
        '429':
          $ref: '#/components/responses/ApiKeyOrRateLimit'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    TransactionHash:
      type: string
      pattern: ^0x[a-fA-F0-9]{64}$
      example: '0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'
    EvmAddress:
      type: string
      pattern: ^0x[a-fA-F0-9]{40}$
      example: '0x1111111111111111111111111111111111111111'
    RarityResponse:
      type: object
      required:
        - success
        - parsedTokenData
        - tokenIds
        - rarityInfo
        - receiptFound
      properties:
        success:
          type: boolean
          enum:
            - true
        parsedTokenData:
          type: object
          additionalProperties: true
          nullable: true
        tokenIds:
          type: array
          items:
            type: string
            pattern: ^[0-9]+$
        rarityInfo:
          allOf:
            - $ref: '#/components/schemas/RarityInfo'
          nullable: true
        receiptFound:
          type: boolean
        error:
          type: string
    RarityInfo:
      type: object
      required:
        - tokenId
        - rarityCode
        - rarity
      properties:
        tokenId:
          type: integer
          minimum: 0
        rarityCode:
          type: integer
          minimum: -1
          maximum: 5
          description: '-1 pending, 0 None, 1 Common, 2 Rare, 3 Epic, 4 Legendary, 5 Mythic.'
        rarity:
          type: string
          enum:
            - None
            - Common
            - Rare
            - Epic
            - Legendary
            - Mythic
            - Pending
            - Unknown
        randomValue:
          type: string
          nullable: true
        isPending:
          type: boolean
        message:
          type: string
    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
  responses:
    InvalidInput:
      description: Invalid or incomplete request input
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            message: Invalid contract address
    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.

````