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

# List an entity's accounts

> Same items and cursor pagination as `GET /v2/accounts`, restricted to accounts attached to this entity.



## OpenAPI

````yaml /api-reference/platform-api.json get /v2/parties/{id}/accounts
openapi: 3.0.0
info:
  title: Range Platform API
  description: >-
    The Range Platform API for workspace management, counterparties, and
    operational tooling.
  version: 1.7.29
  contact: {}
servers:
  - url: https://api.range.org
    description: Range API Server
security:
  - Authorization: []
  - Authorization: []
tags:
  - name: Address Information
    description: Get information about a crypto address.
  - name: Transfer Enrichments
    description: Attach workspace-scoped notes and categories to transfers.
  - name: Counterparties
    description: Manage external entities, their addresses, bank accounts, and documents.
  - name: Parties
    description: >-
      The workspace entity register: the firm itself, its clients, and its
      counterparties.
paths:
  /v2/parties/{id}/accounts:
    get:
      tags:
        - Parties
      summary: List an entity's accounts
      description: >-
        Same items and cursor pagination as `GET /v2/accounts`, restricted to
        accounts attached to this entity.
      operationId: listAccounts
      parameters:
        - name: id
          required: true
          in: path
          schema:
            type: string
        - name: cursor
          required: false
          in: query
          description: Opaque cursor for the next page of results
          schema:
            example: workspace1-solana-BJE5MMbqXjVwjAF7oxwPYXnTXDyspzZyt4vwenNw5ruG
            type: string
        - name: size
          required: false
          in: query
          schema:
            minimum: 1
            maximum: 1000
            default: 50
            example: 50
            type: number
        - name: group_id
          required: false
          in: query
          description: >-
            Filter accounts by membership in a specific group
            (account_groups.id)
          schema:
            type: string
            example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        - name: type
          required: false
          in: query
          schema:
            example: bank
            type: string
            enum:
              - eoa
              - multisig
              - contract
              - custodian
              - exchange
              - bank
              - defi
        - name: provider
          required: false
          in: query
          description: Filter to accounts held under a connection of this provider
          schema:
            example: utila
            type: string
            enum:
              - utila
              - kraken
              - binance
              - okx
              - bybit
              - bitget
              - gate
              - kucoin
              - plaid
              - squads
              - altitude
              - coinbase
              - realms
              - wise
              - safe
              - hyperliquid
              - cubist
              - privy
              - dfns
              - anchorage
              - revolut_business
              - turnkey
              - fordefi
              - coins_ph
              - fireblocks
              - pave_bank
              - copper
              - custom
        - name: chain
          required: false
          in: query
          description: >-
            Canonical Range network slug, e.g. eth, bnb, solana. Known aliases
            (ethereum, binance, …) are normalized before filtering.
          schema:
            type: string
            example: eth
        - name: connection_id
          required: false
          in: query
          schema:
            example: utila-123
            type: string
        - name: show_all
          required: false
          in: query
          description: >-
            Restores the response to today's unfiltered shape, byte-for-byte,
            ignoring the workspace token whitelist. Never mutates stored
            overrides.
          schema:
            default: false
            type: boolean
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchAccountsResponseDto'
        '404':
          description: Entity not found
