Skip to main content
POST
Manage a yield position

Authorizations

Authorization
string
header
required

Client API Key or Client Session Token (CST). Pass as a Bearer token in the Authorization header.

Body

application/json
yieldId
string
required

The yield opportunity ID.

address
string
required

Wallet address managing the yield position.

action
enum<string>
required

The type of management action to perform.

Available options:
STAKE,
UNSTAKE,
CLAIM_REWARDS,
RESTAKE_REWARDS,
WITHDRAW,
WITHDRAW_ALL,
RESTAKE,
CLAIM_UNSTAKED,
UNLOCK_LOCKED,
STAKE_LOCKED,
VOTE,
REVOKE,
VOTE_LOCKED,
REVOTE,
REBOND,
MIGRATE,
VERIFY_WITHDRAW_CREDENTIALS,
DELEGATE
passthrough
string
required

Opaque token from a prior balance query's pendingActions entry, identifying the specific pending action to execute.

arguments
object

Optional yield-specific arguments. Which fields are supported depends on the yield opportunity's mechanics.

Response

Manage transactions built successfully

data
object