package flow.access
Get desktop application:
View/edit binary Protocol Buffers messages
service AccessAPI
access.proto:20AccessAPI is the public-facing API provided by access nodes.
rpc Ping (, )
access.proto:22Ping is used to check if the access node is alive and healthy.
message
access.proto:290(message has no fields)
message
access.proto:292(message has no fields)
rpc GetNodeVersionInfo (, )
access.proto:26GetNodeVersionInfo return node version information, such as semver, commit, sporkID and protocol version.
message
access.proto:294(message has no fields)
message
access.proto:296optional info = 1
rpc GetLatestBlockHeader (, )
access.proto:31GetLatestBlockHeader gets the latest sealed or unsealed block header.
message
access.proto:302bool is_sealed = 1
rpc GetBlockHeaderByID (, )
access.proto:34GetBlockHeaderByID gets a block header by ID.
message
access.proto:306bytes id = 1
GetBlockHeaderByHeight gets a block header by height.
message
access.proto:310uint64 height = 1
rpc GetLatestBlock (, )
access.proto:44GetLatestBlock gets the full payload of the latest sealed or unsealed block.
message
access.proto:322bool is_sealed = 1
bool full_block_response = 2
rpc GetBlockByID (, )
access.proto:46GetBlockByID gets a full block by ID.
message
access.proto:327bytes id = 1
bool full_block_response = 2
rpc GetBlockByHeight (, )
access.proto:48GetBlockByHeight gets a full block by height.
message
access.proto:332uint64 height = 1
bool full_block_response = 2
rpc GetCollectionByID (, )
access.proto:53GetCollectionByID gets a collection by ID.
message
access.proto:345bytes id = 1
message
access.proto:353optional collection = 1
optional metadata = 2
rpc GetFullCollectionByID (, )
access.proto:55GetFullCollectionByID gets a collection by ID.
message
access.proto:349bytes id = 1
message
access.proto:358repeated transactions = 1
optional metadata = 2
rpc SendTransaction (, )
access.proto:60SendTransaction submits a transaction to the network.
message
access.proto:365optional transaction = 1
message
access.proto:369bytes id = 1
optional metadata = 2
rpc GetTransaction (, )
access.proto:62GetTransaction gets a transaction by ID.
rpc GetTransactionResult (, )
access.proto:64GetTransactionResult gets the result of a transaction.
GetTransactionResultByIndex gets the result of a transaction at a specified block and index
message
access.proto:390bytes block_id = 1
uint32 index = 2
entities.EventEncodingVersion event_encoding_version = 3
GetTransactionResultsByBlockID gets all the transaction results for a specified block
message
access.proto:401repeated transaction_results = 1
optional metadata = 2
GetTransactionsByBlockID gets all the transactions for a specified block
message
access.proto:406repeated transactions = 1
optional metadata = 2
rpc GetSystemTransaction (, )
access.proto:78GetSystemTransaction gets a system transaction
message
access.proto:381bytes block_id = 1
GetSystemTransactionResult gets a system transaction result for a specified block
message
access.proto:385bytes block_id = 1
entities.EventEncodingVersion event_encoding_version = 2
rpc GetAccount (, )
access.proto:90GetAccount is an alias for GetAccountAtLatestBlock. Warning: this function is deprecated. It behaves identically to GetAccountAtLatestBlock and will be removed in a future version.
message
access.proto:431bytes address = 1
message
access.proto:435optional account = 1
optional metadata = 2
GetAccountAtLatestBlock gets an account by address from the latest sealed execution state.
message
access.proto:440bytes address = 1
GetAccountAtBlockHeight gets an account by address at the given block height
message
access.proto:449bytes address = 1
uint64 block_height = 2
GetAccountBalanceAtLatestBlock gets an account balance by address from the latest sealed execution state.
message
access.proto:454bytes address = 1
GetAccountBalanceAtBlockHeight gets an account balance by address at the given block height
message
access.proto:458bytes address = 1
uint64 block_height = 2
GetAccountKeysAtLatestBlock gets an account public keys by address from the latest sealed execution state.
message
access.proto:468bytes address = 1
address of account
GetAccountKeysAtBlockHeight gets an account public keys by address at the given block height
message
access.proto:480bytes address = 1
uint64 block_height = 2
GetAccountKeysAtLatestBlock gets an account public key by address and key index from the latest sealed execution state.
message
access.proto:473bytes address = 1
address of account
uint32 index = 2
index of key to return
GetAccountKeysAtBlockHeight gets an account public key by address and key index at the given block height
message
access.proto:485bytes address = 1
uint64 block_height = 2
uint32 index = 3
index of key to return
ExecuteScriptAtLatestBlock executes a read-only Cadence script against the latest sealed execution state.
message
access.proto:504bytes script = 1
repeated bytes arguments = 2
ExecuteScriptAtBlockID executes a ready-only Cadence script against the execution state at the block with the given ID.
message
access.proto:509bytes block_id = 1
bytes script = 2
repeated bytes arguments = 3
ExecuteScriptAtBlockHeight executes a ready-only Cadence script against the execution state at the given block height.
message
access.proto:515uint64 block_height = 1
bytes script = 2
repeated bytes arguments = 3
GetEventsForHeightRange retrieves events emitted within the specified block range.
message
access.proto:529string type = 1
uint64 start_height = 2
uint64 end_height = 3
entities.EventEncodingVersion event_encoding_version = 4
rpc GetEventsForBlockIDs (, )
access.proto:151GetEventsForBlockIDs retrieves events for the specified block IDs and event type.
message
access.proto:536string type = 1
repeated bytes block_ids = 2
entities.EventEncodingVersion event_encoding_version = 3
rpc GetNetworkParameters (, )
access.proto:157GetNetworkParameters retrieves the Flow network details
message
access.proto:555(message has no fields)
message
access.proto:557string chain_id = 1
GetLatestProtocolStateSnapshot retrieves the latest sealed protocol state snapshot. Used by Flow nodes joining the network to bootstrap a space-efficient local state.
message
access.proto:563(message has no fields)
GetProtocolStateSnapshotByBlockID retrieves the latest sealed protocol state snapshot by block ID. Used by Flow nodes joining the network to bootstrap a space-efficient local state.
message
access.proto:565bytes block_id = 1
GetProtocolStateSnapshotByHeight retrieves the latest sealed protocol state snapshot by block height. Used by Flow nodes joining the network to bootstrap a space-efficient local state.
message
access.proto:569uint64 block_height = 1
GetExecutionResultForBlockID returns Execution Result for a given block. At present, Access Node might not have execution results for every block and as usual, until sealed, this data can change
message
access.proto:580bytes block_id = 1
message
access.proto:584optional execution_result = 1
optional metadata = 2
GetExecutionResultByID returns Execution Result by its ID.
message
access.proto:589bytes id = 1
message
access.proto:593optional execution_result = 1
optional metadata = 2
rpc SubscribeBlocksFromStartBlockID (, stream )
access.proto:201SubscribeBlocksFromStartBlockID streams finalized or sealed blocks starting at the requested start block id, up until the latest available block. Once the latest is reached, the stream will remain open and responses are sent for each new block as it becomes available. Blocks are only returned when they have reached the provided block status. For example, if the status is "sealed", only sealed blocks will be returned.
message
access.proto:603The request for SubscribeBlocksFromStartBlockID
bytes start_block_id = 1
Block ID of the first block to subscribe.
entities.BlockStatus block_status = 2
Required block status of the block payload. Possible variants: 1. BLOCK_FINALIZED 2. BLOCK_SEALED
bool full_block_response = 3
Boolean value determining the response: 'full' if `true`, 'light' otherwise.
rpc SubscribeBlocksFromStartHeight (, stream )
access.proto:211SubscribeBlocksFromStartHeight streams finalized or sealed blocks starting at the requested start block height, up until the latest available block. Once the latest is reached, the stream will remain open and responses are sent for each new block as it becomes available. Blocks are only returned when they have reached the provided block status. For example, if the status is "sealed", only sealed blocks will be returned.
message
access.proto:618The request for SubscribeBlocksFromStartHeight
uint64 start_block_height = 1
Block height of the first block to subscribe.
entities.BlockStatus block_status = 2
Required block status of the block payload. Possible variants: 1. BLOCK_FINALIZED 2. BLOCK_SEALED
bool full_block_response = 3
Boolean value determining the response: 'full' if `true`, 'light' otherwise.
rpc SubscribeBlocksFromLatest (, stream )
access.proto:219SubscribeBlocksFromLatest streams finalized or sealed blocks starting from the latest finalized or sealed block. The stream will remain open and responses are sent for each new block as it becomes available. Blocks are only returned when they have reached the provided block status. For example, if the status is "sealed", only sealed blocks will be returned.
message
access.proto:633The request for SubscribeBlocksFromLatest
entities.BlockStatus block_status = 1
Required block status of the block payload. Possible variants: 1. BLOCK_FINALIZED 2. BLOCK_SEALED
bool full_block_response = 2
Boolean value determining the response: 'full' if `true`, 'light' otherwise.
rpc SubscribeBlockHeadersFromStartBlockID (, stream )
access.proto:231SubscribeBlockHeadersFromStartBlockID streams finalized or sealed block headers starting at the requested start block id, up until the latest available block. Once the latest is reached, the stream will remain open and responses are sent for each new block header as it becomes available. Block headers are only returned when they have reached the provided block status. For example, if the status is "sealed", only sealed block headers will be returned.
message
access.proto:654The request for SubscribeBlockHeadersFromStartBlockID
bytes start_block_id = 1
Block ID of the first block header to subscribe.
entities.BlockStatus block_status = 2
Required block status of the block payload. Possible variants: 1. BLOCK_FINALIZED 2. BLOCK_SEALED
rpc SubscribeBlockHeadersFromStartHeight (, stream )
access.proto:241SubscribeBlockHeadersFromStartHeight streams finalized or sealed block headers starting at the requested start block height, up until the latest available block. Once the latest is reached, the stream will remain open and responses are sent for each new block header as it becomes available. Block headers are only returned when they have reached the provided block status. For example, if the status is "sealed", only sealed block headers will be returned.
message
access.proto:666The request for SubscribeBlockHeadersFromStartHeight
uint64 start_block_height = 1
Block height of the first block header to subscribe.
entities.BlockStatus block_status = 2
Required block status of the block payload. Possible variants: 1. BLOCK_FINALIZED 2. BLOCK_SEALED
rpc SubscribeBlockHeadersFromLatest (, stream )
access.proto:249SubscribeBlockHeadersFromLatest streams finalized or sealed block headers starting from the latest finalized or sealed block. The stream will remain open and responses are sent for each new block header as it becomes available. Block headers are only returned when they have reached the provided block status. For example, if the status is "sealed", only sealed block headers will be returned.
message
access.proto:678The request for SubscribeBlockHeadersFromLatest
entities.BlockStatus block_status = 1
Required block status of the block payload. Possible variants: 1. BLOCK_FINALIZED 2. BLOCK_SEALED
rpc SubscribeBlockDigestsFromStartBlockID (, stream )
access.proto:261SubscribeBlockDigestsFromStartBlockID streams finalized or sealed lightweight block starting at the requested start block id, up until the latest available block. Once the latest is reached, the stream will remain open and responses are sent for each new lightweight block as it becomes available. Lightweight blocks are only returned when they have reached the provided block status. For example, if the status is "sealed", only sealed lightweight blocks will be returned.
message
access.proto:696The request for SubscribeBlockDigestsFromStartBlockID
bytes start_block_id = 1
Block ID of the first block to subscribe.
entities.BlockStatus block_status = 2
Required block status of the block payload. Possible variants: 1. BLOCK_FINALIZED 2. BLOCK_SEALED
rpc SubscribeBlockDigestsFromStartHeight (, stream )
access.proto:271SubscribeBlockDigestsFromStartHeight streams finalized or sealed lightweight block starting at the requested start block height, up until the latest available block. Once the latest is reached, the stream will remain open and responses are sent for each new lightweight block as it becomes available. Lightweight blocks are only returned when they have reached the provided block status. For example, if the status is "sealed", only sealed lightweight blocks will be returned.
message
access.proto:708The request for SubscribeBlockDigestsFromStartHeight
uint64 start_block_height = 1
Block height of the first block to subscribe.
entities.BlockStatus block_status = 2
Required block status of the block payload. Possible variants: 1. BLOCK_FINALIZED 2. BLOCK_SEALED
rpc SubscribeBlockDigestsFromLatest (, stream )
access.proto:279SubscribeBlockDigestsFromLatest streams finalized or sealed lightweight block headers starting of the latest finalized or sealed block. The stream will remain open and responses are sent for each new lightweight block as it becomes available. Lightweight blocks are only returned when they have reached the provided block status. For example, if the status is "sealed", only sealed lightweight blocks will be returned.
message
access.proto:720The request for SubscribeBlockDigestsFromLatest
entities.BlockStatus block_status = 1
Required block status of the block payload. Possible variants: 1. BLOCK_FINALIZED 2. BLOCK_SEALED
rpc SendAndSubscribeTransactionStatuses (, stream )
access.proto:286SendAndSubscribeTransactionStatuses send a transaction and immediately subscribe to its status changes. The status is streamed back until the block containing the transaction becomes sealed.
message
access.proto:742Request message for sending a transaction and subscribing to its status changes.
optional transaction = 1
The transaction to be sent and tracked for status changes.
entities.EventEncodingVersion event_encoding_version = 2
The encoding for events in transaction result
message
access.proto:750Response message for transaction status changes.
optional transaction_results = 1
Transaction result of the tracked transaction
uint64 message_index = 2
The message index of the response message. Used by the client to ensure they received all messages. Starts from "0".
message
access.proto:463Used as response type in: AccessAPI.GetAccountBalanceAtBlockHeight, AccessAPI.GetAccountBalanceAtLatestBlock
uint64 balance = 1
optional metadata = 2
message
access.proto:497Used as response type in: AccessAPI.GetAccountKeyAtBlockHeight, AccessAPI.GetAccountKeyAtLatestBlock
optional account_key = 1
optional metadata = 2
message
access.proto:492Used as response type in: AccessAPI.GetAccountKeysAtBlockHeight, AccessAPI.GetAccountKeysAtLatestBlock
repeated account_keys = 1
optional metadata = 2
message
access.proto:444Used as response type in: AccessAPI.GetAccountAtBlockHeight, AccessAPI.GetAccountAtLatestBlock
optional account = 1
optional metadata = 2
message
access.proto:314Used as response type in: AccessAPI.GetBlockHeaderByHeight, AccessAPI.GetBlockHeaderByID, AccessAPI.GetLatestBlockHeader
optional block = 1
entities.BlockStatus block_status = 2
optional metadata = 3
message
access.proto:337Used as response type in: AccessAPI.GetBlockByHeight, AccessAPI.GetBlockByID, AccessAPI.GetLatestBlock
optional block = 1
entities.BlockStatus block_status = 2
optional metadata = 3
message
access.proto:542Used as response type in: AccessAPI.GetEventsForBlockIDs, AccessAPI.GetEventsForHeightRange
repeated results = 1
optional metadata = 2
message
access.proto:543Used in:
bytes block_id = 1
uint64 block_height = 2
repeated events = 3
optional block_timestamp = 4
message
access.proto:521Used as response type in: AccessAPI.ExecuteScriptAtBlockHeight, AccessAPI.ExecuteScriptAtBlockID, AccessAPI.ExecuteScriptAtLatestBlock
bytes value = 1
optional metadata = 2
uint64 computation_usage = 3
message
access.proto:374Used as request type in: AccessAPI.GetTransaction, AccessAPI.GetTransactionResult
bytes id = 1
bytes block_id = 2
bytes collection_id = 3
entities.EventEncodingVersion event_encoding_version = 4
message
access.proto:396Used as request type in: AccessAPI.GetTransactionResultsByBlockID, AccessAPI.GetTransactionsByBlockID
bytes block_id = 1
entities.EventEncodingVersion event_encoding_version = 2
message
access.proto:573Used as response type in: AccessAPI.GetLatestProtocolStateSnapshot, AccessAPI.GetProtocolStateSnapshotByBlockID, AccessAPI.GetProtocolStateSnapshotByHeight
bytes serializedSnapshot = 1
optional metadata = 2
message
access.proto:729The response for SubscribeBlockDigestsFromStartBlockID, SubscribeBlockDigestsFromStartHeight, SubscribeBlockDigestsFromLatest
Used as response type in: AccessAPI.SubscribeBlockDigestsFromLatest, AccessAPI.SubscribeBlockDigestsFromStartBlockID, AccessAPI.SubscribeBlockDigestsFromStartHeight
bytes block_id = 1
The block ID of the new sealed or finalized block according to the block status in the request.
uint64 block_height = 2
The block height of the new sealed or finalized block according to the block status in the request.
optional block_timestamp = 3
The timestamp of the new sealed or finalized block according to the block status in the request.
message
access.proto:687The response for SubscribeBlockHeadersFromStartBlockID, SubscribeBlockHeadersFromStartHeight, SubscribeBlockHeadersFromLatest
Used as response type in: AccessAPI.SubscribeBlockHeadersFromLatest, AccessAPI.SubscribeBlockHeadersFromStartBlockID, AccessAPI.SubscribeBlockHeadersFromStartHeight
optional header = 1
The sealed or finalized block headers according to the block status in the request.
message
access.proto:645The response for SubscribeBlocksFromStartBlockID, SubscribeBlocksFromStartHeight, SubscribeBlocksFromLatest
Used as response type in: AccessAPI.SubscribeBlocksFromLatest, AccessAPI.SubscribeBlocksFromStartBlockID, AccessAPI.SubscribeBlocksFromStartHeight
optional block = 1
The sealed or finalized blocks according to the block status in the request.
message
access.proto:411Used as response type in: AccessAPI.GetSystemTransaction, AccessAPI.GetTransaction
optional transaction = 1
optional metadata = 2
message
access.proto:416Used as response type in: AccessAPI.GetSystemTransactionResult, AccessAPI.GetTransactionResult, AccessAPI.GetTransactionResultByIndex
Used as field type in: ,
entities.TransactionStatus status = 1
uint32 status_code = 2
string error_message = 3
repeated events = 4
bytes block_id = 5
bytes transaction_id = 6
bytes collection_id = 7
uint64 block_height = 8
optional metadata = 9
uint64 computation_usage = 10