For the complete documentation index, see llms.txt. This page is also available as Markdown.

unsafe_requestWithdrawStake - IOTA

Example code for the unsafe_requestWithdrawStake JSON-RPC method. Complete guide on how to use unsafe_requestWithdrawStake JSON-RPC method in GetBlock Web3 documentation.

Builds an unsigned transaction that withdraws a previously delegated stake, returning principal and rewards.

Parameters

Parameter
Type
Required
Description

signer

string

Yes

Staker address

staked_iota

string

Yes

StakedIota object ID

gas

string

Optional

Gas coin object ID

gas_budget

string

Yes

Gas budget

Request

curl --location --request POST 'https://shared.eu-central-1.getblock.io/<ACCESS-TOKEN>/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "jsonrpc": "2.0",
    "id": "getblock.io",
    "method": "unsafe_requestWithdrawStake",
    "params": ["0xabc...", "0xstake...", null, "10000000"]
}'
example.js
const axios = require('axios');
const response = await axios.post('https://shared.eu-central-1.getblock.io/<ACCESS-TOKEN>/', { jsonrpc: '2.0', id: 'getblock.io', method: 'unsafe_requestWithdrawStake', params: ["0xabc...", "0xstake...", null, "10000000"] }, { headers: { 'Content-Type': 'application/json' } });
console.log(response.data.result);
example.py
import requests
response = requests.post('https://shared.eu-central-1.getblock.io/<ACCESS-TOKEN>/', headers={'Content-Type': 'application/json'}, json={'jsonrpc': '2.0', 'id': 'getblock.io', 'method': 'unsafe_requestWithdrawStake', 'params': ["0xabc...", "0xstake...", null, "10000000"]})
print(response.json())
example.rs
use reqwest::Client;
use serde_json::{json, Value};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let res = client.post("https://shared.eu-central-1.getblock.io/<ACCESS-TOKEN>/").json(&json!({"jsonrpc":"2.0","id":"getblock.io","method":"unsafe_requestWithdrawStake","params":["0xabc...", "0xstake...", null, "10000000"]})).send().await?.json::<Value>().await?;
    println!("{}", res["result"]);
    Ok(())
}

Response

Response Parameters

Field
Type
Description

jsonrpc

string

JSON-RPC version ("2.0")

id

string

Request identifier ("getblock.io")

result.txBytes

string

Base64 BCS transaction bytes to sign

Use Cases

  • Unstaking: Build a stake-withdrawal transaction

Error Handling

Error
Message
Description

-32602

Invalid params

A parameter was missing or malformed

-32601

Method not found

The method name is misspelled or not served

403 / RBAC: access denied

Access denied

The GetBlock access token is missing or incorrect

Was this helpful?