> ## 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 vault > **Scope:** `read:account` (needs a linked account). Cards in your vault or listed on the marketplace, one catalog per request. A sealed product (a pull from the Starter or a sealed mystery pack) isn't listed, and the API can't sell it back, list it or ship it. Each names its latest acquisition: a pull (`pull_id`) or a buy (`purchase_id`). One is set and the other is `null`, and Sell back takes whichever is set. Both can be `null` for a card that reached your account another way: read the vault again, or contact us. A pull can land in a different catalog from its pack's, so sync every category you might hold. ## OpenAPI ````yaml /partner-api/openapi.yaml get /api/partner/v1/vault 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/vault: get: tags: - Account summary: Get vault description: >- **Scope:** `read:account` (needs a linked account). Cards in your vault or listed on the marketplace, one catalog per request. A sealed product (a pull from the Starter or a sealed mystery pack) isn't listed, and the API can't sell it back, list it or ship it. Each names its latest acquisition: a pull (`pull_id`) or a buy (`purchase_id`). One is set and the other is `null`, and Sell back takes whichever is set. Both can be `null` for a card that reached your account another way: read the vault again, or contact us. A pull can land in a different catalog from its pack's, so sync every category you might hold. operationId: getVault parameters: - name: category in: query schema: allOf: - $ref: '#/components/schemas/HoldingCategory' default: pokemon - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PerPageVault' responses: '200': description: The cards you hold in this catalog. content: application/json: schema: type: object required: - category - page - per_page - total - cards properties: category: type: string page: type: integer per_page: type: integer total: type: - integer - 'null' cards: type: array items: type: object required: - card_id - pull_id - pulled_at - purchase_id - purchased_at - item - value - listed - listing_id - listing_price - catchback properties: card_id: type: string pull_id: type: - string - 'null' pulled_at: type: - string - 'null' purchase_id: type: - string - 'null' description: The buy's `transaction_id`. purchased_at: type: - string - 'null' item: $ref: '#/components/schemas/Card' value: type: - number - 'null' description: Current market value. listed: type: boolean listing_id: type: - string - 'null' description: The card's active listing while it is listed. listing_price: type: - number - 'null' catchback: type: - object - 'null' description: >- The sell-back offer right now. `null` while the card is listed, and for a luxury goods item once its 5-minute sell-back window has closed. A card we have no value for shows an `amount` of `0`. properties: amount: type: number rate: type: number basis_value: type: number description: The value the offer is based on. locked_value_until: type: - string - 'null' example: category: pokemon page: 1 per_page: 100 total: 1 cards: - card_id: 0e94dc61-… pull_id: d9504d3f-… pulled_at: '2026-09-29T19:56:28Z' purchase_id: null purchased_at: null item: id: 0e94dc61-… category: pokemon name: Greavard set: Pokemon Svi En-Scarlet & Violet grading_company: PSA grading_rank: 9 slab_label: 2023 Scarlet & Violet Greavard language: english cert_number: '84512377' market_value: 38.43 front_image: https://…/0e94dc61-….png back_image: https://…/0e94dc61-…-back.png render_image: https://…/0e94dc61-…-render.png image_url: https://…/0e94dc61-…-render.png value: 38.43 listed: false listing_id: null listing_price: null catchback: amount: 30.74 rate: 0.8 basis_value: 38.43 locked_value_until: '2026-10-06T19:56:28Z' '400': description: Unknown `category`. content: application/json: schema: $ref: '#/components/schemas/Error' '401': $ref: '#/components/responses/Unauthorized' '403': description: The key lacks `read:account` or isn't linked to an account. content: application/json: schema: $ref: '#/components/schemas/Error' '500': $ref: '#/components/responses/ServerError' security: - bearerAuth: - read:account components: schemas: HoldingCategory: type: string description: >- A catalog you can hold cards in. `goods` is luxury goods, `singles` is raw singles and `energy` is the energy cards from base packs. enum: - pokemon - onepiece - sports - riftbound - watches - goods - singles - energy Card: type: object description: >- The [card object](/partner-api/card-object). Other fields appear only on the catalogs that have them. required: - id - category - name - set - grading_company - grading_rank - slab_label - language - market_value - cert_number - front_image - back_image - render_image - image_url properties: id: type: string description: The card's id. 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' description: Printed rarity. card_type: type: - string - 'null' language: type: - string - 'null' slab_label: type: - string - 'null' description: The text on the grading label. grading_company: type: - string - 'null' grading_rank: type: - number - 'null' description: The grade. cert_number: type: - string - 'null' description: The grading company's certificate number. card_condition: type: - string - 'null' market_value: type: number description: Our current market valuation in USD. `0` when we have no valuation. price: type: - number - 'null' description: The shop sale price in USD. market_value_last_updated: type: - string - 'null' front_image: type: - string - 'null' back_image: type: - string - 'null' render_image: type: - string - 'null' image_url: type: - string - 'null' description: '`render_image`, or `front_image` when there is no render.' 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' 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' attributes: type: - object - 'null' description: Luxury goods only. Key-value details that vary by item. additionalProperties: true 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 parameters: Page: name: page in: query description: 1-based. See [Pagination](/partner-api/pagination). schema: type: integer minimum: 1 default: 1 PerPageVault: name: per_page in: query description: 1–200. A higher value is treated as 200. schema: type: integer minimum: 1 maximum: 200 default: 100 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 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.