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

# Get account

> **Scope:** `read:account` (needs a linked account).

Your CatchCoins balance, packs used today against the daily ceiling, when the next pack purchase is allowed, and cards and card spend used today against the daily caps.



## OpenAPI

````yaml /partner-api/openapi.yaml get /api/partner/v1/account
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/partner/v1/account:
    get:
      tags:
        - Account
      summary: Get account
      description: >-
        **Scope:** `read:account` (needs a linked account).


        Your CatchCoins balance, packs used today against the daily ceiling,
        when the next pack purchase is allowed, and cards and card spend used
        today against the daily caps.
      operationId: getAccount
      responses:
        '200':
          description: The balance and limits.
          content:
            application/json:
              schema:
                type: object
                required:
                  - username
                  - balance
                  - limits
                  - card_limits
                properties:
                  username:
                    type:
                      - string
                      - 'null'
                  balance:
                    type: number
                  limits:
                    type: object
                    description: >-
                      Pack limits. `packs_today` and `packs_left_today` are
                      `null` if we can't count them just then.
                    properties:
                      packs_today:
                        type:
                          - integer
                          - 'null'
                      max_packs_per_day:
                        type: integer
                      packs_left_today:
                        type:
                          - integer
                          - 'null'
                      resets_at:
                        type: string
                        format: date-time
                      min_seconds_between_purchases:
                        type: integer
                      next_purchase_at:
                        type: string
                        format: date-time
                  card_limits:
                    type: object
                    description: >-
                      Card limits. The usage fields are `null` if we can't count
                      them just then.
                    properties:
                      cards_today:
                        type:
                          - integer
                          - 'null'
                      max_cards_per_day:
                        type: integer
                      cards_left_today:
                        type:
                          - integer
                          - 'null'
                      spend_today:
                        type:
                          - number
                          - 'null'
                      max_card_spend_per_day:
                        type: number
                      spend_left_today:
                        type:
                          - number
                          - 'null'
                      resets_at:
                        type: string
                        format: date-time
              example:
                username: acme-cards
                balance: 189953.5
                limits:
                  packs_today: 4
                  max_packs_per_day: 100
                  packs_left_today: 96
                  resets_at: '2026-09-30T00:00:00.000Z'
                  min_seconds_between_purchases: 60
                  next_purchase_at: '2026-09-29T20:24:12.000Z'
                card_limits:
                  cards_today: 3
                  max_cards_per_day: 25
                  cards_left_today: 22
                  spend_today: 4353
                  max_card_spend_per_day: 50000
                  spend_left_today: 45647
                  resets_at: '2026-09-30T00:00:00.000Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: >-
            The key lacks `read:account` or isn't linked to an account, or
            `Partner account unavailable`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: >-
            An error on our side, and the body may not be JSON. Retry with
            backoff.
      security:
        - bearerAuth:
            - read:account
components:
  responses:
    Unauthorized:
      description: A missing, malformed, disabled or unknown API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Missing or malformed API key
  schemas:
    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.
  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.