package access

Get desktop application:
View/edit binary Protocol Buffers messages

AccessAPI is the public-facing API provided by access nodes.

• rpc Ping (PingRequest, PingResponse)

  access.proto:18

  Ping is used to check if the access node is alive and healthy.

  message PingRequest

  access.proto:107

  (message has no fields)

  message PingResponse

  access.proto:109

  (message has no fields)

• rpc GetLatestBlockHeader (GetLatestBlockHeaderRequest, BlockHeaderResponse)

  access.proto:23

  GetLatestBlockHeader gets the latest sealed or unsealed block header.

  message GetLatestBlockHeaderRequest

  access.proto:113

  • bool is_sealed = 1

• rpc GetBlockHeaderByID (GetBlockHeaderByIDRequest, BlockHeaderResponse)

  access.proto:26

  GetBlockHeaderByID gets a block header by ID.

  message GetBlockHeaderByIDRequest

  access.proto:117

  • bytes id = 1

• rpc GetBlockHeaderByHeight (GetBlockHeaderByHeightRequest, BlockHeaderResponse)

  access.proto:29

  GetBlockHeaderByHeight gets a block header by height.

  message GetBlockHeaderByHeightRequest

  access.proto:121

  • uint64 height = 1

• rpc GetLatestBlock (GetLatestBlockRequest, BlockResponse)

  access.proto:36

  GetLatestBlock gets the full payload of the latest sealed or unsealed block.

  message GetLatestBlockRequest

  access.proto:131

  • bool is_sealed = 1

• rpc GetBlockByID (GetBlockByIDRequest, BlockResponse)

  access.proto:38

  GetBlockByID gets a full block by ID.

  message GetBlockByIDRequest

  access.proto:135

  • bytes id = 1

• rpc GetBlockByHeight (GetBlockByHeightRequest, BlockResponse)

  access.proto:40

  GetBlockByHeight gets a full block by height.

  message GetBlockByHeightRequest

  access.proto:139

  • uint64 height = 1

• rpc GetCollectionByID (GetCollectionByIDRequest, CollectionResponse)

  access.proto:45

  GetCollectionByID gets a collection by ID.

  message GetCollectionByIDRequest

  access.proto:149

  • bytes id = 1

  message CollectionResponse

  access.proto:153

  • optional entities.Collection collection = 1

• rpc SendTransaction (SendTransactionRequest, SendTransactionResponse)

  access.proto:50

  SendTransaction submits a transaction to the network.

  message SendTransactionRequest

  access.proto:159

  • optional entities.Transaction transaction = 1

  message SendTransactionResponse

  access.proto:163

  • bytes id = 1

• rpc GetTransaction (GetTransactionRequest, TransactionResponse)

  access.proto:52

  GetTransaction gets a transaction by ID.

  message TransactionResponse

  access.proto:171

  • optional entities.Transaction transaction = 1

• rpc GetTransactionResult (GetTransactionRequest, TransactionResultResponse)

  access.proto:54

  GetTransactionResult gets the result of a transaction.

  message TransactionResultResponse

  access.proto:175

  • entities.TransactionStatus status = 1

  • uint32 status_code = 2

  • string error_message = 3

  • repeated entities.Event events = 4

• rpc GetAccount (GetAccountRequest, GetAccountResponse)

  access.proto:63

  GetAccount is an alias for GetAccountAtLatestBlock. Warning: this function is deprecated. It behaves identically to GetAccountAtLatestBlock and will be removed in a future version.

  message GetAccountRequest

  access.proto:184

  • bytes address = 1

  message GetAccountResponse

  access.proto:188

  • optional entities.Account account = 1

• rpc GetAccountAtLatestBlock (GetAccountAtLatestBlockRequest, AccountResponse)

  access.proto:66

  GetAccountAtLatestBlock gets an account by address from the latest sealed execution state.

  message GetAccountAtLatestBlockRequest

  access.proto:192

  • bytes address = 1

• rpc GetAccountAtBlockHeight (GetAccountAtBlockHeightRequest, AccountResponse)

  access.proto:70

  GetAccountAtBlockHeight gets an account by address at the given block height

  message GetAccountAtBlockHeightRequest

  access.proto:200

  • bytes address = 1

  • uint64 block_height = 2

• rpc ExecuteScriptAtLatestBlock (ExecuteScriptAtLatestBlockRequest, ExecuteScriptResponse)

  access.proto:77

  ExecuteScriptAtLatestBlock executes a read-only Cadence script against the latest sealed execution state.

  message ExecuteScriptAtLatestBlockRequest

  access.proto:207

  • bytes script = 1

  • repeated bytes arguments = 2

• rpc ExecuteScriptAtBlockID (ExecuteScriptAtBlockIDRequest, ExecuteScriptResponse)

  access.proto:81

  ExecuteScriptAtBlockID executes a ready-only Cadence script against the execution state at the block with the given ID.

  message ExecuteScriptAtBlockIDRequest

  access.proto:212

  • bytes block_id = 1

  • bytes script = 2

  • repeated bytes arguments = 3

• rpc ExecuteScriptAtBlockHeight (ExecuteScriptAtBlockHeightRequest, ExecuteScriptResponse)

  access.proto:85

  ExecuteScriptAtBlockHeight executes a ready-only Cadence script against the execution state at the given block height.

  message ExecuteScriptAtBlockHeightRequest

  access.proto:218

  • uint64 block_height = 1

  • bytes script = 2

  • repeated bytes arguments = 3

• rpc GetEventsForHeightRange (GetEventsForHeightRangeRequest, EventsResponse)

  access.proto:92

  GetEventsForHeightRange retrieves events emitted within the specified block range.

  message GetEventsForHeightRangeRequest

  access.proto:230

  • string type = 1

  • uint64 start_height = 2

  • uint64 end_height = 3

• rpc GetEventsForBlockIDs (GetEventsForBlockIDsRequest, EventsResponse)

  access.proto:97

  GetEventsForBlockIDs retrieves events for the specified block IDs and event type.

  message GetEventsForBlockIDsRequest

  access.proto:236

  • string type = 1

  • repeated bytes block_ids = 2

• rpc GetNetworkParameters (GetNetworkParametersRequest, GetNetworkParametersResponse)

  access.proto:103

  GetNetworkParameters retrieves the Flow network details

  message GetNetworkParametersRequest

  access.proto:252

  (message has no fields)

  message GetNetworkParametersResponse

  access.proto:254

  • string chain_id = 1

Used as response type in: AccessAPI.GetAccountAtBlockHeight, AccessAPI.GetAccountAtLatestBlock

• optional entities.Account account = 1

Used as response type in: AccessAPI.GetBlockHeaderByHeight, AccessAPI.GetBlockHeaderByID, AccessAPI.GetLatestBlockHeader

• optional entities.BlockHeader block = 1

Used as response type in: AccessAPI.GetBlockByHeight, AccessAPI.GetBlockByID, AccessAPI.GetLatestBlock

• optional entities.Block block = 1

Used as response type in: AccessAPI.GetEventsForBlockIDs, AccessAPI.GetEventsForHeightRange

• repeated EventsResponse.Result results = 1

Used in: EventsResponse

• bytes block_id = 1

• uint64 block_height = 2

• repeated entities.Event events = 3

Used as response type in: AccessAPI.ExecuteScriptAtBlockHeight, AccessAPI.ExecuteScriptAtBlockID, AccessAPI.ExecuteScriptAtLatestBlock

• bytes value = 1

Used as request type in: AccessAPI.GetTransaction, AccessAPI.GetTransactionResult

• bytes id = 1