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

# Update Orca liquidity

> Increase or decrease liquidity on an Orca CLMM collateral position while keeping the loan collateralized.



## OpenAPI

````yaml post /markets/creditbook/collateral/orca/update_liquidity
openapi: 3.1.0
info:
  title: Loopscale API
  version: 0.1.0
servers:
  - url: https://tars.loopscale.com/v1
    description: Loopscale Production Server
security: []
paths:
  /markets/creditbook/collateral/orca/update_liquidity:
    post:
      tags:
        - creditbook
      summary: Update Orca liquidity
      description: >-
        Increase or decrease liquidity on an Orca CLMM collateral position while
        keeping the loan collateralized.
      operationId: query_manage_orca_liquidity
      parameters:
        - name: User-Wallet
          in: header
          description: >-
            Base58 wallet of the acting user; the transaction is built for this
            wallet. Missing header returns 401
          required: true
          schema:
            type: string
        - name: payer
          in: header
          description: >-
            Base58 wallet that pays transaction fees; defaults to the
            `User-Wallet` wallet when omitted
          required: false
          schema:
            type:
              - string
              - 'null'
        - name: Transaction-Settings
          in: header
          description: >-
            Optional JSON-encoded transaction settings (priority-fee percentile,
            compute limits, simulation mode)
          required: false
          schema:
            type:
              - string
              - 'null'
        - name: Idempotent-Key
          in: header
          description: >-
            Optional idempotency key; a retried write with the same key replays
            the original response
          required: false
          schema:
            type:
              - string
              - 'null'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TxnManageOrcaLiquidityParams'
        required: true
      responses:
        '200':
          description: Serialized transaction message and signatures
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VersionedTransactionReturn'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Idempotency-Key reused with a different request body
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    TxnManageOrcaLiquidityParams:
      type: object
      required:
        - loan
        - positionMint
        - increase
        - manageParams
      properties:
        increase:
          type: boolean
        loan:
          type: string
        manageParams:
          $ref: '#/components/schemas/ManageLiquidityParamsSchema'
        positionMint:
          type: string
    VersionedTransactionReturn:
      type: object
      description: versioned txn return
      required:
        - message
        - signatures
      properties:
        message:
          type: string
          description: serialized message
        signatures:
          type: array
          items:
            $ref: '#/components/schemas/VersionedTransactionSignature'
          description: serialized signatures
    ErrorResponse:
      type: object
      description: |-
        Canonical error envelope for every endpoint. The `x-request-id` response
        header carries the correlation id for the failing request.
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetails'
          description: error detail
    ManageLiquidityParamsSchema:
      type: object
      description: >-
        Params for managing Orca CLMM collateral liquidity
        (`manage_orca_liquidity`).
      required:
        - collateralIndex
        - liquidityAmount
        - transferParams
        - assetIndexGuidance
      properties:
        assetIndexGuidance:
          type: array
          items:
            type: integer
            format: int32
            minimum: 0
        collateralIndex:
          type: integer
          format: int32
          minimum: 0
        liquidityAmount:
          type: integer
          minimum: 0
        transferParams:
          $ref: '#/components/schemas/TransferTypeParamsSchema'
    VersionedTransactionSignature:
      type: object
      description: versioned txn return
      required:
        - publicKey
        - signature
      properties:
        publicKey:
          type: string
          description: serialized message
        signature:
          type: string
          description: serialized signatures
    ErrorDetails:
      type: object
      description: Inner detail of the [`ErrorResponse`] envelope.
      required:
        - code
        - message
      properties:
        code:
          type: integer
          format: int32
          description: HTTP status code, mirrored in the response status line
          example: 400
          minimum: 0
        message:
          type: string
          description: human-readable, client-safe message (sensitive data redacted)
          example: Request could not be processed.
        simulation:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/SimulationDebug'
              description: >-
                Populated on transaction-generation endpoints when the
                build-path

                simulation reverts. Absent on all other error paths.
    TransferTypeParamsSchema:
      oneOf:
        - type: object
          required:
            - Liquidity
          properties:
            Liquidity:
              $ref: '#/components/schemas/LiquidityParamsSchema'
        - type: object
          required:
            - TokenAmounts
          properties:
            TokenAmounts:
              $ref: '#/components/schemas/TokenAmountsParamsSchema'
      description: >-
        How a CLMM transfer/manage sizes the position: by liquidity or by
        explicit

        token amounts (externally-tagged: `{ "Liquidity": … }` / `{
        "TokenAmounts": … }`).
    SimulationDebug:
      type: object
      description: >-
        Diagnostics attached to a build-path simulation revert so clients can
        inspect

        the exact txn that would have failed on-chain. Only populated for
        txn-gen

        endpoints; other 4xx/5xx responses omit this field.
      required:
        - decoded
        - logs
      properties:
        decoded:
          type: string
          description: >-
            Human-readable decoded error (Anchor "Error Message: ..." when
            available,

            otherwise the raw program error code or `TransactionError` debug
            form).
        logs:
          type: array
          items:
            type: string
          description: Program logs from the reverting simulation, in order.
        serializedTransaction:
          type:
            - string
            - 'null'
          description: >-
            Base64-encoded, bincode-serialized `VersionedTransaction` that was

            simulated (signatures zeroed for sig-verify-disabled simulation).

            Decode with
            `bincode::deserialize::<VersionedTransaction>(&base64_decode(..))`.
    LiquidityParamsSchema:
      type: object
      description: |-
        CLMM liquidity-management params (slippage bound), used by Orca/Raydium
        `manage_liquidity`.
      required:
        - slippageToleranceBps
      properties:
        slippageToleranceBps:
          type: integer
          format: int32
          description: Slippage tolerance, in basis points.
          minimum: 0
    TokenAmountsParamsSchema:
      type: object
      description: >-
        Explicit token-amount params for a CLMM position (Raydium / token-amount
        mode).
      required:
        - tokenAAmount
        - tokenBAmount
      properties:
        tokenAAmount:
          type: integer
          format: int64
          minimum: 0
        tokenBAmount:
          type: integer
          format: int64
          minimum: 0

````

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