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

# Get vault holdings

> Aggregated vault inventory holdings for the authenticated organization, grouped by product and variant. Quantities mirror the dashboard vault holdings table: total accepted, pending for orders, used for orders, current in vault, and available. Each holding includes estimated sell value from current orderbook bids (same logic as the dashboard Value column).

**Requires:** vault enabled on the organization.

**Rate limit:** 120 requests burst, 60 requests/minute sustained.



## OpenAPI

````yaml /api-reference/openapi.json get /vault/get-holdings/v1
openapi: 3.1.0
info:
  title: Pure Public API
  description: >-
    Public API for accessing Pure marketplace data including products, spot
    prices, and more.
  version: 2.0.0
  license:
    name: Proprietary
servers:
  - url: https://api.collectpure.com/
    description: Production server
  - url: https://sandbox.api.collectpure.com/
    description: Sandbox server
security:
  - apiKey: []
tags:
  - name: Root
    description: API information and status
  - name: Products
    description: >-
      Enriched product endpoints — full product details, search, and catalog
      metadata
  - name: Listings
    description: Listing management — create, update, deactivate, list, and view statistics
  - name: Offers
    description: Offer management — create, update, deactivate, list, and view statistics
  - name: Orders
    description: Purchase and sale order management for authenticated organizations
  - name: Marketplace
    description: Spot prices, marketplace statistics, shipping dates, and sitemap data
  - name: Organization
    description: Organization details and settings management
  - name: Inventory
    description: >-
      Inventory management — view items and aggregate statistics for your
      organization
  - name: Vault
    description: >-
      Vault shipping — intake shipments, holdings, fulfillment, and outbound
      requests
  - name: Products (Legacy)
    description: Legacy product endpoints — use the enriched Products endpoints instead
  - name: Listings (Legacy)
    description: Legacy listing endpoints — use Orderbook endpoints instead
  - name: Offers (Legacy)
    description: Legacy offer endpoints — use Orderbook endpoints instead
  - name: Execution - Buy
    description: Buy execution — quotes, payment methods, and order placement
  - name: Execution - Sell
    description: Sell execution — quotes, payout methods, and order placement
  - name: Execution
    description: Execution meta — trading status and shared execution resources
  - name: Sandbox
    description: >-
      Sandbox-only endpoints for discovering test data — not available in
      production
paths:
  /vault/get-holdings/v1:
    get:
      tags:
        - Vault
      summary: Get vault holdings
      description: >-
        Aggregated vault inventory holdings for the authenticated organization,
        grouped by product and variant. Quantities mirror the dashboard vault
        holdings table: total accepted, pending for orders, used for orders,
        current in vault, and available. Each holding includes estimated sell
        value from current orderbook bids (same logic as the dashboard Value
        column).


        **Requires:** vault enabled on the organization.


        **Rate limit:** 120 requests burst, 60 requests/minute sustained.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      holdings:
                        type: array
                        items:
                          type: object
                          properties:
                            productId:
                              type: string
                              format: uuid
                              pattern: >-
                                ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                            variantId:
                              anyOf:
                                - type: string
                                  format: uuid
                                  pattern: >-
                                    ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                                - type: 'null'
                            productTitle:
                              type: string
                            productImage:
                              anyOf:
                                - type: string
                                - type: 'null'
                            productSku:
                              type: string
                            variantTitle:
                              anyOf:
                                - type: string
                                - type: 'null'
                            totalAccepted:
                              type: number
                            fulfilled:
                              type: number
                            pending:
                              type: number
                              description: >-
                                Quantity reserved by pending fulfillment or
                                outbound requests
                            used:
                              type: number
                              description: >-
                                Quantity reserved by approved fulfillment or
                                outbound requests
                            currentInVault:
                              type: number
                              description: Total accepted minus fulfilled
                            available:
                              type: number
                              description: >-
                                Quantity available for new orders or outbound
                                requests
                            value:
                              anyOf:
                                - type: number
                                - type: 'null'
                              description: >-
                                Estimated sell value in cents at current
                                orderbook bids
                            filledQuantity:
                              anyOf:
                                - type: number
                                - type: 'null'
                              description: Quantity fillable at current orderbook bids
                          required:
                            - productId
                            - variantId
                            - productTitle
                            - productImage
                            - productSku
                            - variantTitle
                            - totalAccepted
                            - fulfilled
                            - pending
                            - used
                            - currentInVault
                            - available
                            - value
                            - filledQuantity
                          additionalProperties: false
                      summary:
                        type: object
                        properties:
                          totalShipped:
                            type: number
                          currentInVault:
                            type: number
                          pendingForOrders:
                            type: number
                          usedForOrders:
                            type: number
                          available:
                            type: number
                          totalEstimatedValue:
                            type: number
                            description: >-
                              Sum of estimated sell values across holdings with
                              bids, in cents
                          totalFillableQuantity:
                            type: number
                            description: >-
                              Sum of fillable quantities across holdings with
                              bids
                        required:
                          - totalShipped
                          - currentInVault
                          - pendingForOrders
                          - usedForOrders
                          - available
                          - totalEstimatedValue
                          - totalFillableQuantity
                        additionalProperties: false
                    required:
                      - holdings
                      - summary
                    additionalProperties: false
                required:
                  - data
                additionalProperties: false
components:
  securitySchemes:
    apiKey:
      type: apiKey
      name: x-api-key
      in: header
      description: API key for authentication

````