Governance Read API

iotax_getCommitteeInfo

Return the committee information for the asked epoch.

Parameters

epoch< BigInt_for_uint64 >

  • Required: no

  • Description: The epoch of interest. If None, default to the latest epoch

Result

IotaCommittee< CommitteeInfo >

RPC representation of the [Committee] type.

Parameters

epoch< BigInt_for_uint64 >

  • Required: yes

validators<[ AuthorityPublicKeyBytes, BigInt_for_uint64 ]>

  • Required: yes

Example

Gets committee information for epoch 5000.

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "iotax_getCommitteeInfo",
  "params": [
    "19"
  ]
}

Response

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": {
        "epoch": "19",
        "validators": [
            [
                "gKPp7Gab6+i8KuWl7JgAXg8qgQ6T4Srzpa02cwK+tvOq0zIq8Ma9kCtyEKD604BeBjls9uxNRZj3tkcYIsTI7Z4WCINMfMb4FLQqSqZVxDVVH+XF//dip505b8Zkp0AJ",
                "128"
            ],
            [
                "gWZ1ZRkn0PswgR/mNtobDIpRbwo8KzLo3hEjeOz6xFhrI22AHt1pzbgAFwTtkP02DYCjAotyPK/8rMhi5vDQKGx5YQj2SnqJIa6LsHX+e7jouBdzmwUsDJgiKq4OUb+Y",
                "148"
            ],
            [
                "gZ2uj3g2zCCK7xB2v1exB8JSzOEQasgnuYNWMzvzP6aQV1ejDFpWfpb57wVyMVVHAmLMpj2hUB+xskyggzMR1Pd659Dy798pfAcARUVkXc1IK3tFnHDWQXKRFNzGj5Wv",
                "63"
            ],
            [
                "hHzGCUR/4/mB/zuzNFBCt45TMsmWM0B2kucL8Ex5K+r8qgNcIprG2Sb0yeRmJjNfAAnUIzHZJGcvmVIAiqY6KvZ16FZPu6saySbXd6h10u8isz8JqQL/06Xitj4mBiDZ",
                "102"
            ],
            [
                "hTWHRiKBVZfW6iJvlcrlD2rMHsRnNOzLkTVituZ8W461f4aIKxsBmBfOGNKztsifCgijAu7z/puh6jg+5TAn2s5iXRm6FGmnUeGfWbghbbUYQpZ8VJ3EbQLhKhMz9bfw",
                "29"
            ],
            [
                "hhTzcuJ0oEm+i3IQsoLp3tIODqhN69i6CcF2BiM6D/zzrNz7WTpYs1UFCLG1hp01AP314/jW/NoZ/esH6LvVwFDWu3LlL78rpUMnrob+jxzUpFszfGGRG1HVBthRsthH",
                "587"
            ],
            [
                "hy/+kVBh6YuB4CGVXW8hNElaljqEh2HnaYANSdyzb4LXbyc1mTzgwqsimmPdNI8gEqhEX7aEcT4NtvzWaDCfkMICc6YDvQW23D1fFpVMDM5iGTCAa0i6eDG6GUMOfdX6",
                "39"
            ],
            [
                "icZ9GiDCDwB/WNoDeIw6jOM1UM+ddxNOkLCLLjcjd+WY+37wJVKvOwXBOYJmTh3EBW4nhqU7Nf/MPElfBfkfkPoGZeKOUvpGodfSnNrrtguIzvfFBi8T/hp10qTT5h0B",
                "679"
            ],
            [
                "ijoRpB3xQchNO4aCseX5XnDWnDl5b+j4vREyH33xZxBHgYHpqIf48DqFsTu4YPIwFmb0/PXzk9W15xThFQyGyhdWZPX6m4WAvJXc0oZ0ovXVfB+h+FjcbAsh7jsjgit5",
                "239"
            ],
            [
                "jijGbS8l4Bumbsn4M/yrOuI80tGALdbzW/l4Su34Ivv4WTT5aNlQUCnrBbEKLaj3BisNH/ljGBrfqyr1dijk9CbPJZNnj+QoAUnMo+ajyZFdoa956bt3CCUsg7vQpAG4",
                "27"
            ],
            [
                "johkJT3OqaY2lXP0Hzd8KTVfcNV4+zWdYXOwskYTLC0g9bParH2QqS0FQH9YtHFhGfmavua5FZzb+7ysFBQ+IUspApWI+AmeAL7qtLzl7jzm+ynsEPeQlXw9Kr7NRnif",
                "151"
            ],
            [
                "kLrP0Q3NqtDlkyejopuZWUx1Vr2LqyV+gZA9kGBF1mLor+JTgAKmi9VZSy+SNyurFZRHhgjU8cgmJxue4m5sQqiUtrkKP2U+RMfkOKYe/52B+KbNl99fIaazYOA4KaHW",
                "68"
            ],
            [
                "kXeLTvnQRELGiNIeeFtDuCkpDWnxWSzB7WxJjhlogoRWvnKRnXcWwNh+Zet+8zWkFeaoCNcbn0g5PNjgsVPBfVV1HwOY1BYVsgFbee6/1QN1LntMWHi36cQvp0KCaI8j",
                "1000"
            ],
            [
                "kyBbPYwIiDZem27GyrOHr5yD4ewWrbbtZmVbAUzoecQT3DoHe0anS3ayLpsPje+MB7ws8y/iInfcQxAighAAs6wi6tt2h5JZAStxEbi+P50haPjL5e1wUqnyOjfj111+",
                "770"
            ],
            [
                "k1OxOao6iWcvF1AWcibYIatMqwb4RypNG+58/6rxcF19bTuqfTERzenAWWfbMHBCCJ+GzVPAaZ4a9dU50oYn1s/DDrcUlOiulk5ILBSAfuKRQ1NQo8z257nr7r/wPIdS",
                "153"
            ],
            [
                "k8VmGJo7bgj+oREst8BJcnuygLXCLjvoVN/89LDr9SIxTYYCJ+2xIGE2o7KHg7JBAt8AXpHj1EQhbP+Du8HJiY1h7ZcWOBB3ZWWczB7joue+YKtbgCVgi459bQuubmC0",
                "205"
            ],
            [
                "lRD5YttK/W6vfUm4+V//722Y4U00+KL2pB6L3JFyG8P9pTolDtalHw4xZd7XemMaGDoVZW2+Ua5JcBR/t/VbmYiq9IgHpRhEh1yscpS1dBhWywrYflTjA3+7qKNgmZHE",
                "48"
            ],
            [
                "lYNhfkGPZgScY+uOtTqnZSVQiPdWYbBFu4keS51+XP3lu5s+2VPoCxbWB6x7KK2lBqThhAXH5+XViTJBKtE5eMPAzP2+OFrBkS4qBrBtavO6JTI7+vWzNFScDf7Gh9ls",
                "31"
            ],
            [
                "lfJX3LT/mH4KPJSLpJEakW4/rh2rOK9AzIosoLhZVSoNhYarF1Ff4LWwtOPDeqd1GOVQSQ1vU7oY9gzzw83UUFF88x2F1rgb8VOMXMfldYncKyI4DOOwOY+IymSPHQ97",
                "703"
            ],
            [
                "lhIZeDtLMR4DruNhpfnThWZyCPtWD8k7rDfDsupbwjicQhdPJCt+xmy9m9xkPEbWEtx+HAYAwSOnqTEG7uaIjXkU7DZX1aPDt3Lrl1f8UmOU9h+J1wxoStnoHRGAxP9j",
                "399"
            ],
            [
                "lpu4IBjUgKb7kWulR0Lhjy5DNoFoYxjdFQ1ZK0OIVHv/NWtAXNlyjCOOpNZ0KQiXCW7UnGXjUYSQJc4AN4rzc6WX5pRS8ioRlgQAFOs+odTPP1byfTRSlX+tYw0OkFds",
                "52"
            ],
            [
                "lriM1dR1cG+7U50eFW8gwOPbEmHbOCOWnRcoRHojvd/Az8W3SqrMGYWr8r9JO7y5E09T1/0YyjFTbMNXRTH9FkYx1NF2cKDCufHRFMy375SrWj6fGyLCkiMGBCPDXTWS",
                "114"
            ],
            [
                "l8NQdrUdPCS0L3vIDZaaVhvk5yEB8xEakeYeVmLRFk4QhvmlLOAMprHC6LtmfyvoDUUdkGH0KpW3Rb5cdPM1MoEK58Nlo7vb8Mzqild64x0Mh+3vhyjRLIby/mKfXenI",
                "78"
            ],
            [
                "mI/SgQmWot7w5p8xNN2TtYZk1drRQt5QVN7ACTBH9bMgwJ3tf137Fk0xTRU7uTegAeYqNovG7/TxXmNpugEk7nImWOb4RObXFG8yYt/ZanOpAvKP6FeyK9Mb3g0AkV6t",
                "245"
            ],
            [
                "mRSj0PPtggobXq0iY6x87vt5l3aNlehRiFHbx89hUwsrTGpRIKSIE198dji4a67vEoN82wGJ7fWTK9JSugv8wqOckmzsTEWv/mpY2cCWYu+92cxXAHPEo1gNWuhykx8j",
                "85"
            ],
            [
                "oSWCPmX4HS8FWhx+mZ59UK5bbLpNl/yVYABFphLgvRk71zzO2gdDP92lE75oIi3OCHSjzB4tvN0saGIGwFuOClM9GodVFYjYnyiAJPk3/netzgLX0w006eEo3MyUFc5V",
                "89"
            ],
            [
                "oscbbnH48NsCqOFVpZLYgU0WlipGnj4505XFiZYaEMLs2ZLU1bKO2xW5jYCV+PaXE3gtPWQc+Mve9ARc8G5+aRKrZezeDHHnbBrFUyivpolU1uvD95Hl+XOCoUuw3c2T",
                "58"
            ],
            [
                "o8O0cMqSdUJHuZ+odfFGcfDNUJ93m1Uf1SsaAdT6DgIzzC/Q5sx4RFr0SKYehpHoDKvREn90epPKBAS8DoI05W6hlXTP1bRAHCU7rpUWdn9Q0wE9vihOwGzLDBgnVLfR",
                "40"
            ],
            [
                "pO4fIt0aLU1UXnFq7KH1Vt9qnHYR/gcr8shLa0Gayol7urG7hL5DjMArWQ+tnF4tCIIln5TCQg5+XgDVKlUfrVqPSmhggzo1V8ISZT1zhrgYPwRIhhHfDatrUKXE4sXA",
                "265"
            ],
            [
                "pw1zaRlq6enRmUmSAH5UaaayekUQd6OSAKSFjOmQgvxyIH2+AjQPWwCxeyWB8kCAA0sc1ekdsMBMf/F6Qb59KVDJRid3NhmcKzcBuiAYbIJtcD7VI49TXzZVH3RncCPH",
                "54"
            ],
            [
                "p4ibPh4xT0tnRbrNacvKisM27KMAaCaa/175dca7JcvhkWmfb1CJOhA7ZPDku1BTCySAbhE+wGWhjChyEL6m6peUia4zrjEAVG8WwCdh1rdGZ2hRu1uqdohqM1eaTDt0",
                "319"
            ],
            [
                "qHQsP3RT8Gr23qmjwiCX4kDRDoSMrrMD/jTOjM9YcarV1aqoMegmJTG3LKbyjN3eBlocY961bm84HnNixzIkpC72lEHgDt4bwpMs52ywwaC1NOj1/okqSVDhjDO233Y4",
                "65"
            ],
            [
                "qgspYG1KMFH4ipB2LdlBayNsT2/jG0y/ey17+Y/IUzKTTZfk+d6SYdYEN2JsRnAGFzV+1099IvYqgffTA8HMUhQRa+KICn7713FzIgSX8ddGAB5zIXz2/pJGtrbtvKmk",
                "98"
            ],
            [
                "qhmnJ6Q/S0WZ1woF4vCfdSQsF0MLBCm1i27jesvZHNQu6l2LxBa2SswI1JZfMB/PFC4A+BbgS3I5Td9w0ryGpic9kM+ctVElCAKGLgk2nCM6DwwhpqANLuiIJSabN56y",
                "174"
            ],
            [
                "qom1ijhByfxPU91ci+xuye9sXPBZqZ1FAyP8t7l8Vyufy7pyVr2R5ed1q4vcc5n+Dtl8zCAw3ZSaM0GI+c0zdTj91hoVVUQxRghjsTmdx9tvGYUN1EaOHpmceScQIUJ4",
                "40"
            ],
            [
                "qv3iWLaNJfDa32WNq0M1BiLQoEjr5W6KQB1r/D/t5q0KaTS0cfUxagh0vOa0vT+HBcjd4EBays5BiPlDvmz6wxguobxZe7ancr7EoAxIXKBorqbVBzN+16KRRO2xUv0v",
                "32"
            ],
            [
                "rHZRjAQ6hFMUHZl46aS7O0Bp23lIpQ+/sB305tKsUUEd2sXqq+1/7Wzuht3wTd5iAFIkjOWwkYBZ1iMmzL7kVFeRTX9m2utXB2Pvv4JirpwIG/WBi+jXZJTfXfQ6wkCR",
                "84"
            ],
            [
                "rRVZ02IBv58LJxUd0+Oc3I/sq9Z8gX6hh4P23VVcOFRPx4yBQuTENV8iNZ/oUttoAELF+/gZ+dKLo3nKqc1ksOfWL/r/r4rr31aXo/FXwh2hI5Rs+4m9svWoiAa+itez",
                "134"
            ],
            [
                "rjhqEn0rkImOgC2Jf2oGzbVbhs6Tr+nhxE1xMG2g0BsoSMJBG3cjskfUPCJqt6njASv3ErGQJYdAifQtUGvkxwZaljVPon9I5i+7MOjsv7YsN7cgrDhRr0THGeslzbMl",
                "279"
            ],
            [
                "rmF6UAvZn5PFJfMXnzXiU8IRZuiZWmAmKDISee5olY0uqsE/f2+e44irXcJCI6wuGEYHsH6X2zEcTT3Y5I7akpR5DfmO5RRZ3ADAYzjMJOPX2xCpa3b0UaEt25hHuKy8",
                "629"
            ],
            [
                "sAnTTus78Rbsq5+Uj9IWnoNT5WqbpSnwBniznX6siExLsRbT34cIE9+nsnjzpe2yA4bGO0HYJi/OKB/Z9DxOG3vi0Z0RF/TAYgziVyhHfAGJgdxn5QrV9blDdEdtxlJP",
                "49"
            ],
            [
                "s7BO0UzfNKdMkNLmwxe4CaUCrggBMjLQq4NRLXzYDPrxSWxQifwz/GoDMq8nAy41D0qV+t67PqqXbHHk3Y1TtqjYfCPVIZ7jMNkfDgjW5tiM96pXzrbmeoToXAtzzymq",
                "137"
            ],
            [
                "tJyZfhE5kREmXXOsQQNFdrXyxFL+s2Qi3zl2E1BGEOVpR2+tctkN8xA603WdtrCAEfPuN0XIAarXw9Lrwb6u6eONDZXIS18JEiW2faTmVtiEZnSiCEhxe4ABRNu2qoRu",
                "412"
            ],
            [
                "tXrcOA6wjjpgvyAnNPiU7j5ff5WTrq06rame8j5ufJhCSSQo5bSTWWKZimFz4vKaFx+LFzi+pgYI489QhNrwu7CFNAmkE8Qz0hRJHSLyBfwoafldRqXMXV71+/1x+qgD",
                "80"
            ],
            [
                "td7DZu4uui9CvHOqa6DhAq9L8ftUCnfoOl+tgjGSvM/e/jp3W1MFytLPzuIHblZOGIEaQttVMRJJHptx0jRNMgXu5xX6TIuVVnx3Lyb4ulPgZov8wBoqnFrTcQOpY/kZ",
                "485"
            ],
            [
                "tob4mXSb3pMUbmuNv75LQqNBlkpqNruPA3aOpZ2vyWtbGP1VIeHQJRbasI33cvScBIHYOkD3l7FYpjvX1cxNNtyim7/7noKqmguO/GQQSUNEq8Q6OKuDV/h7lvmaZ+m0",
                "124"
            ],
            [
                "tx7lDXhCUIJZnhlgA5LwSMR8ZC6EN/alnI3yz/ApMnuqHyVH7mpb+bciloJoT3fOB/6nfFYDVC7liHbLbiDByAeEvS3c9ZPeQmNoIA6p9PtynNpExHYlOIjPfyTuEVSO",
                "52"
            ],
            [
                "t1Hfo+2JUEmk2VJB73nTlMPVYDr9L3rYH9JQ67AiILmqKpA8PmHrffIN0MafI3k7CeFInMEbrf3CXTINsL1uAsGNAB5YwZHHEAaDC093q3FP6SsIOuBqp4soe5b6fJF/",
                "70"
            ],
            [
                "t7PE+yfPjCI+GoJeAqcGgYyz5m8WlkblFhE9ex9MndvuauSnXZFUt3AXrc8NxO3TEophCkPgHSyEz0IaaH24/75B/77TbdA5CHoBHyX2UoJIy/w5j3EHy9W3lyQa48NL",
                "52"
            ],
            [
                "uRJh2edhdYlux48+XdMW4wwziy1K9UVhVVAhTSCn4lJqhRiuusXRVmhDCcr3va7sBxnA5uyUVTl6O0Uik7wxPp1fVwMPOHRLwY4JLC3yASAxW/eoOV7YUo1Y48G+nVmN",
                "36"
            ]
        ]
    }
}

