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:261(message has no fields)
message
access.proto:263(message has no fields)
rpc GetNodeVersionInfo (, )
access.proto:26GetNodeVersionInfo return node version information, such as semver, commit, sporkID and protocol version.
message
access.proto:265(message has no fields)
message
access.proto:267optional info = 1
rpc GetLatestBlockHeader (, )
access.proto:31GetLatestBlockHeader gets the latest sealed or unsealed block header.
message
access.proto:273bool is_sealed = 1
rpc GetBlockHeaderByID (, )
access.proto:34GetBlockHeaderByID gets a block header by ID.
message
access.proto:277bytes id = 1
GetBlockHeaderByHeight gets a block header by height.
message
access.proto:281uint64 height = 1
rpc GetLatestBlock (, )
access.proto:44GetLatestBlock gets the full payload of the latest sealed or unsealed block.
message
access.proto:293bool is_sealed = 1
bool full_block_response = 2
rpc GetBlockByID (, )
access.proto:46GetBlockByID gets a full block by ID.
message
access.proto:298bytes id = 1
bool full_block_response = 2
rpc GetBlockByHeight (, )
access.proto:48GetBlockByHeight gets a full block by height.
message
access.proto:303uint64 height = 1
bool full_block_response = 2
rpc GetCollectionByID (, )
access.proto:53GetCollectionByID gets a collection by ID.
message
access.proto:316bytes id = 1
message
access.proto:320optional collection = 1
optional metadata = 2
rpc SendTransaction (, )
access.proto:58SendTransaction submits a transaction to the network.
message
access.proto:327optional transaction = 1
message
access.proto:331bytes id = 1
optional metadata = 2
rpc GetTransaction (, )
access.proto:60GetTransaction gets a transaction by ID.
rpc GetTransactionResult (, )
access.proto:62GetTransactionResult gets the result of a transaction.
GetTransactionResultByIndex gets the result of a transaction at a specified block and index
message
access.proto:352bytes 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:363repeated transaction_results = 1
optional metadata = 2
GetTransactionsByBlockID gets all the transactions for a specified block
message
access.proto:368repeated transactions = 1
optional metadata = 2
rpc GetSystemTransaction (, )
access.proto:76GetSystemTransaction gets a system transaction
message
access.proto:343bytes block_id = 1
GetSystemTransactionResult gets a system transaction result for a specified block
message
access.proto:347bytes block_id = 1
entities.EventEncodingVersion event_encoding_version = 2
rpc GetAccount (, )
access.proto:88GetAccount 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:393bytes address = 1
message
access.proto:397optional account = 1
optional metadata = 2
GetAccountAtLatestBlock gets an account by address from the latest sealed execution state.
message
access.proto:402bytes address = 1
GetAccountAtBlockHeight gets an account by address at the given block height
message
access.proto:411bytes address = 1
uint64 block_height = 2
ExecuteScriptAtLatestBlock executes a read-only Cadence script against the latest sealed execution state.
message
access.proto:418bytes 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:423bytes 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:429uint64 block_height = 1
bytes script = 2
repeated bytes arguments = 3
GetEventsForHeightRange retrieves events emitted within the specified block range.
message
access.proto:443string type = 1
uint64 start_height = 2
uint64 end_height = 3
entities.EventEncodingVersion event_encoding_version = 4
rpc GetEventsForBlockIDs (, )
access.proto:122GetEventsForBlockIDs retrieves events for the specified block IDs and event type.
message
access.proto:450string type = 1
repeated bytes block_ids = 2
entities.EventEncodingVersion event_encoding_version = 3
rpc GetNetworkParameters (, )
access.proto:128GetNetworkParameters retrieves the Flow network details
message
access.proto:469(message has no fields)
message
access.proto:471string 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:477(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:479bytes 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:483uint64 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:494bytes block_id = 1
message
access.proto:498optional execution_result = 1
optional metadata = 2
GetExecutionResultByID returns Execution Result by its ID.
message
access.proto:503bytes id = 1
message
access.proto:507optional execution_result = 1
optional metadata = 2
rpc SubscribeBlocksFromStartBlockID (, stream )
access.proto:172SubscribeBlocksFromStartBlockID 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:517The 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:182SubscribeBlocksFromStartHeight 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:532The 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:190SubscribeBlocksFromLatest 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:547The 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:202SubscribeBlockHeadersFromStartBlockID 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:568The 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:212SubscribeBlockHeadersFromStartHeight 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:580The 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:220SubscribeBlockHeadersFromLatest 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:592The 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:232SubscribeBlockDigestsFromStartBlockID 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:610The 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:242SubscribeBlockDigestsFromStartHeight 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:622The 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:250SubscribeBlockDigestsFromLatest 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:634The 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:257SendAndSubscribeTransactionStatuses 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:656Request message for sending a transaction and subscribing to its status changes.
optional transaction = 1
The transaction to be sent and tracked for status changes.
message
access.proto:662Response message for transaction status changes.
bytes id = 1
The ID of the tracked transaction.
entities.TransactionStatus status = 2
The status of the tracked transaction Possible transaction statuses are: - TransactionStatusPending - TransactionStatusFinalized - TransactionStatusExecuted - TransactionStatusSealed - `TransactionStatusExpired
uint64 message_index = 3
The message index of the response message. Used by the client to ensure they received all messages. Starts from "0".
message
access.proto:406Used as response type in: AccessAPI.GetAccountAtBlockHeight, AccessAPI.GetAccountAtLatestBlock
optional account = 1
optional metadata = 2
message
access.proto:285Used as response type in: AccessAPI.GetBlockHeaderByHeight, AccessAPI.GetBlockHeaderByID, AccessAPI.GetLatestBlockHeader
optional block = 1
entities.BlockStatus block_status = 2
optional metadata = 3
message
access.proto:308Used as response type in: AccessAPI.GetBlockByHeight, AccessAPI.GetBlockByID, AccessAPI.GetLatestBlock
optional block = 1
entities.BlockStatus block_status = 2
optional metadata = 3
message
access.proto:456Used as response type in: AccessAPI.GetEventsForBlockIDs, AccessAPI.GetEventsForHeightRange
repeated results = 1
optional metadata = 2
message
access.proto:457Used in:
bytes block_id = 1
uint64 block_height = 2
repeated events = 3
optional block_timestamp = 4
message
access.proto:435Used as response type in: AccessAPI.ExecuteScriptAtBlockHeight, AccessAPI.ExecuteScriptAtBlockID, AccessAPI.ExecuteScriptAtLatestBlock
bytes value = 1
optional metadata = 2
uint64 computation_usage = 3
message
access.proto:336Used 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:358Used as request type in: AccessAPI.GetTransactionResultsByBlockID, AccessAPI.GetTransactionsByBlockID
bytes block_id = 1
entities.EventEncodingVersion event_encoding_version = 2
message
access.proto:487Used as response type in: AccessAPI.GetLatestProtocolStateSnapshot, AccessAPI.GetProtocolStateSnapshotByBlockID, AccessAPI.GetProtocolStateSnapshotByHeight
bytes serializedSnapshot = 1
optional metadata = 2
message
access.proto:643The 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:601The 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:559The 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:373Used as response type in: AccessAPI.GetSystemTransaction, AccessAPI.GetTransaction
optional transaction = 1
optional metadata = 2
message
access.proto:378Used 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