Vault Shareholders

private/request_vault_withdraw

Submits a signed withdraw action that enqueues a request to burn a given number of vault shares and redeem the proceeds to the user's subaccount. Inputs are the vault subaccount and the share quantity to burn (decimal string). Returns an acknowledgement with the queued request; requires the user-withdraw permission.

post/private/request_vault_withdraw

Request

  • Base URL: https://api.derive.xyz/v3
  • URL: https://api.derive.xyz/v3/private/request_vault_withdraw
  • Auth: none declared

Request body

noncestring required
shares_to_burnstring decimal required

Number of vault shares to burn, as a decimal string.

signaturestring required

0x-prefixed hex of the 65-byte EOA signature.

signature_expiry_secinteger required
signerstring required

20-byte Ethereum address as a 0x-prefixed lowercase hex string.

subaccount_idinteger required

The subaccount the action is signed on; which subaccount applies depends on the specific method — see that method's reference.

vault_subaccount_idinteger required

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.