iotax_getLatestIotaSystemState​

Return the latest IOTA system state object on networks supporting protocol version &lt; 5. These are networks with node software release version &lt; 0.11.

Parameters

none

Result

IotaSystemStateSummaryV1< IotaSystemStateSummaryV1 >

This is the JSON-RPC type for the IotaSystemStateV1 object. It flattens all fields to make them top-level fields such that it as minimum dependencies to the internal data structures of the IOTA system state type.

Parameters

activeValidators<[ IotaValidatorSummary ]>

  • Required: yes

  • Description: The list of active validators in the current epoch.

atRiskValidators<[ IotaAddress, BigInt_for_uint64 ]>

  • Required: yes

  • Description: Map storing the number of epochs for which each validator has been below the low stake threshold.

epoch< BigInt_for_uint64 >

  • Required: yes

  • Description: The current epoch ID, starting from 0.

epochDurationMs< BigInt_for_uint64 >

  • Required: yes

  • Description: The duration of an epoch, in milliseconds.

epochStartTimestampMs< BigInt_for_uint64 >

  • Required: yes

  • Description: Unix timestamp of the current epoch start

inactivePoolsId< ObjectID >

  • Required: yes

  • Description: ID of the object that maps from a staking pool ID to the inactive validator that has that pool as its staking pool.