components:
  schemas:
    SearchAccountsResponseDto:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/AccountDto'
        meta:
          $ref: '#/components/schemas/CursorMetaDto'
      required:
        - items
        - meta
    AccountDto:
      type: object
      properties:
        id:
          type: string
          example: bje5mmbqxjvwjaf7oxwpyxntxdyspzZyt4vwennw5rug
          description: >-
            Stable account id. Matches `account_id` on workspace balance
            responses for joins.
        name:
          type: string
          nullable: true
          example: Treasury wallet
          description: Null when the account was saved without a name.
        type:
          type: string
          example: eoa
          enum:
            - eoa
            - multisig
            - contract
            - custodian
            - exchange
            - bank
            - defi
        network:
          type: string
          example: solana
        address:
          type: string
          example: BJE5MMbqXjVwjAF7oxwPYXnTXDyspzZyt4vwenNw5ruG
        provider:
          type: string
          example: ledger, kraken, wallet, ...
        groups:
          type: array
          example:
            - id: uuid-1
              name: Finance
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
        team:
          type: object
          nullable: true
          example:
            id: 0d3f0d0a-3b1e-4b4a-9d2b-2f2b6f6a1c11
            name: Treasury
          properties:
            id:
              type: string
            name:
              type: string
          description: >-
            The team the account is assigned to (set with PUT
            /v2/accounts/:id/team), resolved to its current name. Null when the
            account has no team or its team no longer exists in the workspace.
            Always present on persisted account responses; omitted on
            connection-preview stubs.
        status:
          type: string
          example: active
          enum:
            - active
            - updating
        balances:
          type: array
          items:
            $ref: '#/components/schemas/AccountBalance'
        balances_usd:
          type: string
          nullable: true
          example: '1234.56'
          description: >-
            Total USD value across all of the account balances. `null` when no
            asset has a known price.
        hidden_count:
          type: number
          example: 0
          description: >-
            Count of balances the workspace token whitelist removed from
            `balances`/`balances_usd` above. `0` both when nothing was filtered
            and when the account has no balances at all — distinguish those with
            `balances.length`. Always `0` when `show_all` was requested. Always
            present on persisted account responses; omitted on
            connection-preview stubs that have never been imported.
        hidden_usd:
          type: string
          nullable: true
          example: '340.12'
          description: >-
            Total USD value across the balances `hidden_count` counts — an
            aggregate only, never broken down by asset, so a hidden holding's
            identity or individual amount is never exposed on the default
            (filtered) response. `null` when nothing is hidden or none of the
            hidden balances have a known price. Always present on persisted
            account responses; omitted on preview stubs.
        balances_updated_at:
          type: string
          example: '2024-01-01T00:00:00.000Z'
        details:
          oneOf:
            - $ref: '#/components/schemas/WalletDetails'
            - $ref: '#/components/schemas/ContractDetails'
            - $ref: '#/components/schemas/AccountConnectionDetails'
            - $ref: '#/components/schemas/SquadsConnectionDetails'
            - $ref: '#/components/schemas/AltitudeConnectionDetails'
            - $ref: '#/components/schemas/RealmsConnectionDetails'
            - $ref: '#/components/schemas/SafeConnectionDetails'
            - $ref: '#/components/schemas/PrivyConnectionDetails'
            - $ref: '#/components/schemas/DfnsConnectionDetails'
            - $ref: '#/components/schemas/CopperConnectionDetails'
        notes:
          type: string
          example: Primary treasury wallet
        role:
          type: string
          example: Treasury
        books:
          type: string
          example: house
          enum:
            - house
            - client
          description: >-
            Which books this account sits on (custom connections — F4 /
            RNG-5533).
        entity_id:
          type: string
          example: a1b2c3d4-5678-90ab-cdef-1234567890ab
          description: >-
            The register entity this account belongs to (`/v2/parties`). Always
            present on persisted accounts; omitted on connection-preview stubs.
        entity:
          description: >-
            Inline summary of `entity_id`. Always present on persisted accounts;
            omitted on connection-preview stubs.
          allOf:
            - $ref: '#/components/schemas/EntityRefDto'
        regulatory:
          description: >-
            Present when the account has account-level regulatory settings
            (custodian, ownership, staking).
          allOf:
            - $ref: '#/components/schemas/AccountRegulatorySettingsDto'
        cadoc_5710:
          description: >-
            Present when the account is registered for the cadoc-5710 (monthly
            reserves) template.
          allOf:
            - $ref: '#/components/schemas/Cadoc5710PropertiesDto'
        cadoc_5711:
          description: >-
            Present when the account is registered for the cadoc-5711 (daily
            custody) template.
          allOf:
            - $ref: '#/components/schemas/Cadoc5711PropertiesDto'
        treasury_statement:
          type: object
          properties: {}
          additionalProperties: false
          description: Present when registered for treasury statements.
        last_synced_at:
          type: object
          example: '2026-01-01T00:00:00.000Z'
          nullable: true
          description: >-
            When a transaction-sync run last *succeeded* for this account, or
            null if none ever has. Always present on persisted account
            responses; omitted on connection-preview stubs that have never been
            imported. Sync is only triggered manually via POST
            /v2/accounts/transfers/sync (one job per account).
        transactions_history_from:
          type: object
          example: '2026-07-01T00:00:00.000Z'
          nullable: true
          description: >-
            How far back this account's transaction history has been synced, or
            null before the first successful sync. A first sync walks back 90
            days and later syncs only walk forward, so anything older has not
            been fetched and may be missing from reports. POST
            /v2/accounts/{account_id}/transfers/resync walks back further. Only
            ever moves earlier. Always present on persisted account responses;
            omitted on connection-preview stubs.
        sync_unavailable_reason:
          type: string
          nullable: true
          example: provider_region_unsupported
          enum:
            - provider_region_unsupported
            - account_unsupported
          description: >-
            Why the most recent transaction sync failed, when the cause is
            permanent for this account rather than a transient error worth
            retrying. Classified from ops-only `last_sync_error`; never the raw
            text.


            `provider_region_unsupported`: the provider does not serve
            transaction history for this account's country with the credential
            it was given. `account_unsupported`: the account has no supported
            transaction-history source (connection adapter, on-chain network, or
            address). Always present on persisted account responses; omitted on
            preview stubs.
        sync_status:
          type: string
          nullable: true
          example: succeeded
          enum:
            - running
            - succeeded
            - failed
          description: >-
            Outcome of the most recent sync run for this account, or null before
            the first one. `failed` leaves `last_synced_at` at the last
            genuinely successful run. Always present on persisted account
            responses; omitted on preview stubs.
        last_balance_refresh_at:
          type: object
          example: '2026-01-01T00:00:00.000Z'
          nullable: true
          description: >-
            When the most recent balance-*refresh attempt* ran, or null before
            the first one. Advances on every attempt including a failed one —
            unlike `balances_updated_at`, which only moves on a successful read,
            so a client can tell "stale because nobody asked" from "stale
            because it keeps failing". Always present on persisted account
            responses; omitted on connection-preview stubs that have never been
            imported.
        last_balance_refresh_reason:
          type: string
          nullable: true
          example: provider_timeout
          enum:
            - reconnect_required
            - provider_timeout
            - rate_limited
            - authentication_failed
            - provider_unreachable
            - provider_rejected
            - provider_error
            - connection_not_found
            - balance_lookup_failed
            - unclassified_provider_error
            - asset_catalog_unavailable
            - tokens_not_enumerated
          description: >-
            Why the most recent balance-refresh attempt failed, as a stable
            machine code a client may branch on without string-matching prose
            that may be reworded. null when the last attempt succeeded, none has
            been made yet, or the chain has no readable balance source. Always
            present on persisted account responses; omitted on preview stubs,
            except a stub whose balance read failed or resolved only in part
            (`balances` is then empty, never the half that resolved, and this
            carries the reason).
        last_balance_refresh_status:
          type: string
          nullable: true
          example: succeeded
          enum:
            - succeeded
            - failed
            - unsupported
          description: >-
            Outcome of the most recent balance-refresh attempt for this account.
            `unsupported` means this chain has no readable balance source —
            derived, and takes precedence over any stored status. null before
            the first attempt. Distinct from `sync_status`, which tracks
            transaction-history sync, not balances. Always present on persisted
            account responses; omitted on connection-preview stubs that have
            never been imported, except a stub whose balance read failed or
            resolved only in part (`failed`, or `unsupported` when the chain has
            no readable balance source): its empty `balances` is not a real
            empty account.
      required:
        - id
        - type
        - provider
        - groups
        - status
        - balances
    CursorMetaDto:
      type: object
      properties:
        next_cursor:
          type: string
          nullable: true
          description: >-
            Opaque string cursor pointing to the next page of results. null if
            there is no next page.
          example: eyJpZCI6IjkxeFFlV3Z...
        previous_cursor:
          type: string
          nullable: true
          description: >-
            Opaque string cursor pointing to the previous page of results. null
            if there is no previous page.
          example: eyJpZCI6IjkxeFFlV3Z...
        first_page_cursor:
          type: string
          description: >-
            Opaque string cursor pointing to the very first page in the entire
            dataset with respect to the current filter.
          example: eyJpZCI6IjkxeFFlV3Z...
        last_page_cursor:
          type: string
          nullable: true
          description: >-
            Opaque string cursor pointing to the very last page in the entire
            dataset with respect to the current filter.
          example: eyJpZCI6IjkxeFFlV3Z...
        total_count:
          type: number
          nullable: true
          description: Total number of results.
          example: 100
        page_number:
          type: number
          description: Current page number.
          example: 1
    AccountBalance:
      type: object
      properties:
        asset:
          type: string
          example: USDC
          description: >-
            Legacy asset ticker. Prefer `symbol`/`name`; kept for backwards
            compatibility.
        symbol:
          type: string
          example: USDC
          description: >-
            Asset ticker / symbol. Always present on API responses (filled from
            `asset` when omitted at write time).
        name:
          type: string
          example: USD Coin
          description: >-
            Human-readable asset name. Always present on API responses; falls
            back to `symbol` when a distinct name is unavailable.
        amount:
          type: string
          example: '100.50'
          description: >-
            Raw quantity reported by the provider, in asset units, as a decimal
            string.
        usd:
          type: string
          nullable: true
          example: '100.50'
          description: >-
            USD equivalent of `amount` as a decimal string. `null` when no USD
            price is available (distinct from `"0"`). For fiat accounts, equals
            `amount`.
        updated_at:
          type: string
          example: '2024-01-01T00:00:00.000Z'
        price_updated_at:
          type: string
          nullable: true
          example: '2024-01-01T00:00:00.000Z'
          description: >-
            When the unit price backing `usd` was fetched at its source
            (CoinGecko cache, Alchemy Prices). `null` when the source reported
            no timestamp; absent for balances persisted before this field
            existed.
        price_source:
          type: string
          nullable: true
          example: coingecko
          description: >-
            Which pricing product supplied the unit price backing `usd`
            (`coingecko`, `alchemy`). `null` when the source is untracked;
            absent for balances persisted before this field existed.
        denom:
          type: string
          nullable: true
          example: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48'
          description: >-
            Raw on-chain denom (contract address / mint / IBC denom) this
            balance line was fetched under, when the source is on-chain. Absent
            for balances persisted before this field existed and for
            exchange/custodian sources, which have no on-chain denom.
        asset_id:
          type: string
          example: ethereum:native
          description: >-
            Custom snapshot identity (`network:denom` or a fiat ISO code). Merge
            and delete key on this; `denom` stays the bare contract/mint. Absent
            for every other balance source.
      required:
        - asset
        - amount
        - updated_at
    WalletDetails:
      type: object
      properties:
        network:
          type: string
          example: solana
        address:
          type: string
          example: BJE5MMbqXjVwjAF7oxwPYXnTXDyspzZyt4vwenNw5ruG
        funded_by:
          type: object
          properties:
            sender:
              type: string
            tx_hash:
              type: string
            tx_time:
              type: string
          required:
            - sender
            - tx_hash
            - tx_time
      required:
        - network
        - address
    ContractDetails:
      type: object
      properties:
        network:
          type: string
          example: solana
        address:
          type: string
          example: BJE5MMbqXjVwjAF7oxwPYXnTXDyspzZyt4vwenNw5ruG
        cosmos_contract:
          type: object
          properties:
            admin:
              type: string
              nullable: true
            code_id:
              type: number
            creator:
              type: string
          required:
            - admin
            - code_id
            - creator
        solana_contract:
          type: object
          properties:
            owner:
              type: string
            is_on_curve:
              type: boolean
            space:
              type: number
            executable_data:
              type: string
            upgradeable:
              type: boolean
            upgrade_authority:
              type: string
              nullable: true
            upgrade_authority_type:
              type: string
            last_deployed_slot:
              type: number
            last_deployed_at:
              type: string
            last_deployed_by:
              type: string
            last_deployed_tx:
              type: string
            verified:
              type: boolean
            repo_url:
              type: string
            security_txt_included:
              type: boolean
          required:
            - owner
            - is_on_curve
            - space
            - executable_data
            - upgradeable
            - upgrade_authority
            - upgrade_authority_type
            - verified
            - security_txt_included
    AccountConnectionDetails:
      type: object
      properties:
        connection_provider:
          type: string
          example: kraken
        provider_display_name:
          type: string
          example: Kraken
          description: >-
            Canonical brand label for `connection_provider` (e.g. okx → OKX,
            plaid → Bank).
        connection_id:
          type: string
          example: utila-123
          description: Account-connection holding this account
        connection_object_id:
          type: string
          example: '12345678'
      required:
        - connection_provider
        - provider_display_name
        - connection_object_id
    SquadsConnectionDetails:
      type: object
      properties:
        connection_provider:
          type: string
          example: kraken
        provider_display_name:
          type: string
          example: Kraken
          description: >-
            Canonical brand label for `connection_provider` (e.g. okx → OKX,
            plaid → Bank).
        connection_id:
          type: string
          example: utila-123
          description: Account-connection holding this account
        connection_object_id:
          type: string
          example: '12345678'
        multisig:
          $ref: '#/components/schemas/AccountConnectionSquadsPublicDataDto'
      required:
        - connection_provider
        - provider_display_name
        - connection_object_id
        - multisig
    AltitudeConnectionDetails:
      type: object
      properties:
        connection_provider:
          type: string
          example: kraken
        provider_display_name:
          type: string
          example: Kraken
          description: >-
            Canonical brand label for `connection_provider` (e.g. okx → OKX,
            plaid → Bank).
        connection_id:
          type: string
          example: utila-123
          description: Account-connection holding this account
        connection_object_id:
          type: string
          example: '12345678'
        altitude:
          $ref: '#/components/schemas/AccountConnectionAltitudePublicDataDto'
      required:
        - connection_provider
        - provider_display_name
        - connection_object_id
        - altitude
    RealmsConnectionDetails:
      type: object
      properties:
        connection_provider:
          type: string
          example: kraken
        provider_display_name:
          type: string
          example: Kraken
          description: >-
            Canonical brand label for `connection_provider` (e.g. okx → OKX,
            plaid → Bank).
        connection_id:
          type: string
          example: utila-123
          description: Account-connection holding this account
        connection_object_id:
          type: string
          example: '12345678'
        realms:
          $ref: '#/components/schemas/AccountConnectionRealmsPublicDataDto'
      required:
        - connection_provider
        - provider_display_name
        - connection_object_id
        - realms
    SafeConnectionDetails:
      type: object
      properties:
        connection_provider:
          type: string
          example: kraken
        provider_display_name:
          type: string
          example: Kraken
          description: >-
            Canonical brand label for `connection_provider` (e.g. okx → OKX,
            plaid → Bank).
        connection_id:
          type: string
          example: utila-123
          description: Account-connection holding this account
        connection_object_id:
          type: string
          example: '12345678'
        safe:
          $ref: '#/components/schemas/AccountConnectionSafePublicDataDto'
      required:
        - connection_provider
        - provider_display_name
        - connection_object_id
        - safe
    PrivyConnectionDetails:
      type: object
      properties:
        connection_provider:
          type: string
          example: kraken
        provider_display_name:
          type: string
          example: Kraken
          description: >-
            Canonical brand label for `connection_provider` (e.g. okx → OKX,
            plaid → Bank).
        connection_id:
          type: string
          example: utila-123
          description: Account-connection holding this account
        connection_object_id:
          type: string
          example: '12345678'
        privy_custody:
          type: string
          example: app
          enum:
            - app
            - embedded
            - external
          description: >-
            Custody origin of the wallet: app/server-controlled, Privy-managed
            embedded, or user self-custody (external).
      required:
        - connection_provider
        - provider_display_name
        - connection_object_id
        - privy_custody
    DfnsConnectionDetails:
      type: object
      properties:
        connection_provider:
          type: string
          example: kraken
        provider_display_name:
          type: string
          example: Kraken
          description: >-
            Canonical brand label for `connection_provider` (e.g. okx → OKX,
            plaid → Bank).
        connection_id:
          type: string
          example: utila-123
          description: Account-connection holding this account
        connection_object_id:
          type: string
          example: '12345678'
        dfns_custody:
          type: string
          example: organization
          enum:
            - organization
            - end_user
          description: >-
            Custody of the Dfns wallet: owned by the organization (custodial) or
            delegated to an end user (non-custodial).
      required:
        - connection_provider
        - provider_display_name
        - connection_object_id
        - dfns_custody
    CopperConnectionDetails:
      type: object
      properties:
        connection_provider:
          type: string
          example: kraken
        provider_display_name:
          type: string
          example: Kraken
          description: >-
            Canonical brand label for `connection_provider` (e.g. okx → OKX,
            plaid → Bank).
        connection_id:
          type: string
          example: utila-123
          description: Account-connection holding this account
        connection_object_id:
          type: string
          example: '12345678'
        portfolio_type:
          type: string
          example: custody
          enum:
            - custody
            - clearloop
            - trading-vault
            - trading
            - external
          description: Copper portfolio type (UI “Account” type).
        deposit_targets:
          description: Receiving addresses for custody portfolios (multi-address).
          type: array
          items:
            $ref: '#/components/schemas/CopperDepositTargetDto'
        clearloop:
          $ref: '#/components/schemas/CopperClearLoopDetailsDto'
      required:
        - connection_provider
        - provider_display_name
        - connection_object_id
        - portfolio_type
    EntityRefDto:
      type: object
      properties:
        id:
          type: string
          example: a1b2c3d4-5678-90ab-cdef-1234567890ab
        name:
          type: string
          example: Acme Participações Ltda
        types:
          type: array
          example:
            - client
          items:
            type: string
            enum:
              - self
              - client
              - counterparty
      required:
        - id
        - name
        - types
    AccountRegulatorySettingsDto:
      type: object
      properties:
        custodian_code:
          type: string
          example: Z1234567
          description: >-
            BCB Z-code of the custodian: Z followed by 7 digits. Maps to
            psavCustodiante on both filings.
        custodian_country:
          type: string
          example: BR
          description: >-
            ISO-3166 alpha-2 country of the custodian. Maps to
            psavCustodiantePais.
        ownership:
          type: string
          enum:
            - own
            - client
            - other_fi
          example: client
          description: Whose funds the account holds (W2A·A4 classification).
        is_staking:
          type: boolean
          example: false
          description: Whether the account is a staking position (W2A·A4).
      required:
        - custodian_code
        - custodian_country
        - ownership
        - is_staking
    Cadoc5710PropertiesDto:
      type: object
      properties:
        address_type:
          type: string
          enum:
            - CUSTODIA_PROPRIA_OMNIBUS
            - CUSTODIA_PROPRIA_SEGREGADO
            - SUBCUSTODIANTE_TERCEIRO
            - CONTRATO_TOKEN
            - CONTRATO_STAKING
            - VALIDADOR
            - DEPOSITO_EXCHANGE
            - NAO_VERIFICAVEL_ONCHAIN
            - '99'
          example: CUSTODIA_PROPRIA_SEGREGADO
          description: BCB Annex 6.1 code. Maps to CADOC 5710 tipoEndereco.
        wallet_type:
          type: string
          enum:
            - QUENTE
            - MORNA
            - FRIA
            - CUSTODIA_TERCEIRO
            - NAO_APLICAVEL
            - '99'
          example: FRIA
          description: BCB Annex 6.1 code. Maps to CADOC 5710 tipoCarteira.
      required:
        - address_type
        - wallet_type
    Cadoc5711PropertiesDto:
      type: object
      properties:
        client_tax_id:
          type: string
          example: '52998224725'
          description: >-
            Client CPF (11 digits) or CNPJ (14 digits), digits only, verified
            against the mod-11 check digits. Maps to CADOC 5711 clienteId.
            Requires client_tax_id_type.
        client_tax_id_type:
          type: string
          enum:
            - cpf
            - cnpj
          example: cpf
          description: >-
            Declared tax-id type. Maps to CADOC 5711 tipoCliente. Requires
            client_tax_id.
    AccountConnectionSquadsPublicDataDto:
      type: object
      properties:
        multisig_address:
          type: string
          example: BJE5MMbqXjVwjAF7oxwPYXnTXDyspzZyt4vwenNw5ruG
        resolved_from_address:
          type: string
          example: BJE5MMbqXjVwjAF7oxwPYXnTXDyspzZyt4vwenNw5ruG
          description: Original address provided by the customer (may be a vault)
        resolved_vault_index:
          type: number
          example: 0
          description: Vault index if input was a vault address
        threshold:
          type: number
          example: 2
        version:
          type: string
          example: v4
          enum:
            - v3
            - v4
        program_id:
          type: string
          example: SQDS4ep65T869zMMBKyuUq6aD6EgTu8psMjkvj52pCf
        create_key:
          type: string
          example: BJE5MMbqXjVwjAF7oxwPYXnTXDyspzZyt4vwenNw5ruG
        config_authority:
          type: string
          nullable: true
          example: null
          description: V4 only
        time_lock:
          type: number
          example: 0
          description: V4 only — seconds
        members:
          type: array
          items:
            type: object
        pending_proposals:
          type: array
          items:
            $ref: '#/components/schemas/AccountConnectionSquadsPendingProposalDto'
        vaults:
          type: array
          items:
            type: object
      required:
        - multisig_address
        - resolved_from_address
        - threshold
        - version
        - program_id
        - create_key
        - members
        - pending_proposals
        - vaults
    AccountConnectionAltitudePublicDataDto:
      type: object
      properties:
        settings_address:
          type: string
          example: DzHZF6ZYAWqor1hxeaKmCwDoS5q1ZqBKKgNQVetxE69x
          description: Settings account of the smart account (the canonical config PDA)
        resolved_from_address:
          type: string
          example: H8sdnTKCRKiyrDT8g9pMTzeoihUcEoTNdybakNT81xyQ
          description: >-
            Original address provided by the customer (may be a smart-account
            deposit address)
        resolved_account_index:
          type: number
          example: 0
          description: >-
            Smart-account index if the input was a smart-account (deposit)
            address
        is_altitude:
          type: boolean
          example: true
          description: >-
            Whether the smart account is Altitude-managed (Altitude's
            operational key fee-pays its transactions) vs a generic smart
            account.
        program_id:
          type: string
          example: SMRTzfY6DfH5ik3TKiyLFfXexV8uSG3d2UksSCYdunG
        settings_seed:
          type: string
          example: '88888'
          description: u128 global-counter seed of the Settings PDA
        settings_authority:
          type: string
          nullable: true
          example: null
          description: null = autonomous (settings changes go through signers)
        threshold:
          type: number
          example: 1
        time_lock:
          type: number
          example: 0
          description: Seconds
        transaction_index:
          type: number
          example: 34
        stale_transaction_index:
          type: number
          example: 12
        signers:
          type: array
          items:
            type: object
        policies:
          type: array
          items:
            $ref: '#/components/schemas/AccountConnectionAltitudePolicyDto'
        policies_truncated:
          type: boolean
          example: true
          description: >-
            Present (true) only in the edge case where the account has cycled
            through more than 2048 policies over its lifetime (the scan cap) —
            policies with seeds above 2048 are then missing from the list.
        pending_proposals:
          type: array
          items:
            $ref: '#/components/schemas/AccountConnectionSquadsPendingProposalDto'
        smart_accounts:
          type: array
          items:
            $ref: '#/components/schemas/AccountConnectionAltitudeSmartAccountDto'
      required:
        - settings_address
        - resolved_from_address
        - is_altitude
        - program_id
        - settings_seed
        - threshold
        - time_lock
        - transaction_index
        - stale_transaction_index
        - signers
        - policies
        - pending_proposals
        - smart_accounts
    AccountConnectionRealmsPublicDataDto:
      type: object
      properties:
        realm_address:
          type: string
          example: DA5G7QQbFioZ6K33wQcH8fVdgFcnaDjLD7DLQkapZg5X
        resolved_from_address:
          type: string
          example: DA5G7QQbFioZ6K33wQcH8fVdgFcnaDjLD7DLQkapZg5X
        program_id:
          type: string
          example: AEauWRrpn9Cs6GXujzdp1YhMmv2288kBt3SdEcPYEerr
        version:
          type: string
          example: v2
          enum:
            - v2
        realm_name:
          type: string
          example: Metaplex
        community_mint:
          type: string
          example: METAewgxyPbgwsseH8T16a39CQ5VyVxZi9zXiDPY18m
        council_mint:
          type: string
          nullable: true
          example: null
        authority:
          type: string
          nullable: true
          example: null
        min_community_weight_to_create_governance:
          type: string
          example: '1'
        council_members:
          type: array
          items:
            type: object
        community_members_count:
          type: number
          example: 42
        governances:
          type: array
          items:
            type: object
        treasuries:
          type: array
          items:
            $ref: '#/components/schemas/AccountConnectionRealmsTreasuryDto'
        latest_active_proposal:
          nullable: true
          description: >-
            Most recently created proposal currently in Draft, SigningOff, or
            Voting state. null when no active proposals exist.
          type: object
          allOf:
            - $ref: >-
                #/components/schemas/AccountConnectionRealmsLatestActiveProposalDto
      required:
        - realm_address
        - resolved_from_address
        - program_id
        - version
        - realm_name
        - community_mint
        - min_community_weight_to_create_governance
        - council_members
        - community_members_count
        - governances
        - treasuries
    AccountConnectionSafePublicDataDto:
      type: object
      properties:
        safe_address:
          type: string
          example: '0xfF501B324DC6d78dC9F983f140B9211c3EdB4dc7'
          description: EIP-55 checksummed Safe address
        network:
          type: string
          example: ethereum
          enum:
            - ethereum
            - arbitrum
            - base
            - optimism
            - polygon
            - bnb
        version:
          type: string
          example: 1.4.1
          description: Safe contract version (e.g. 1.3.0, 1.4.1)
        threshold:
          type: number
          example: 2
        nonce:
          type: number
          example: 42
        owners:
          type: array
          example:
            - 0xabc...
            - 0xdef...
          items:
            type: string
        pending_proposals:
          type: array
          items:
            $ref: '#/components/schemas/AccountConnectionSafePendingProposalDto'
      required:
        - safe_address
        - network
        - version
        - threshold
        - nonce
        - owners
        - pending_proposals
    CopperDepositTargetDto:
      type: object
      properties:
        deposit_target_id:
          type: string
          example: dt-123
        address:
          type: string
          nullable: true
          example: bc1q…
        memo:
          type: string
          nullable: true
          example: memo-1
        currency:
          type: string
          nullable: true
          example: BTC
        main_currency:
          type: string
          example: BTC
        status:
          type: string
          example: enabled
        name:
          type: string
          nullable: true
          example: Cold deposit
      required:
        - deposit_target_id
        - main_currency
        - status
    CopperClearLoopDetailsDto:
      type: object
      properties:
        exchange_id:
          type: string
          nullable: true
          example: binance
        client_account_id:
          type: string
          nullable: true
          example: exchange-acct-1
    AccountConnectionSquadsPendingProposalDto:
      type: object
      properties:
        address:
          type: string
          example: BJE5MMbqXjVwjAF7oxwPYXnTXDyspzZyt4vwenNw5ruG
        transaction_index:
          type: number
          example: 42
        status:
          type: string
          example: active
          enum:
            - draft
            - active
            - executeReady
            - approved
            - executing
            - executed
            - rejected
            - cancelled
            - unknown
          description: >-
            V3: draft/active/executeReady/executed/rejected/cancelled. V4 adds:
            approved/executing.
        approved_count:
          type: number
          example: 2
        rejected_count:
          type: number
          example: 0
        approved:
          type: array
          items:
            type: string
          description: >-
            Signer pubkeys that approved (per-signer confirmation). Absent on
            connections persisted before this field existed, until next refresh.
          example:
            - BJE5MMbqXjVwjAF7oxwPYXnTXDyspzZyt4vwenNw5ruG
        rejected:
          type: array
          items:
            type: string
          description: >-
            Signer pubkeys that rejected. Absent on connections persisted before
            this field existed, until next refresh.
          example: []
        timestamp:
          type: number
          nullable: true
          example: 1712345678
      required:
        - address
        - transaction_index
        - status
        - approved_count
        - rejected_count
    AccountConnectionAltitudePolicyDto:
      type: object
      properties:
        address:
          type: string
          example: 8VRXxPosEMFphTeQPLShJQhVeigjuV7mfRzm9UqVwWJx
        seed:
          type: number
          example: 2
      required:
        - address
        - seed
    AccountConnectionAltitudeSmartAccountDto:
      type: object
      properties:
        account_index:
          type: number
          example: 0
          description: Smart-account (vault) index
        address:
          type: string
          example: H8sdnTKCRKiyrDT8g9pMTzeoihUcEoTNdybakNT81xyQ
        lamports:
          type: string
          example: '0'
        token_accounts:
          type: array
          items:
            type: object
      required:
        - account_index
        - address
        - lamports
        - token_accounts
    AccountConnectionRealmsTreasuryDto:
      type: object
      properties:
        governance:
          type: string
          example: 8cEhQQm3MW5YQiiZ7sB6YkmFHcLXPAFSp7i4e48Kt4PK
        native_treasury:
          type: string
          example: BHkk3RTd4Ue6JnqXpa9QHTXbn575ycR8hxVmYx4E254k
        lamports:
          type: string
          example: '131992814522'
        token_accounts:
          type: array
          items:
            $ref: '#/components/schemas/AccountConnectionRealmsTokenAccountDto'
      required:
        - governance
        - native_treasury
        - lamports
        - token_accounts
    AccountConnectionRealmsLatestActiveProposalDto:
      type: object
      properties:
        pubkey:
          type: string
          example: F7xP...abc
        governance:
          type: string
          example: 8cEhQQm3MW5YQiiZ7sB6YkmFHcLXPAFSp7i4e48Kt4PK
        governing_token_mint:
          type: string
          example: METAewgxyPbgwsseH8T16a39CQ5VyVxZi9zXiDPY18m
        track:
          type: string
          example: community
          enum:
            - community
            - council
        name:
          type: string
          example: Increase staking rewards to 8%
        state:
          type: string
          example: Voting
        draft_at:
          type: number
          example: 1700000000
      required:
        - pubkey
        - governance
        - governing_token_mint
        - track
        - name
        - state
        - draft_at
    AccountConnectionSafePendingProposalDto:
      type: object
      properties:
        safe_tx_hash:
          type: string
          example: 0xabcdef1234...
        nonce:
          type: number
          example: 42
        destination_address:
          type: string
          example: 0xabc...
        value:
          type: string
          example: '0.5'
          description: Native asset amount, human-readable (raw wei divided by 10^18).
        data_payload:
          type: string
          nullable: true
          example: null
        operation:
          type: number
          example: 0
          description: 0 = call, 1 = delegatecall
        confirmations_required:
          type: number
          example: 2
        confirmations:
          type: array
          items:
            $ref: '#/components/schemas/AccountConnectionSafeConfirmationDto'
        submission_date:
          type: string
          nullable: true
          example: '2026-01-01T00:00:00.000Z'
      required:
        - safe_tx_hash
        - nonce
        - destination_address
        - value
        - operation
        - confirmations_required
        - confirmations
    AccountConnectionRealmsTokenAccountDto:
      type: object
      properties:
        pubkey:
          type: string
          example: 8iD9rdetvTqb9ooxrYbMESi9nRsGReYSBpCXqaj8G3r
        owner:
          type: string
          example: BHkk3RTd4Ue6JnqXpa9QHTXbn575ycR8hxVmYx4E254k
        owner_kind:
          type: string
          example: native_treasury
          enum:
            - native_treasury
            - governance
        mint:
          type: string
          example: So11111111111111111111111111111111111111112
        balance:
          type: string
          example: '1000000'
        decimals:
          type: number
          example: 6
        ui_amount:
          type: string
          example: '1.000000'
      required:
        - pubkey
        - owner
        - owner_kind
        - mint
        - balance
        - decimals
        - ui_amount
    AccountConnectionSafeConfirmationDto:
      type: object
      properties:
        owner:
          type: string
          example: 0xabc...
        submission_date:
          type: string
          example: '2026-01-01T00:00:00.000Z'
      required:
        - owner
        - submission_date
  securitySchemes:
    Authorization:
      type: apiKey
      in: header
      name: X-API-KEY
      description: Authorization method required to allow user to access the api endpoints.

````

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