Skip to main content
Auto-sweep moves the money from each of your users’ addresses into your master wallet on the same network, once it reaches an amount you choose (the minimum). This endpoint shows and changes that minimum, for each network and coin. Each network also has its own on/off switch, in Dashboard → Wallets → Settings → Auto-sweep. The auto_sweep field here combines the two, and sweeping only happens when both are on. If you switch a network off in the dashboard, nothing is swept there, whatever you set here.

Endpoint

To read it, your key needs wallets:read. To change it, wallets:write.

Reading your configuration

There’s one entry for each coin, on every network where you have a master wallet.
boolean
required
Whether this network and coin will actually be swept. Only true when chain_auto_sweep and auto_sweep_configured are both true.
boolean
required
What you’ve set for this coin, by itself.
boolean
required
The network’s switch in your dashboard. You can’t change it here. Use Dashboard → Wallets → Settings.
number
The minimum you set, in the coin. null if you haven’t set one, in which case default_min is used.
number
required
The minimum actually in use: your configured_min, or default_min if you haven’t set one, and never lower than minimum_allowed.
number
required
Used when you haven’t set a minimum. A few cents on Base and the other cheap networks. Higher on Ethereum, where moving small amounts can cost more than they’re worth.
number
required
The lowest minimum you can set on this network. If you ask for less, we use this instead of refusing.

Changing your configuration

string
required
The network to change. You need a master wallet on it already.
string
required
USDC or USDT.
number
The minimum, in the coin. If it’s below minimum_allowed for the network, we raise it to that instead of refusing. Leave it out to keep your current setting.
boolean
Turn sweeping on or off for this coin. Leave it out to keep your current setting. You need to send at least one of min_amount or auto_sweep.
You get back one entry like those above, under sweep_config.

Errors