inactivePoolsSize< BigInt_for_uint64 >

  • Required: yes

  • Description: Number of inactive staking pools.

iotaTotalSupply< BigInt_for_uint64 >

  • Required: yes

  • Description: The current IOTA supply.

iotaTreasuryCapId< ObjectID >

  • Required: yes

  • Description: The TreasuryCap<IOTA> object ID.

minValidatorCount< BigInt_for_uint64 >

  • Required: yes

  • Description: Minimum number of active validators at any moment. We do not allow the number of validators in any epoch to go under this.

minValidatorJoiningStake< BigInt_for_uint64 >

  • Required: yes

  • Description: Lower-bound on the amount of stake required to become a validator.

pendingActiveValidatorsId< ObjectID >

  • Required: yes

  • Description: ID of the object that contains the list of new validators that will join at the end of the epoch.

pendingActiveValidatorsSize< BigInt_for_uint64 >

  • Required: yes

  • Description: Number of new validators that will join at the end of the epoch.

pendingRemovals<[ BigInt_for_uint64 ]>

  • Required: yes

  • Description: Removal requests from the validators. Each element is an index pointing to active_validators.

protocolVersion< BigInt_for_uint64 >

  • Required: yes

  • Description: The current protocol version, starting from 1.

referenceGasPrice< BigInt_for_uint64 >

  • Required: yes

  • Description: The reference gas price for the current epoch.

