API Documentation

Parameters

delegator_address

• Type: string
• Required: Yes
• Description: Address of the wallet that created the stake

stake_id

• Type: string
• Required: Yes
• Description: ID of stake to withdraw

network

• Type: string
• Required: Yes
• Enum Values: mainnet, testnet
• Description: Network withdraw is on.

Responses

201 Success

• Type: object
• Properties:
  • data: object
  • network: string
  • unsigned_transaction_serialized: string
  • signing_payload: string

400 Bad Request

Example Request

curl --request POST \
     --url https://api.figment.io/sui/withdraw \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-api-key: your-api-key-here' \
     --data '{
  "network": "mainnet"
}'

Example Response

{
  "data": {
    "network": "mainnet",
    "unsigned_transaction_serialized": "0000020008002f68590000000001010000000000000000000000000000000000000000000000000000000000000005010000000000000011002022b35a7481fb136e5585c43421cf8ab49d0e219e902dedc40c2778acdcc7bc9c020200010100000000000000000000000000000000000000000000000000000000000000000000030a7375695f73797374656d11726571756573745f6164645f7374616b6500030101000300000000010200dab0f88cdcc6281a1b74fa3c446d7998c0661c5a3caf37aad9251084aac6704d0344884f0461ab5e78d6690949921757b5c4fe19a081870fda3e597df1c66d630b8811d01400000000209aea917ded43a1145b2f857de7e43b0cf80eca2521bb8ee2e42f1dfaea17ad9b9348579e59a296d072b82d689826b8fc9aa5d910131bbb17d9ae5b63b29c485c8011d014000000002005ef066056d418d07485520e95768c0e5534817fbb35c9ca74d3bf3cc3756679a04f3df578ee6b82df8f6bec1ebef360d373ca4dcdfabbc4362a009d41cccd8b8011d0140000000020c11e6d6cb8d6f7c447bc3a4643e7fab83eeefa4f52257278c543807f4ec916f7dab0f88cdcc6281a1b74fa3c446d7998c0661c5a3caf37aad9251084aac6704de80300000000000000e1f5050000000000",
    "signing_payload": ""
  }
}