Skip to main content
POST
Try Cobo WaaS Skill in your AI coding assistant (Claude Code, Cursor, etc.). Describe your needs in natural language to auto-generate production-ready SDK code and debug faster 🚀

Authorizations

BIZ-API-KEY
string
header
required

The API key. For more details, refer to API key.

In the API playground, enter your API secret, and your API key will be accordingly calculated.

Body

application/json

The request body to create an auto-sweep task.

Wallet and token information required to create an auto-sweep task.

wallet_id
string
required

ID of the wallet where the token will be swept.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

token_id
string
required

ID of the token to be swept. You can retrieve the IDs of all the tokens you can use by calling List enabled tokens.

Example:

"ETH_USDT"

min_balance_threshold
string

The minimum token balance threshold for auto sweep. If the token balance of an address is less than this threshold, the address will not be swept.

Example:

"0.01"

Response

Successfully created auto-sweep task.

Auto-sweep task information.

task_id
string<uuid>
required

Auto-sweep task ID.

Example:

"aff0e1cb-15b2-4e1f-9b9d-a9133715986f"

wallet_id
string
required

Wallet ID.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

token_id
string
required

Token ID of the swept token. You can retrieve the IDs of all the tokens you can use by calling List enabled tokens.

Example:

"ETH_USDT"

status
enum<string>
required

Auto-sweep task status:

  • Submitted: The auto-sweep task has been submitted.
  • TransactionCreated: The auto-sweep task triggered one or more token sweeping transactions.
Available options:
Submitted,
TransactionCreated
Example:

"Submitted"

created_timestamp
integer<int64>
required

The time when the task was created, in Unix timestamp format, measured in milliseconds.

Example:

1610445878970

transaction_ids
string[]

IDs of the transactions triggered by the task. This array is empty while the task status is Submitted, and is populated only after the status becomes TransactionCreated. Poll Get auto-sweep task details until the transaction IDs are available.

failed_reasons
string[]

Reasons why the task creation failed.

updated_timestamp
integer<int64>

The time when the task was updated, in Unix timestamp format, measured in milliseconds.

Example:

1610445878970