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

# Public card metadata

> **No key.** No scope.

Any card's metadata and image URLs, by id. **It carries no price or value of any kind.** Call it from a server: it sends no CORS header, so another site's browser JavaScript can't read the response.

Our CDN caches a `200` for up to 5 minutes and can serve it for up to a minute more while it refreshes, so a response can be up to about 7 minutes old. Errors are never cached. The limit is 60 requests a minute per IP address (an IPv4 address or an IPv6 /64), and a response from the CDN doesn't count. Send only `category` as a query parameter: anything else misses the CDN and counts against your limit.



## OpenAPI

````yaml /partner-api/openapi.yaml get /api/public/v1/cards/{id}
openapi: 3.1.0
info:
  title: CatchBack Partner API
  version: 1.0.0
  summary: Open packs, trade cards, read card data and ship vaulted cards.
  description: >-
    The Partner API acts on one CatchBack account with its real CatchCoins
    balance. Several

    operations here move money or data, so read
    [Idempotency](/partner-api/idempotency) before

    you call them.


    Error bodies are JSON with a human-readable `error` and, where you might
    branch on it, a

    machine-readable `code`. Branch on the status and the `code`, because the
    `error` text can

    change. New fields can be added to any response.
  contact:
    name: CatchBack support
    email: catchbackcards@gmail.com
servers:
  - url: https://catchbackcards.com
    description: Production. Every call acts on real money and real inventory.
security:
  - bearerAuth: []
tags:
  - name: Gacha
    description: Open packs, see what they can pull, check a pull, and sell cards back.
  - name: Marketplace
    description: Search and buy cards, and manage your own listings.
  - name: Metadata
    description: Look cards up by id or cert, with price history and recent activity.
  - name: Shipping
    description: Estimate, create and track shipments of cards you hold.
  - name: Account
    description: Your key, balance, limits, vault and order history, across every rail.
  - name: Funding
    description: Deposit and withdraw your balance in USDC.
  - name: Testing
    description: Test logins for trying CatchBack without real money.
  - name: Webhooks
    description: Signed POSTs we send to your URL when something happens on your account.
