package iotexapi

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc EstimateActionGasConsumption (EstimateActionGasConsumptionRequest, EstimateActionGasConsumptionResponse)

  api.proto:61

  estimate gas for action and transfer not sealed

  message EstimateActionGasConsumptionRequest

  api.proto:280

  • oneof action

    • iotextypes.Transfer transfer = 1

    • iotextypes.Execution execution = 2

    • iotextypes.StakeCreate stakeCreate = 40

      Native staking

    • iotextypes.StakeReclaim stakeUnstake = 41

    • iotextypes.StakeReclaim stakeWithdraw = 42

    • iotextypes.StakeAddDeposit stakeAddDeposit = 43

    • iotextypes.StakeRestake stakeRestake = 44

    • iotextypes.StakeChangeCandidate stakeChangeCandidate = 45

    • iotextypes.StakeTransferOwnership stakeTransferOwnership = 46

    • iotextypes.CandidateRegister candidateRegister = 47

    • iotextypes.CandidateBasicInfo candidateUpdate = 48

  • string callerAddress = 100

  message EstimateActionGasConsumptionResponse

  api.proto:298

  • uint64 gas = 1

• rpc EstimateGasForAction (EstimateGasForActionRequest, EstimateGasForActionResponse)

  api.proto:58

  estimate gas for action, to be deprecated

  message EstimateGasForActionRequest

  api.proto:276

  To be deprecated

  • optional iotextypes.Action action = 1

  message EstimateGasForActionResponse

  api.proto:302

  • uint64 gas = 1

• rpc GetAccount (GetAccountRequest, GetAccountResponse)

  api.proto:24

  get the address detail of an address

  message GetAccountRequest

  api.proto:122

  • string address = 1

  message GetAccountResponse

  api.proto:126

  • optional iotextypes.AccountMeta accountMeta = 1

  • optional iotextypes.BlockIdentifier blockIdentifier = 2

• rpc GetActPoolActions (GetActPoolActionsRequest, GetActPoolActionsResponse)

  api.proto:90

  get actions from act pool

  message GetActPoolActionsRequest

  api.proto:405

  • repeated string actionHashes = 1

    if this field is absent, get all actions from actpool

  message GetActPoolActionsResponse

  api.proto:409

  • repeated iotextypes.Action actions = 1

• rpc GetActions (GetActionsRequest, GetActionsResponse)

  api.proto:32

  get action(s) by: 1. start index and action count 2. action hash 3. address with start index and action count 4. get unconfirmed actions by address with start index and action count 5. block hash with start index and action count

  message GetActionsRequest

  api.proto:131

  • oneof lookup

    • GetActionsByIndexRequest byIndex = 1

    • GetActionByHashRequest byHash = 2

    • GetActionsByAddressRequest byAddr = 3

    • GetUnconfirmedActionsByAddressRequest unconfirmedByAddr = 4

    • GetActionsByBlockRequest byBlk = 5

  message GetActionsResponse

  api.proto:198

  • uint64 total = 2

  • repeated ActionInfo actionInfo = 1

• rpc GetBlockMetas (GetBlockMetasRequest, GetBlockMetasResponse)

  api.proto:37

  get block metadata(s) by: 1. start index and block count 2. block hash

  message GetBlockMetasRequest

  api.proto:203

  • oneof lookup

    • GetBlockMetasByIndexRequest byIndex = 1

    • GetBlockMetaByHashRequest byHash = 2

  message GetBlockMetasResponse

  api.proto:219

  • uint64 total = 2

  • repeated iotextypes.BlockMeta blkMetas = 1

• rpc GetChainMeta (GetChainMetaRequest, GetChainMetaResponse)

  api.proto:40

  get chain metadata

  message GetChainMetaRequest

  api.proto:224

  (message has no fields)

  message GetChainMetaResponse

  api.proto:226

  • optional iotextypes.ChainMeta chainMeta = 1

  • string syncStage = 2

    sync stage