safeMode< Boolean >

  • Required: yes

  • Description: Whether the system is running in a downgraded safe mode due to a non-recoverable bug. This is set whenever we failed to execute advance_epoch, and ended up executing advance_epoch_safe_mode. It can be reset once we are able to successfully execute advance_epoch.

safeModeComputationRewards< BigInt_for_uint64 >

  • Required: yes

  • Description: Amount of computation rewards accumulated (and not yet distributed) during safe mode.

safeModeNonRefundableStorageFee< BigInt_for_uint64 >

  • Required: yes

  • Description: Amount of non-refundable storage fee accumulated during safe mode.

safeModeStorageCharges< BigInt_for_uint64 >

  • Required: yes

  • Description: Amount of storage charges accumulated (and not yet distributed) during safe mode.

safeModeStorageRebates< BigInt_for_uint64 >

  • Required: yes

  • Description: Amount of storage rebates accumulated (and not yet burned) during safe mode.

stakingPoolMappingsId< ObjectID >

  • Required: yes

  • Description: ID of the object that maps from staking pool's ID to the iota address of a validator.

stakingPoolMappingsSize< BigInt_for_uint64 >

  • Required: yes

  • Description: Number of staking pool mappings.

storageFundNonRefundableBalance< BigInt_for_uint64 >

  • Required: yes

  • Description: The non-refundable portion of the storage fund coming from non-refundable storage rebates and any leftover staking rewards.

