> ## 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 OpenSea-compatible collection metadata

> Public collection metadata for a game slug. The response is an OpenSea
collection object, not a vibe.market success envelope, and is cached
for about five minutes.




## OpenAPI

````yaml /api-reference/vibemarket_openapi.yml get /metadata/{slugOrContractAddress}
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:
  /metadata/{slugOrContractAddress}:
    get:
      tags:
        - Metadata
      summary: Get OpenSea-compatible collection metadata
      description: |
        Public collection metadata for a game slug. The response is an OpenSea
        collection object, not a vibe.market success envelope, and is cached
        for about five minutes.
      operationId: getVibeMarketOpenSeaCollectionMetadata
      parameters:
        - in: path
          name: slugOrContractAddress
          required: true
          description: Game slug for this GET operation.
          schema:
            type: string
        - $ref: '#/components/parameters/BypassImageProxy'
      responses:
        '200':
          description: OpenSea-compatible collection metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenSeaCollectionMetadata'
        '400':
          $ref: '#/components/responses/InvalidInput'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/PublicRateLimit'
        '500':
          $ref: '#/components/responses/InternalError'
      security: []
components:
  parameters:
    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:
    OpenSeaCollectionMetadata:
      type: object
      required:
        - name
        - description
        - image
        - seller_fee_basis_points
        - fee_recipient
      properties:
        name:
          type: string
        description:
          type: string
        image:
          type: string
          format: uri
        banner_image:
          type: string
          format: uri
        featured_image:
          type: string
          format: uri
        external_link:
          type: string
          format: uri
        seller_fee_basis_points:
          type: integer
          enum:
            - 0
        fee_recipient:
          $ref: '#/components/schemas/EvmAddress'
    EvmAddress:
      type: string
      pattern: ^0x[a-fA-F0-9]{40}$
      example: '0x1111111111111111111111111111111111111111'
    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
    NotFound:
      description: Requested resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            message: Resource not found
    PublicRateLimit:
      description: Public per-IP rate allowance exhausted
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            message: Too many requests! 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.

````