• rpc GetElectionBuckets (GetElectionBucketsRequest, GetElectionBucketsResponse)

  api.proto:99

  Deprecated

  message GetElectionBucketsRequest

  api.proto:416

  election APIs

  • uint64 epochNum = 1

  message GetElectionBucketsResponse

  api.proto:420

  • repeated iotextypes.ElectionBucket buckets = 1

• rpc GetEpochMeta (GetEpochMetaRequest, GetEpochMetaResponse)

  api.proto:67

  get epoch metadata

  message GetEpochMetaRequest

  api.proto:318

  • uint64 epochNumber = 1

  message GetEpochMetaResponse

  api.proto:322

  • optional iotextypes.EpochData epochData = 1

  • uint64 totalBlocks = 2

  • repeated BlockProducerInfo blockProducersInfo = 3

• rpc GetEvmTransfersByActionHash (GetEvmTransfersByActionHashRequest, GetEvmTransfersByActionHashResponse)

  api.proto:93

  Deprecated

  message GetEvmTransfersByActionHashRequest

  api.proto:425

  Deprecated

  • string actionHash = 1

  message GetEvmTransfersByActionHashResponse

  api.proto:430

  Deprecated

  • optional iotextypes.ActionEvmTransfer actionEvmTransfers = 1

• rpc GetEvmTransfersByBlockHeight (GetEvmTransfersByBlockHeightRequest, GetEvmTransfersByBlockHeightResponse)

  api.proto:96

  Deprecated

  message GetEvmTransfersByBlockHeightRequest

  api.proto:435

  Deprecated

  • uint64 blockHeight = 1

  message GetEvmTransfersByBlockHeightResponse

  api.proto:440

  Deprecated

  • optional iotextypes.BlockEvmTransfer blockEvmTransfers = 1

• rpc GetLogs (GetLogsRequest, GetLogsResponse)

  api.proto:73

  get logs filtered by contract address and topics

  message GetLogsRequest

  api.proto:358

  • optional LogsFilter filter = 1

  • oneof lookup

    • GetLogsByBlock byBlock = 2

    • GetLogsByRange byRange = 3

  message GetLogsResponse

  api.proto:366

  • repeated iotextypes.Log logs = 1

• rpc GetRawBlocks (GetRawBlocksRequest, GetRawBlocksResponse)

  api.proto:70

  get raw blocks data

  message GetRawBlocksRequest

  api.proto:328

  • uint64 startHeight = 1

  • uint64 count = 2

  • bool withReceipts = 3

  • bool withTransactionLogs = 4

  message GetRawBlocksResponse

  api.proto:335

  • repeated BlockInfo blocks = 1

• rpc GetReceiptByAction (GetReceiptByActionRequest, GetReceiptByActionResponse)

  api.proto:49

  get receipt by action Hash

  message GetReceiptByActionRequest

  api.proto:249

  • string actionHash = 1

  message GetReceiptByActionResponse

  api.proto:253

  • optional ReceiptInfo receiptInfo = 1

• rpc GetServerMeta (GetServerMetaRequest, GetServerMetaResponse)

  api.proto:43

  get server version

  message GetServerMetaRequest

  api.proto:231

  (message has no fields)

  message GetServerMetaResponse

  api.proto:233

  • optional iotextypes.ServerMeta serverMeta = 1

• rpc GetTransactionLogByActionHash (GetTransactionLogByActionHashRequest, GetTransactionLogByActionHashResponse)

  api.proto:75

• rpc GetTransactionLogByBlockHeight (GetTransactionLogByBlockHeightRequest, GetTransactionLogByBlockHeightResponse)

  api.proto:77

• rpc ReadContract (ReadContractRequest, ReadContractResponse)

  api.proto:52

  TODO: read contract

  message ReadContractRequest

  api.proto:257

  • optional iotextypes.Execution execution = 1

  • string callerAddress = 2

  • uint64 gasLimit = 3

  • string gasPrice = 4

  message ReadContractResponse

  api.proto:264

  • string data = 1

  • optional iotextypes.Receipt receipt = 2

• rpc ReadContractStorage (ReadContractStorageRequest, ReadContractStorageResponse)

  api.proto:101

  message ReadContractStorageRequest

  api.proto:444

  • string contract = 1

  • bytes key = 2

  message ReadContractStorageResponse

  api.proto:449

  • bytes data = 1