storageFundTotalObjectStorageRebates< BigInt_for_uint64 >

  • Required: yes

  • Description: The storage rebates of all the objects on-chain stored in the storage fund.

systemStateVersion< BigInt_for_uint64 >

  • Required: yes

  • Description: The current version of the system state data structure type.

totalStake< BigInt_for_uint64 >

  • Required: yes

  • Description: Total amount of stake from all active validators at the beginning of the epoch.

validatorCandidatesId< ObjectID >

  • Required: yes

  • Description: ID of the object that stores preactive validators, mapping their addresses to their Validator structs.

validatorCandidatesSize< BigInt_for_uint64 >

  • Required: yes

  • Description: Number of preactive validators.

validatorLowStakeGracePeriod< BigInt_for_uint64 >

  • Required: yes

  • Description: A validator can have stake below validator_low_stake_threshold for this many epochs before being kicked out.

validatorLowStakeThreshold< BigInt_for_uint64 >

  • Required: yes

  • Description: Validators with stake amount below validator_low_stake_threshold are considered to have low stake and will be escorted out of the validator set after being below this threshold for more than validator_low_stake_grace_period number of epochs.

validatorReportRecords<[ IotaAddress, array ]>

  • Required: yes

  • Description: A map storing the records of validator reporting each other.

validatorVeryLowStakeThreshold< BigInt_for_uint64 >

  • Required: yes

  • Description: Validators with stake below validator_very_low_stake_threshold will be removed immediately at epoch change, no grace period.

