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

# List Amplify vaults

> Returns aggregated vault configuration grouped by vault name: chain deployments (contract addresses, KYT flag, deposit supply cap, minimum withdrawal order size, in-deprecation flag) with nested per-asset config (depositable/withdrawable flags, deposit/withdraw fees, withdrawal SLAs).



## OpenAPI

````yaml /v1.0.0/api-reference/openapi.yml get /v2/amplify/vaults
openapi: 3.0.0
info:
  title: Paxos Labs API
  description: >
    Paxos Labs API V2.


    ---


    # API overview


    This document describes shared behavior and conventions for the Paxos Labs
    API (REST and GraphQL).


    <details>

    <summary><strong>Health check</strong></summary>


    A **health** endpoint is available for orchestrators (GitHub Actions, etc).


    | Item         |
    Details                                                                                
    |

    | ------------ |
    ---------------------------------------------------------------------------------------
    |

    | **Path**     | `GET /health` (no version prefix; no API key or rate limit
    applied).                    |

    | **Response** | `200` with Terminus-style JSON when healthy; `503` when
    unhealthy (e.g. database down). |


    **Docker / healthcheck:** If your healthcheck uses `curl` (e.g. `curl -f
    http://localhost:3000/health`), ensure your image has curl installed. Base
    images like `node:bullseye-slim` or `node:alpine` do not—install it (e.g.
    `RUN apk add --no-cache curl` for Alpine).


    </details>


    <details>

    <summary><strong>GraphQL endpoint</strong></summary>


    A **GraphQL** API is available in addition to REST. Use it to query address
    book and vault data with a single request and flexible field selection.


    | Item                         |
    Details                                                              |

    | ---------------------------- |
    -------------------------------------------------------------------- |

    | **Altair (interactive IDE)** |
    [https://api.paxoslabs.com/altair](https://api.paxoslabs.com/altair) |

    | **GraphQL endpoint**         | Same base URL with path `/graphql` for
    POST.                         |

    | **Authentication**           | Same as REST: send `x-api-key`
    header.                               |


    Open the Altair link in a browser to explore the schema and run queries.


    </details>


    <details>

    <summary><strong>Filter query parameter syntax</strong></summary>


    List endpoints that support a `filter` query parameter use a single string
    with **keys**, **operators**, and **combinators**. This keeps the number of
    query params small (AIP-160 style) while allowing flexible filtering.


    <details>

    <summary><strong>Operators</strong></summary>


    | Operator | Meaning    | Example            |

    | -------- | ---------- | ------------------ |

    | `=`      | Equals     | `chainId=1`        |

    | `!=`     | Not equals | `status!=REFUNDED` |


    </details>


    <details>

    <summary><strong>Combinators</strong></summary>


    | Combinator | Meaning                                      |
    Example                         |

    | ---------- | -------------------------------------------- |
    ------------------------------- |

    | `AND`      | All conditions must match (case-insensitive) | `chainId=1 AND
    name="Treasury"` |

    | `OR`       | Any condition may match (case-insensitive)   | `chainId=1 OR
    chainId=137`      |


    </details>


    <details>

    <summary><strong>Value formatting</strong></summary>


    | Type     | Use case                                  |
    Example                   |

    | -------- | ----------------------------------------- |
    ------------------------- |

    | Unquoted | Numbers, booleans, single-token values    | `chainId=1`,
    `valid=true` |

    | Quoted   | Strings with spaces or special characters | `name="Treasury
    Wallet"`  |

    | Escape   | Literal quote inside a quoted string      |
    `\"`                      |


    Allowed **keys** and **value types** (number, hex address, string, etc.) are
    defined per endpoint in the API docs and validated by the server.


    </details>


    <details>

    <summary><strong>Possible combinations (examples)</strong></summary>


    | Category              |
    Example                                             |

    | --------------------- |
    --------------------------------------------------- |

    | Single condition      |
    `chainId=1`                                         |

    | Single condition      |
    `status!=REFUNDED`                                  |

    | AND                   | `chainId=1 AND
    name="Treasury"`                     |

    | AND                   | `vaultAddress=0x123... AND
    chainId=1`               |

    | OR                    | `chainId=1 OR
    chainId=137`                          |

    | OR                    | `status=PENDING OR
    status=COMPLETE`                 |

    | Mixed AND and OR      | `chainId=1 AND (status=PENDING OR
    status=COMPLETE)` |

    | Equals and not-equals | `chainId=1 AND
    status!=REFUNDED`                    |

    | Equals and not-equals |
    `name!=""`                                          |


    Mixed AND and OR: AND has higher precedence; use parentheses for grouping.
    Without grouping, evaluation is left-to-right per implementation.


    </details>


    <details>

    <summary><strong>Implementation note</strong></summary>


    | Item      |
    Details                                                                   |

    | --------- |
    ------------------------------------------------------------------------- |

    | Location  |
    `src/common/utils/filter.util.ts`                                         |

    | Supported | `=`, `!=`, `AND`,
    `OR`                                                    |

    | Errors    | Invalid keys or value types return `400` with the standard
    error envelope |


    </details>


    </details>
  version: '2.0'
  contact: {}
servers:
  - url: https://api.paxoslabs.com/
    description: Production
security: []
tags: []
paths:
  /v2/amplify/vaults:
    get:
      tags:
        - Vaults
      summary: List Amplify vaults
      description: >-
        Returns aggregated vault configuration grouped by vault name: chain
        deployments (contract addresses, KYT flag, deposit supply cap, minimum
        withdrawal order size, in-deprecation flag) with nested per-asset config
        (depositable/withdrawable flags, deposit/withdraw fees, withdrawal
        SLAs).
      operationId: list
      parameters:
        - name: pageSize
          required: false
          in: query
          description: 'Maximum items per page. Default: 25. Min: 1, max: 100.'
          schema:
            minimum: 1
            maximum: 100
            default: 25
            example: 25
            type: number
        - name: pageToken
          required: false
          in: query
          description: Opaque token for the next page.
          schema:
            type: string
        - name: filter
          required: false
          in: query
          description: >-
            Filter string. Flags: chainId, inDeprecation, requiresKyt. Example:
            chainId=1 AND inDeprecation=false
          schema:
            example: chainId=1 AND inDeprecation=false
            type: string
      responses:
        '200':
          description: List of vaults
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VaultsResponseDto'
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseDto'
      security:
        - api-key: []
components:
  schemas:
    VaultsResponseDto:
      type: object
      properties:
        vaults:
          description: List of vaults, keyed by vault name.
          type: array
          items:
            $ref: '#/components/schemas/VaultDto'
        nextPageToken:
          type: string
          description: Token for the next page. null when no more results.
          example: eyJvZmZzZXQiOjI1fQ==
          nullable: true
      required:
        - vaults
        - nextPageToken
    ErrorResponseDto:
      type: object
      properties:
        error:
          description: Error object containing details
          allOf:
            - $ref: '#/components/schemas/ErrorObjectDto'
      required:
        - error
    VaultDto:
      type: object
      properties:
        name:
          type: string
          description: Human-readable vault name.
          example: Amplify USDC Core
        deployments:
          description: Chain deployments for this vault name.
          type: array
          items:
            $ref: '#/components/schemas/VaultDeploymentDto'
      required:
        - name
        - deployments
    ErrorObjectDto:
      type: object
      properties:
        code:
          type: number
          description: HTTP status code
          example: 400
        message:
          type: string
          description: Human-readable error message
          example: Invalid filter syntax.
        status:
          type: string
          description: Error status enum value
          enum:
            - UNKNOWN
            - INVALID_ARGUMENT
            - NOT_FOUND
            - PERMISSION_DENIED
            - UNAUTHENTICATED
            - RESOURCE_EXHAUSTED
            - INTERNAL
            - METHOD_NOT_ALLOWED
          example: INVALID_ARGUMENT
        details:
          description: Additional error details
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetailDto'
      required:
        - code
        - message
        - status
    VaultDeploymentDto:
      type: object
      properties:
        chainId:
          type: number
          description: Chain ID
          example: 1
        boringVaultAddress:
          type: string
          description: BoringVault contract address (the ERC-20 share token).
          example: '0xbbbb000000000000000000000000000000000001'
        depositorAddress:
          type: string
          description: >-
            DistributorCodeDepositor contract address — spender for deposit
            approvals.
          example: '0xcccc000000000000000000000000000000000001'
        withdrawQueueAddress:
          type: string
          description: >-
            WithdrawQueue contract address — spender for share approvals on
            withdrawal.
          example: '0xdddd000000000000000000000000000000000001'
        requiresKyt:
          type: boolean
          description: Whether the vault requires KYT attestations on deposit.
          example: false
        baseTokenAddress:
          type: string
          description: Base (primary deposit) asset address. Null when unset.
          example: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48'
          nullable: true
        accountantAddress:
          type: string
          description: Accountant contract address — tracks vault share rate.
          example: '0xaaaa000000000000000000000000000000000001'
          nullable: true
        tellerAddress:
          type: string
          description: Teller contract address.
          example: '0xeeee000000000000000000000000000000000001'
          nullable: true
        depositFeeAddress:
          type: string
          description: Deposit fee module contract address.
          example: null
          nullable: true
        withdrawFeeAddress:
          type: string
          description: Withdraw fee module contract address.
          example: null
          nullable: true
        inDeprecation:
          type: boolean
          description: Whether the vault is marked in deprecation.
          example: false
        depositSupplyCap:
          description: Deposit supply cap.
          nullable: true
          type: object
          allOf:
            - $ref: '#/components/schemas/TokenAmountWithCapDto'
        minimumWithdrawalOrderSize:
          description: Minimum withdrawal order size, denominated in share tokens.
          nullable: true
          type: object
          allOf:
            - $ref: '#/components/schemas/TokenAmountDto'
        assets:
          description: >-
            Per-asset configuration for this deployment:
            depositable/withdrawable flags, fees, and withdrawal SLAs.
          type: array
          items:
            $ref: '#/components/schemas/VaultAssetConfigDto'
      required:
        - chainId
        - boringVaultAddress
        - depositorAddress
        - withdrawQueueAddress
        - requiresKyt
        - inDeprecation
        - assets
    ErrorDetailDto:
      type: object
      properties:
        '@type':
          type: string
          description: Type URL identifying the error detail schema
          example: type.paxoslabs.dev/errors/BadRequest
        fieldViolations:
          description: Field-level violations for validation errors
          type: array
          items:
            $ref: '#/components/schemas/FieldViolationDto'
      required:
        - '@type'
    TokenAmountWithCapDto:
      type: object
      properties:
        raw:
          type: string
          description: Raw amount in base units (as a decimal string).
          example: '1000000000000'
        formatted:
          type: string
          description: Human-readable formatted amount.
          example: '1000000.0'
        decimals:
          type: number
          description: Token decimals used for formatting.
          example: 6
        hasCap:
          type: boolean
          description: >-
            Whether the vault has a finite deposit cap. False means the cap is
            set to maxUint256 (effectively uncapped).
          example: true
      required:
        - raw
        - formatted
        - decimals
        - hasCap
    TokenAmountDto:
      type: object
      properties:
        raw:
          type: string
          description: Raw amount in base units (as a decimal string).
          example: '1000000000000'
        formatted:
          type: string
          description: Human-readable formatted amount.
          example: '1000000.0'
        decimals:
          type: number
          description: Token decimals used for formatting.
          example: 6
      required:
        - raw
        - formatted
        - decimals
    VaultAssetConfigDto:
      type: object
      properties:
        assetAddress:
          type: string
          description: Asset contract address.
          example: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48'
        depositable:
          type: boolean
          description: Whether the asset can be deposited.
          example: true
        withdrawable:
          type: boolean
          description: Whether the asset can be withdrawn.
          example: true
        depositFees:
          description: Deposit fee for this asset.
          allOf:
            - $ref: '#/components/schemas/FeeDto'
        withdrawFees:
          description: Withdraw fee for this asset.
          allOf:
            - $ref: '#/components/schemas/FeeDto'
        withdrawalSLAs:
          description: Withdrawal SLAs configured for this (vault, asset) pair.
          nullable: true
          type: object
          allOf:
            - $ref: '#/components/schemas/WithdrawalSLAsDto'
      required:
        - assetAddress
        - depositable
        - withdrawable
        - depositFees
        - withdrawFees
    FieldViolationDto:
      type: object
      properties:
        field:
          type: string
          description: The field that caused the violation
          example: filter
        description:
          type: string
          description: Description of the violation
          example: vaultAddress 0x0x is an invalid hex address.
      required:
        - field
        - description
    FeeDto:
      type: object
      properties:
        bps:
          type: number
          description: Fee in basis points (integer). 25 = 0.25%.
          example: 25
        percentage:
          type: string
          description: 'Human-readable percentage (4 decimals). Example: "0.2500" = 0.25%.'
          example: '0.2500'
      required:
        - bps
        - percentage
    WithdrawalSLAsDto:
      type: object
      properties:
        expectedDelay:
          type: string
          description: Expected delay before a withdrawal is processed.
          example: 86400s
      required:
        - expectedDelay
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: x-api-key
      description: 'API key in format: pxl_<public_id>_<secret>'

````