• rpc ReadState (ReadStateRequest, ReadStateResponse)

  api.proto:64

  read state from blockchain

  message ReadStateRequest

  api.proto:306

  • bytes protocolID = 1

  • bytes methodName = 2

  • repeated bytes arguments = 3

  • string height = 4

    optional, if not present, read from tip height

  message ReadStateResponse

  api.proto:313

  • bytes data = 1

  • optional iotextypes.BlockIdentifier blockIdentifier = 2

• rpc SendAction (SendActionRequest, SendActionResponse)

  api.proto:46

  sendAction

  message SendActionRequest

  api.proto:237

  • optional iotextypes.Action action = 1

  message SendActionResponse

  api.proto:245

  • string actionHash = 1

• rpc StreamBlocks (StreamBlocksRequest, stream StreamBlocksResponse)

  api.proto:84

  get block info in stream

  message StreamBlocksRequest

  api.proto:390

  below are streaming APIs

  (message has no fields)

  message StreamBlocksResponse

  api.proto:392

  • optional BlockInfo block = 1

  • optional iotextypes.BlockIdentifier blockIdentifier = 2

• rpc StreamLogs (StreamLogsRequest, stream StreamLogsResponse)

  api.proto:87

  get logs filtered by contract address and topics in stream

  message StreamLogsRequest

  api.proto:397

  • optional LogsFilter filter = 1

  message StreamLogsResponse

  api.proto:401

  • optional iotextypes.Log log = 1

• rpc SuggestGasPrice (SuggestGasPriceRequest, SuggestGasPriceResponse)

  api.proto:55

  suggest gas price

  message SuggestGasPriceRequest

  api.proto:269

  (message has no fields)

  message SuggestGasPriceResponse

  api.proto:271

  • uint64 gasPrice = 1

• rpc TraceTransactionStructLogs (TraceTransactionStructLogsRequest, TraceTransactionStructLogsResponse)

  api.proto:103

  message TraceTransactionStructLogsRequest

  api.proto:453

  • string actionHash = 1

  message TraceTransactionStructLogsResponse

  api.proto:457

  • repeated iotextypes.TransactionStructLog structLogs = 1

experiment

• rpc GetTransactionLogByActionHash (GetTransactionLogByActionHashRequest, GetTransactionLogByActionHashResponse)

  api.proto:108

• rpc GetTransactionLogByBlockHeight (GetTransactionLogByBlockHeightRequest, GetTransactionLogByBlockHeightResponse)

  api.proto:110

Used in: GetActionsResponse

• optional iotextypes.Action action = 1

• string actHash = 2

• string blkHash = 3

• optional google.protobuf.Timestamp timestamp = 4

• uint64 blkHeight = 5

• string sender = 6

• string gasFee = 7

• uint32 index = 8

Used in: GetRawBlocksResponse, StreamBlocksResponse

• optional iotextypes.Block block = 1

• repeated iotextypes.Receipt receipts = 2

• optional iotextypes.TransactionLogs transactionLogs = 3

Used in: GetEpochMetaResponse

• string address = 1

• string votes = 2

• bool active = 3

• uint64 production = 4

• string voter = 1

  hex string

• string votes = 2

• string weightedVotes = 3

• string remainingDuration = 4

  human readable duration

Used in: GetActionsRequest

• string actionHash = 1

• bool checkPending = 2

Used in: GetActionsRequest

• string address = 1

• uint64 start = 2

• uint64 count = 3

Used in: GetActionsRequest

• string blkHash = 1

• uint64 start = 2

• uint64 count = 3

Used in: GetActionsRequest

• uint64 start = 1

• uint64 count = 2

Used in: GetBlockMetasRequest

• string blkHash = 1

Used in: GetBlockMetasRequest

• uint64 start = 1

• uint64 count = 2

Used in: GetLogsRequest

• bytes blockHash = 1

Used in: GetLogsRequest

• uint64 fromBlock = 1

• uint64 toBlock = 2

• uint64 paginationSize = 3

