Skip to main content

list_sweepable_addresses

Get a list of sweepable deposit addresses ordered by highest sweepable balance first. This method is useful to find deposit addresses to sweep.

Parameters​

  • currency: (string) [required] The currency of sweepable addresses.
  • limit: (int) [optional] Limit results per request. Between 1 and 200. Default 50.

Returns​

An array of objects containing:

  • address: (string) The deposit address.
  • balance: (string) The sweepable balance of the address in the currency provided in parameters.

Example​

Request​

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "list_sweepable_addresses",
  "params": {
    "currency": "SOL",
    "limit": 20,
  }
}

Response​

{
  "id": 1,
  "jsonrpc": "2.0",
  "result": [
    {
      "address": "5Y3otkM2pBZHwBnEr1woXLumyykow8tsEu6LYQ1u8ZJ6",
      "balance": "10",
    },
    ...
  ]
}