paths:
  /api/public/v1/cards/{id}:
    get:
      tags:
        - Metadata
      summary: Public card metadata
      description: >-
        **No key.** No scope.


        Any card's metadata and image URLs, by id. **It carries no price or
        value of any kind.** Call it from a server: it sends no CORS header, so
        another site's browser JavaScript can't read the response.


        Our CDN caches a `200` for up to 5 minutes and can serve it for up to a
        minute more while it refreshes, so a response can be up to about 7
        minutes old. Errors are never cached. The limit is 60 requests a minute
        per IP address (an IPv4 address or an IPv6 /64), and a response from the
        CDN doesn't count. Send only `category` as a query parameter: anything
        else misses the CDN and counts against your limit.
      operationId: getPublicCard
      parameters:
        - $ref: '#/components/parameters/CardId'
        - $ref: '#/components/parameters/LookupCategory'
      responses:
        '200':
          description: The card.
          content:
            application/json:
              schema:
                type: object
                required:
                  - card
                properties:
                  card:
                    $ref: '#/components/schemas/PublicCard'
              example:
                card:
                  id: 0e94dc61-…
                  category: pokemon
                  name: Charizard ex
                  set: Pokemon Sv3 En-Obsidian Flames
                  grading_company: PSA
                  grading_rank: 10
                  slab_label: 2023 Obsidian Flames Charizard ex
                  language: english
                  cert_number: '84512377'
                  front_image: https://…/0e94dc61-….png
                  back_image: https://…/0e94dc61-…-back.png
                  render_image: https://…/0e94dc61-…-render.png
                  image_url: https://…/0e94dc61-…-render.png
        '400':
          description: A malformed card id or an unknown `category`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Invalid card id
        '403':
          description: '`Access denied`: requests from your location are refused.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: >-
            No card has this id, in that catalog if you sent `category`, or the
            card is archived.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Card not found
        '429':
          description: >-
            `RATE_LIMITED`: over 60 requests a minute. Wait
            `retry_after_seconds`, also sent as a `Retry-After` header.
          headers:
            Retry-After:
              schema:
                type: integer
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Error'
                  - type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - RATE_LIMITED
                      retry_after_seconds:
                        type: integer
              example:
                error: Too many requests
                code: RATE_LIMITED
                retry_after_seconds: 37
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - {}
components:
  parameters:
    CardId:
      name: id
      in: path
      required: true
      description: 'A card id: `item.id` or `card_id` from any other endpoint.'
      schema:
        type: string
        pattern: ^[A-Za-z0-9_-]{1,128}$
      example: 0e94dc61-5a2f-4b1e-9c3d-7f8a1b2c3d4e
    LookupCategory:
      name: category
      in: query
      description: >-
        The card's catalog, if you know it. Without it, every catalog is
        searched.
      schema:
        $ref: '#/components/schemas/CardCategory'
  schemas:
    PublicCard:
      type: object
      description: >-
        Named fields of the card object. No price or value of any kind, and no
        goods `attributes`. A field a card's catalog doesn't have is left out. A
        field it has but we don't know is `null`.
      properties:
        id:
          type: string
        category:
          $ref: '#/components/schemas/CardCategory'
        name:
          type:
            - string
            - 'null'
        set:
          type:
            - string
            - 'null'
        year:
          type:
            - string
            - 'null'
        number:
          type:
            - string
            - 'null'
        variant:
          type:
            - string
            - 'null'
        rarity:
          type:
            - string
            - 'null'
        card_type:
          type:
            - string
            - 'null'
        language:
          type:
            - string
            - 'null'
        slab_label:
          type:
            - string
            - 'null'
        grading_company:
          type:
            - string
            - 'null'
        grading_rank:
          type:
            - number
            - 'null'
        card_condition:
          type:
            - string
            - 'null'
        cert_number:
          type:
            - string
            - 'null'
        brand:
          type:
            - string
            - 'null'
        reference_number:
          type:
            - string
            - 'null'
        video_url:
          type:
            - string
            - 'null'
        condition:
          type:
            - string
            - 'null'
        size:
          type:
            - string
            - 'null'
        description:
          type:
            - string
            - 'null'
        sport:
          type:
            - string
            - 'null'
        player_name:
          type:
            - string
            - 'null'
        team:
          type:
            - string
            - 'null'
        manufacturer:
          type:
            - string
            - 'null'
        parallel:
          type:
            - string
            - 'null'
        is_rookie:
          type:
            - boolean
            - 'null'
        is_autograph:
          type:
            - boolean
            - 'null'
        is_memorabilia:
          type:
            - boolean
            - 'null'
        serial_numbered:
          type:
            - string
            - 'null'
        front_image:
          type:
            - string
            - 'null'
        back_image:
          type:
            - string
            - 'null'
        render_image:
          type:
            - string
            - 'null'
        image_url:
          type:
            - string
            - 'null'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: >-
            For people. The text can change, so branch on the status and the
            `code`.
        code:
          type: string
          description: Machine-readable, where you might branch on it.
    CardCategory:
      type: string
      description: A card's catalog. `goods` is luxury goods and `singles` is raw singles.
      enum:
        - pokemon
        - onepiece
        - sports
        - riftbound
        - watches
        - goods
        - singles
  responses:
    ServerError:
      description: An error on our side. Retry with backoff.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: cb_live_<48 hex>
      description: >-
        Your API key, sent as a bearer token. Keep it on your server. See
        [Authentication](/partner-api/authentication). A request from a location
        we refuse gets a `403` with `Access denied`, whether or not it has a
        valid key: [where you can call
        from](/partner-api/errors-and-limits#where-you-can-call-from).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.