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

# Preview wallet allocation

> Validates explicit dollar movements and returns each affected position's value before and after. This endpoint is read-only.



## OpenAPI

````yaml swagger/swagger-combined.yaml POST /v2/wallets/{id}/allocate-preview
openapi: 3.0.0
info:
  title: Ground API
  description: Core API for portfolio wallets, deposits, withdrawals, and webhooks.
  version: 2.0.0
servers:
  - url: https://sandbox.groundtech.co
  - url: https://production.groundtech.co
security:
  - bearerAuth: []
tags:
  - name: System
    description: System health and utility endpoints.
  - name: Sandbox Faucets
    description: Sandbox-only test token faucets.
  - name: Portfolio Wallets
    description: >-
      Portfolio wallets with strategy allocation, deposits, withdrawals, and
      yield positions.
  - name: Webhook Endpoints
    description: Webhook endpoint management for portfolio wallet notifications.
paths:
  /v2/wallets/{id}/allocate-preview:
    post:
      tags:
        - Portfolio Wallets
      summary: Preview an allocation for a wallet without automatic rebalancing
      description: >-
        Validates explicit dollar movements and returns each affected position's
        value before and after. This endpoint is read-only.
      operationId: previewWalletAllocationV2
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Wallet ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AllocationPreviewRequest'
            example:
              allocations:
                - from: cash:base:usdc
                  to: morpho-gauntlet-usdc
                  amountUsd: '1000.000000'
      responses:
        '200':
          description: Allocation preview
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllocationPreview'
              example:
                positions:
                  - id: cash:base:usdc
                    label: USDC Cash
                    beforeUsd: '2500.000000'
                    afterUsd: '1500.000000'
                    deltaUsd: '-1000.000000'
                  - id: morpho-gauntlet-usdc
                    label: Morpho Gauntlet USDC Prime
                    beforeUsd: '0.000000'
                    afterUsd: '1000.000000'
                    deltaUsd: '1000.000000'
        '400':
          description: Invalid or unbalanced allocation changes
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: >-
            The wallet settings, balance, route, or current workflow prevent
            this allocation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                operation_not_supported:
                  value:
                    error: >-
                      This wallet has autoRebalance set to true. Use PATCH
                      /v2/wallets/{id}/strategy instead.
                    code: operation_not_supported
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    AllocationPreviewRequest:
      type: object
      required:
        - allocations
      additionalProperties: false
      properties:
        allocations:
          type: array
          minItems: 1
          maxItems: 100
          description: >-
            Explicit dollar movements between wallet positions and eligible
            yield sources.
          items:
            $ref: '#/components/schemas/AllocationMovementInput'
    AllocationPreview:
      type: object
      required:
        - positions
      properties:
        positions:
          type: array
          minItems: 2
          items:
            $ref: '#/components/schemas/AllocationPreviewPosition'
    ErrorResponse:
      type: object
      required:
        - error
        - code
      properties:
        error:
          type: string
          description: >-
            Human-readable error message. May change without notice; do not
            parse programmatically.
        code:
          type: string
          description: >-
            Machine-readable error code. Stable across API versions — safe to
            switch on in client code.
          enum:
            - validation_error
            - unknown_parameters
            - unsupported_chain
            - unsupported_token
            - invalid_destination_address
            - precision_overflow
            - invalid_cursor
            - unauthenticated
            - forbidden
            - wallet_not_found
            - wallet_limit_reached
            - withdrawal_not_found
            - deposit_not_found
            - yield_source_not_found
            - wallet_projection_unavailable
            - insufficient_funds
            - duplicate_request_id
            - request_id_conflict
            - invalid_position_weight
            - invalid_withdrawal_plan
            - payout_not_found
            - webhook_not_found
            - webhook_duplicate_url
            - withdrawal_not_cancellable
            - withdrawal_already_cancelled
            - withdrawal_payout_in_progress
            - withdrawal_policy_required
            - workflow_conflict
            - payout_already_terminal
            - payout_in_progress
            - payout_not_retryable
            - address_book_entry_not_found
            - address_book_duplicate_entry
            - address_book_whitelist_violation
            - rate_limited
            - rate_limit_exceeded
            - internal_error
            - wallet_creation_failed
            - service_temporarily_unavailable
    AllocationMovementInput:
      type: object
      required:
        - from
        - to
        - amountUsd
      additionalProperties: false
      properties:
        from:
          type: string
          description: Source position ID from the wallet response.
        to:
          type: string
          description: Destination ID from the wallet response or yield-source catalog.
        amountUsd:
          type: string
          pattern: ^(0|[1-9]\d*)(\.\d{1,6})?$
          description: Positive dollar amount to move, with at most six decimal places.
    AllocationPreviewPosition:
      type: object
      required:
        - id
        - label
        - beforeUsd
        - afterUsd
        - deltaUsd
      properties:
        id:
          type: string
        label:
          type: string
        beforeUsd:
          type: string
          pattern: ^(0|[1-9]\d*)\.\d{6}$
          description: >-
            Position value before the allocation, with exactly six decimal
            places.
        afterUsd:
          type: string
          pattern: ^(0|[1-9]\d*)\.\d{6}$
          description: >-
            Position value after the allocation, with exactly six decimal
            places.
        deltaUsd:
          type: string
          pattern: ^-?(0|[1-9]\d*)\.\d{6}$
          description: Signed position value change, with exactly six decimal places.
    AuthErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Authentication or authorization error message.
        message:
          type: string
          nullable: true
          description: Additional auth middleware detail, when present.
        code:
          type: string
          nullable: true
          enum:
            - unauthenticated
            - forbidden
          description: >-
            Some auth and scope failures include a stable code; middleware
            errors may omit it.
  responses:
    Unauthorized:
      description: >-
        The request is missing a valid bearer token, or the token is invalid or
        expired.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AuthErrorResponse'
          example:
            error: Unauthenticated request
            message: Missing or invalid bearer token
    NotFound:
      description: >-
        The requested resource does not exist or is not visible to the
        authenticated organization.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Portfolio wallet not found
            code: wallet_not_found
    TooManyRequests:
      description: >-
        Rate limit exceeded. Limits are enforced by API key/customer identity
        and by endpoint class. Retry with backoff; rate-limit headers are not
        currently emitted.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Rate limit exceeded
            code: rate_limited
    InternalServerError:
      description: >-
        An unexpected error occurred while processing the request. The request
        can be safely retried with the same `requestId`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Internal server error
            code: internal_error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````