Skip to main content
The Manual Sweep endpoint consolidates the entire balance of a specified non-omnibus address into the omnibus wallet for the same asset. Use this endpoint when you need to manually trigger a consolidation that would otherwise wait for the automatic sweep schedule, for example to free up funds urgently or to close an isolated address. The sweep creates an on-chain transaction, so gas fees apply on EVM-compatible and similar networks — ensure your Gas Tank is funded before invoking this endpoint.
Important constraints before invoking a sweep:
  • Manual Sweep only works for non-omnibus addresses. Attempting to sweep an address with omnibus: true will return an error.
  • Manual Sweep moves all of the specified asset’s balance from the address — partial sweeps are not supported.
  • Manual Sweep may fail silently or be delayed if your Gas Tank has insufficient funds to cover the network fee.

​
Request

​
string
required
Your Finrock API key.
​
string
required
Your JWT bearer token in the format Bearer {JWT}.
​
string
required
The asset to sweep. Use the asset_name value from the Supported Assets list (e.g. ETH, USDT_ETH).
​
string
required
The non-omnibus deposit address whose full balance you want to sweep into the omnibus wallet.

​
Example Request

cURL

​
Response

A successful request returns HTTP 200 confirming that the sweep transaction has been queued.
​
string
Indicates the sweep request status. Typical value: queued.
​
string
The Finrock transaction ID for the resulting on-chain sweep transaction. Use this with the List Transactions endpoint to monitor the sweep status.
Sample 200 Response
​
object
Returned when the x-api-key or Authorization header is missing or invalid.
Sample 401 Response
Before calling this endpoint, verify your Gas Tank balance using the Gas Tank Balance endpoint. On EVM chains, a sweep transaction for a token like USDT_ETH consumes ETH from the Gas Tank, not USDT.