Used as request type in: APIService.GetTransactionLogByActionHash, TransactionLogService.GetTransactionLogByActionHash

• string actionHash = 1

Used as response type in: APIService.GetTransactionLogByActionHash, TransactionLogService.GetTransactionLogByActionHash

• optional iotextypes.TransactionLog transactionLog = 1

Used as request type in: APIService.GetTransactionLogByBlockHeight, TransactionLogService.GetTransactionLogByBlockHeight

• uint64 blockHeight = 1

Used as response type in: APIService.GetTransactionLogByBlockHeight, TransactionLogService.GetTransactionLogByBlockHeight

• optional iotextypes.TransactionLogs transactionLogs = 1

• optional iotextypes.BlockIdentifier blockIdentifier = 2

Used in: GetActionsRequest

• string address = 1

• uint64 start = 2

• uint64 count = 3

Used in: GetLogsRequest, StreamLogsRequest

• repeated string address = 1

• repeated Topics topics = 2

Used in: ReadStakingDataRequest.Candidates, ReadStakingDataRequest.VoteBuckets, ReadStakingDataRequest.VoteBucketsByCandidate, ReadStakingDataRequest.VoteBucketsByVoter

• uint32 offset = 1

• uint32 limit = 2

• ReadStakingDataMethod.Name method = 1

Used in: ReadStakingDataMethod

• INVALID = 0

• BUCKETS = 1

• BUCKETS_BY_VOTER = 2

• BUCKETS_BY_CANDIDATE = 3

• CANDIDATES = 4

• CANDIDATE_BY_NAME = 5

• BUCKETS_BY_INDEXES = 6

• CANDIDATE_BY_ADDRESS = 7

• TOTAL_STAKING_AMOUNT = 8

• BUCKETS_COUNT = 9

• COMPOSITE_BUCKETS = 20

  10-19 reserved for native staking

• COMPOSITE_BUCKETS_BY_VOTER = 21

• COMPOSITE_BUCKETS_BY_CANDIDATE = 22

• COMPOSITE_BUCKETS_BY_INDEXES = 23

• COMPOSITE_BUCKETS_COUNT = 24

• COMPOSITE_TOTAL_STAKING_AMOUNT = 25

• CONTRACT_STAKING_BUCKET_TYPES = 26

• oneof request

  • ReadStakingDataRequest.VoteBuckets buckets = 1

  • ReadStakingDataRequest.VoteBucketsByVoter bucketsByVoter = 2

  • ReadStakingDataRequest.VoteBucketsByCandidate bucketsByCandidate = 3

  • ReadStakingDataRequest.Candidates candidates = 4

  • ReadStakingDataRequest.CandidateByName candidateByName = 5

  • ReadStakingDataRequest.VoteBucketsByIndexes bucketsByIndexes = 6

  • ReadStakingDataRequest.CandidateByAddress candidateByAddress = 7

  • ReadStakingDataRequest.TotalStakingAmount totalStakingAmount = 8

  • ReadStakingDataRequest.BucketsCount bucketsCount = 9

  • ReadStakingDataRequest.ContractStakingBucketTypes contractStakingBucketTypes = 10

Used in: ReadStakingDataRequest

(message has no fields)

Used in: ReadStakingDataRequest

• string ownerAddr = 1

Used in: ReadStakingDataRequest

• string candName = 1

Used in: ReadStakingDataRequest

• optional PaginationParam pagination = 1

Used in: ReadStakingDataRequest

• string contractAddress = 1

Used in: ReadStakingDataRequest

(message has no fields)

Used in: ReadStakingDataRequest

• optional PaginationParam pagination = 1

Used in: ReadStakingDataRequest

• string candName = 1

• optional PaginationParam pagination = 2

Used in: ReadStakingDataRequest

• repeated uint64 index = 1

Used in: ReadStakingDataRequest

• string voterAddress = 1

• optional PaginationParam pagination = 2

Used in: GetReceiptByActionResponse

• optional iotextypes.Receipt receipt = 1

• string blkHash = 2

• string signedActionBytes = 1

Used in: LogsFilter

• repeated bytes topic = 1