---
title: "List sweep threshold configurations for a domain"
method: GET
path: "/v1/domains/{domainId}/sweep-thresholds"
tags: ["Sweep thresholds"]
---

# List sweep threshold configurations for a domain

`GET /v1/domains/{domainId}/sweep-thresholds`

## Request

- Base URL: `https://docs.ripple.com` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.ripple.com/v1/domains/{domainId}/sweep-thresholds`
- Auth: none declared
- TypeScript: <https://skmtc.dev/ripple/apis/ripple-custody-api/docs/v1/domains/:domainId/sweep-thresholds/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns min sweep thresholds for every asset supported by Custody, optionally filtered by ledger. The list is composed from the live Custody ticker/ledger catalog: assets without an explicitly configured threshold default to "0" (immediate sweep) and carry no id/createdAt/updatedAt.

## Path parameters

- `domainId` string, uuid, required

## Query parameters

- `page` integer
- `size` integer
- `ledgerId` string

## Response `200`

OK

- OmnibusSweepThresholdPageResponse
  - `content` OmnibusSweepThresholdConfig[], required: Sweep threshold configurations in this page
    - `id` string, uuid: Unique identifier of this threshold configuration. Absent for assets that have never been explicitly configured (implicit "0" default).
    - `domainId` string, uuid, required: Domain ID (1:1 with omnibus)
    - `tickerId` string, uuid, required: Custody ticker UUID
    - `tickerSymbol` string, required: Ticker symbol (e.g., "BTC", "ETH", "USDC")
    - `tickerName` string: Full ticker name (e.g., "Bitcoin", "Ethereum")
    - `tickerDecimals` integer: Number of decimal places for this ticker
    - `ledgerId` string, required: Custody ledger ID (e.g., "ethereum-mainnet", "polygon-mainnet")
    - `ledgerName` string, required: Human-readable ledger name (e.g., "Ethereum", "Polygon")
    - `contractAddress` string: Smart contract address for token tickers (e.g., ERC-20 USDC address). Null for native assets like BTC, ETH, XRP.
    - `minSweepAmount` string, required: Minimum sweep amount in the ticker's smallest unit (e.g., satoshis for BTC, wei for ETH). Set to "0" for immediate sweep (no threshold).
    - `minSweepAmountFormatted` string: Human-readable formatted amount (e.g., "0.1 BTC", "25 USDC"). Calculated from minSweepAmount using tickerDecimals.
    - `createdAt` string, date-time: Timestamp when this configuration was created. Absent for assets that have never been explicitly configured.
    - `updatedAt` string, date-time: Timestamp when this configuration was last updated. Absent for assets that have never been explicitly configured.
    - `version` integer: Optimistic-lock version of the stored row. Absent for assets that have never been explicitly configured (implicit "0" default, no row). Echo this value back in the matching SweepThresholdUpdate on save.
  - `page` OmnibusPageMetadata, required
    - `number` integer, required: Current page number (0-indexed)
    - `size` integer, required: Number of elements per page
    - `totalElements` integer, required: Total number of elements across all pages
    - `totalPages` integer, required: Total number of pages
    - `first` boolean, required: Whether this is the first page
    - `last` boolean, required: Whether this is the last page

## Other responses

- `400`: Invalid request (e.g., malformed domainId or ledgerId)
- `403`: Caller is not permitted to access this domain's thresholds
- `404`: Domain not found

---

[API](https://skmtc.dev/ripple/apis/ripple-custody-api.md) - [All operations](https://skmtc.dev/ripple/apis/ripple-custody-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ripple/apis/ripple-custody-api/revisions/c6f0ad6b70c0?raw)