Example

Gets objects owned by the address in the request.

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "iotax_getLatestIotaSystemState",
  "params": []
}

Response

{
  "jsonrpc": "2.0",
  "result": "some_system_state",
  "id": 1
}

iotax_getLatestIotaSystemStateV2​

Return the latest IOTA system state object on networks supporting protocol version >= 5. These are networks with node software release version >= 0.11.

Parameters

None

Result

IotaSystemStateSummary< IotaSystemStateSummary >

This is the JSON-RPC type for IOTA system state objects. It is an enum type that can represent either V1 or V2 system state objects.

iotax_getReferenceGasPrice

Return the reference gas price for the network

Parameters

None

Result

BigInt<u64>< BigInt_for_uint64 >

Example

Gets reference gas price information for the network.

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "iotax_getReferenceGasPrice",
  "params": []
}

Response

{
  "jsonrpc": "2.0",
  "result": 1000,
  "id": 1
}

iotax_getReferenceGasPrice

Return all [DelegatedStake].

Parameters

owner<IotaAddress>

  • Required: yes

Result

Vec<DelegatedStake><[ DelegatedStake ]>

Example

Returns the staking information for the address the request provides.

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "iotax_getStakes",
  "params": [
    "0x3befb84f03a24386492bd3b05b1fd386172eb450e5059ce7df0ea6d9d6cefcaa"
  ]
}

Response 

{
  "jsonrpc": "2.0",
  "result": [
    {
      "validatorAddress": "0x9a95cf69368e31b4dbe8ee9bdb3c0587bbc79d8fc6edf4007e185a962fd906df",
      "stakingPool": "0xb4eeb46b70f0bebcae832aeef9f7c5db76052ab656e5f81853d0cf701cdbc8eb",
      "stakes": [
        {
          "stakedIotaId": "0xf27ab513fc6ef8c344406c78da3d5ad3a5fcc295dc8803c15989a62d33ee8590",
          "stakeRequestEpoch": "62",
          "stakeActiveEpoch": "63",
          "principal": "200000000000",
          "status": "Active",
          "estimatedReward": "520000000"
        },
        {
          "stakedIotaId": "0x14cfd5e91c13a481370240e392464c329a203fb9f0a8158aaab9b2a90044b26e",
          "stakeRequestEpoch": "142",
          "stakeActiveEpoch": "143",
          "principal": "200000000000",
          "status": "Pending"
        }
      ]
    },
    {
      "validatorAddress": "0x14cc7fee4100fdcabda6d15c63c4b49c45ae23f2b936495cd38b1a4b04010295",
      "stakingPool": "0xbaa75ac72e548aeecf2ce8b4e88530651d6e8f93e0fb79b4bc65a512beb5b9f3",
      "stakes": [
        {
          "stakedIotaId": "0x378423de90ed03b694cecf443c72b5387b29a731d26d98108d7abc4902107d7d",
          "stakeRequestEpoch": "244",
          "stakeActiveEpoch": "245",
          "principal": "200000000000",
          "status": "Unstaked"
        }
      ]
    }
  ],
  "id": 1
}

iotax_getStakesByIds​

Return one or more [DelegatedStake]. If a Stake was withdrawn its status will be Unstaked.

Parameters

staked_iota_ids<[ ObjectID ]>

  • Required: yes

Result

Vec<DelegatedStake><[ DelegatedStake ]>

Example

Returns the staking information for the address the request provides.

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "iotax_getStakesByIds",
  "params": [
    [
      "0x6a8e0f8fea6fda5488462e58724c034462b6064a08845e2ae2942fe7c4ee816d",
      "0x754eb2eed23e6c6bb32c89fe1f21ab588374445e72e0402aea014b2956105799"
    ]
  ]
}

Response

{
  "jsonrpc": "2.0",
  "result": {
    "validatorAddress": "0x63ee67e81398729f87d81d62f399c041b0f8d0938923ea7e3917608ee62df437",
    "stakingPool": "0x6710024f81dd33ab6833482ee8034e779a48e6ef635c7f856df4905022458bfb",
    "stakes": [
      {
        "stakedIotaId": "0x6a8e0f8fea6fda5488462e58724c034462b6064a08845e2ae2942fe7c4ee816d",
        "stakeRequestEpoch": "62",
        "stakeActiveEpoch": "63",
        "principal": "200000000000",
        "status": "Active",
        "estimatedReward": "520000000"
      },
      {
        "stakedIotaId": "0x754eb2eed23e6c6bb32c89fe1f21ab588374445e72e0402aea014b2956105799",
        "stakeRequestEpoch": "244",
        "stakeActiveEpoch": "245",
        "principal": "200000000000",
        "status": "Unstaked"
      }
    ]
  },
  "id": 1
}

iotax_getTimelockedStakes

Return all [DelegatedTimelockedStake].

Parameters

owner<IotaAddress>

  • Required: yes

Result

Vec<DelegatedTimelockedStake><[ DelegatedTimelockedStake ]>

iotax_getTimelockedStakesByIds

Return one or more [DelegatedTimelockedStake]. If a Stake was withdrawn its status will be Unstaked.

Parameters

timelocked_staked_iota_ids<[ ObjectID ]>

  • Required: yes

Result

Vec<DelegatedTimelockedStake><[ DelegatedTimelockedStake ]>

iotax_getValidatorsApy

Return the validator APY

Parameters

None

Result

ValidatorApys< ValidatorApys >

Parameters

apys<[ ValidatorApy ]>

  • Required: yes

epoch< BigInt_for_uint64 >

  • Required: yes

Example

Gets the APY for all validators.

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "iotax_getValidatorsApy",
  "params": []
}

Response

{
  "jsonrpc": "2.0",
  "result": {
    "apys": [
      {
        "address": "0x27838b06db0346808ffb0676099de0408b31759f57b69c52e09410a66f9a23c3",
        "apy": 0.06
      },
      {
        "address": "0x4be9913b6697a5e83e02e2a0fc747057ba0901e4d9b1e04de75ea2699a441321",
        "apy": 0.02
      },
      {
        "address": "0x5612581eba57ebe7e594b809ccceec2be4dac6ff6945d49b3ecc043d049611f6",
        "apy": 0.05
      }
    ],
    "epoch": "420"
  },
  "id": 1
}

PreviousExtended APINextMove Utils

Last updated