package flow.executiondata
Get desktop application:
View/edit binary Protocol Buffers messages
Execution Data API provides access to execution data from the Flow network
GetExecutionDataByBlockID returns execution data for a specific block ID. Errors: - InvalidArgument is returned if the request contains an invalid block ID. - NotFound is returned if the start block or execution data are not currently available on the node. This may happen if the block was from a previous spork, or if the block has yet not been received.
message
executiondata.proto:258The request for GetExecutionDataByBlockID
bytes block_id = 1
Block ID of the block to get execution data for.
entities.EventEncodingVersion event_encoding_version = 2
Preferred event encoding version of the block events payload. Possible variants: 1. CCF 2. JSON-CDC
message
executiondata.proto:269The response for GetExecutionDataByBlockID
optional block_execution_data = 1
BlockExecutionData for the block.
rpc SubscribeExecutionData (, stream )
executiondata.proto:41Warning: this endpoint is deprecated and will be removed in future versions. Use SubscribeExecutionDataFromStartBlockID, SubscribeExecutionDataFromStartBlockHeight or SubscribeExecutionDataFromLatest. SubscribeExecutionData streams execution data for all blocks starting at the requested start block, up until the latest available block. Once the latest is reached, the stream will remain open and responses are sent for each new execution data as it becomes available. Errors: - InvalidArgument is returned if the request contains an invalid start block. - NotFound is returned if the start block is not currently available on the node. This may happen if the block was from a previous spork, or if the block has yet not been received.
message
executiondata.proto:275The request for SubscribeExecutionData
bytes start_block_id = 1
Block ID of the first block to get execution data for. Only one of start_block_id and start_block_height may be provided, otherwise an InvalidArgument error is returned. If neither are provided, the latest sealed block is used.
uint64 start_block_height = 2
Block height of the first block to get execution data for. Only one of start_block_id and start_block_height may be provided, otherwise an InvalidArgument error is returned. If neither are provided, the latest sealed block is used.
entities.EventEncodingVersion event_encoding_version = 3
Preferred event encoding version of the block events payload. Possible variants: 1. CCF 2. JSON-CDC
rpc SubscribeExecutionDataFromStartBlockID (, stream )
executiondata.proto:57SubscribeExecutionDataFromStartBlockID streams execution data for all blocks starting at the requested start block, up until the latest available block. Once the latest is reached, the stream will remain open and responses are sent for each new execution data as it becomes available. Errors: - InvalidArgument is returned if the request contains an invalid start block. - NotFound is returned if the start block is not currently available on the node. This may happen if the block was from a previous spork, or if the block has yet not been received.
message
executiondata.proto:309The request for SubscribeExecutionDataFromStartBlockIDRequest
bytes start_block_id = 1
Block ID of the first block to get execution data for.
entities.EventEncodingVersion event_encoding_version = 2
Preferred event encoding version of the block events payload. Possible variants: 1. CCF 2. JSON-CDC
rpc SubscribeExecutionDataFromStartBlockHeight (, stream )
executiondata.proto:72SubscribeExecutionDataFromStartBlockHeight streams execution data for all blocks starting at the requested start block, up until the latest available block. Once the latest is reached, the stream will remain open and responses are sent for each new execution data as it becomes available. Errors: - InvalidArgument is returned if the request contains an invalid start block. - NotFound is returned if the start block is not currently available on the node. This may happen if the block was from a previous spork, or if the block has yet not been received.
message
executiondata.proto:321The request for SubscribeExecutionDataFromStartBlockHeightRequest
uint64 start_block_height = 1
Block height of the first block to get execution data for.
entities.EventEncodingVersion event_encoding_version = 2
Preferred event encoding version of the block events payload. Possible variants: 1. CCF 2. JSON-CDC
rpc SubscribeExecutionDataFromLatest (, stream )
executiondata.proto:83SubscribeExecutionDataFromStartBlockHeight streams execution data for all blocks starting from the latest block. Errors: - NotFound is returned if the start block is not currently available on the node. This may happen if the block was from a previous spork, or if the block has yet not been received.
message
executiondata.proto:333The request for SubscribeExecutionDataFromLatestRequest
entities.EventEncodingVersion event_encoding_version = 1
Preferred event encoding version of the block events payload. Possible variants: 1. CCF 2. JSON-CDC
rpc SubscribeEvents (, stream )
executiondata.proto:111Warning: this endpoint is deprecated and will be removed in future versions. Use SubscribeEventsFromStartBlockID, SubscribeEventsFromStartHeight or SubscribeEventsFromLatest. SubscribeEvents streams events for all blocks starting at the requested start block, 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. Events within each block are filtered by the provided EventFilter, and only those events that match the filter are returned. If no filter is provided, all events are returned. Responses are returned for each block containing at least one event that matches the filter. Additionally, heartbeat responses (SubscribeEventsResponse with no events) are returned periodically to allow clients to track which blocks were searched. Clients can use this information to determine which block to start from when reconnecting. Errors: - InvalidArgument is returned if the request contains an invalid EventFilter or start block. - NotFound is returned if the start block is not currently available on the node. This may happen if the block was from a previous spork, or if the block has yet not been received.
message
executiondata.proto:342The request for SubscribeEvents
bytes start_block_id = 1
Block ID of the first block to search for events. Only one of start_block_id and start_block_height may be provided, otherwise an InvalidArgument error is returned. If neither are provided, the latest sealed block is used.
uint64 start_block_height = 2
Block height of the first block to search for events. Only one of start_block_id and start_block_height may be provided, otherwise an InvalidArgument error is returned. If neither are provided, the latest sealed block is used.
optional filter = 3
Filter to apply to events for each block searched. If no filter is provided, all events are returned.
uint64 heartbeat_interval = 4
Interval in block heights at which the server should return a heartbeat message to the client. The heartbeat is a normal SubscribeEventsResponse with no events, and allows clients to track which blocks were searched. Clients can use this information to determine which block to start from when reconnecting. The interval is calculated from the last response returned, which could be either another heartbeat or a response containing events.
entities.EventEncodingVersion event_encoding_version = 5
Preferred event encoding version of the block events payload. Possible variants: 1. CCF 2. JSON-CDC
rpc SubscribeEventsFromStartBlockID (, stream )
executiondata.proto:136SubscribeEventsFromStartBlockID streams events for all 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. Events within each block are filtered by the provided EventFilter, and only those events that match the filter are returned. If no filter is provided, all events are returned. Responses are returned for each block containing at least one event that matches the filter. Additionally, heatbeat responses (SubscribeEventsResponse with no events) are returned periodically to allow clients to track which blocks were searched. Clients can use this information to determine which block to start from when reconnecting. Errors: - InvalidArgument is returned if the request contains an invalid block ID or EventFilter. - NotFound is returned if the start block id or execution data are not currently available on the node. This may happen if the block was from a previous spork, or if the block has yet not been received.
message
executiondata.proto:378The request for SubscribeEventsFromStartBlockID
bytes start_block_id = 1
Block ID of the first block to search for events.
optional filter = 2
Filter to apply to events for each block searched. If no filter is provided, all events are returned.
uint64 heartbeat_interval = 3
Interval in block heights at which the server should return a heartbeat message to the client. The heartbeat is a normal SubscribeEventsResponse with no events, and allows clients to track which blocks were searched. Clients can use this information to determine which block to start from when reconnecting. The interval is calculated from the last response returned, which could be either another heartbeat or a response containing events.
entities.EventEncodingVersion event_encoding_version = 4
Preferred event encoding version of the block events payload. Possible variants: 1. CCF 2. JSON-CDC
rpc SubscribeEventsFromStartHeight (, stream )
executiondata.proto:159SubscribeEventsFromStartHeight streams events for all 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. Events within each block are filtered by the provided EventFilter, and only those events that match the filter are returned. If no filter is provided, all events are returned. Responses are returned for each block containing at least one event that matches the filter. Additionally, heatbeat responses (SubscribeEventsResponse with no events) are returned periodically to allow clients to track which blocks were searched. Clients can use this information to determine which block to start from when reconnecting. Errors: - InvalidArgument is returned if the request contains an invalid EventFilter. - NotFound is returned if the start block height or execution data are not currently available on the node. This may happen if the block was from a previous spork, or if the block has yet not been received.
message
executiondata.proto:404The request for SubscribeEventsFromStartHeight
uint64 start_block_height = 1
Block height of the first block to search for events.
optional filter = 2
Filter to apply to events for each block searched. If no filter is provided, all events are returned.
uint64 heartbeat_interval = 3
Interval in block heights at which the server should return a heartbeat message to the client. The heartbeat is a normal SubscribeEventsResponse with no events, and allows clients to track which blocks were searched. Clients can use this information to determine which block to start from when reconnecting. The interval is calculated from the last response returned, which could be either another heartbeat or a response containing events.
entities.EventEncodingVersion event_encoding_version = 4
Preferred event encoding version of the block events payload. Possible variants: 1. CCF 2. JSON-CDC
rpc SubscribeEventsFromLatest (, stream )
executiondata.proto:177SubscribeEventsFromLatest streams events for all blocks starting from the latest sealed block. The stream will remain open and responses are sent for each new block as it becomes available. Events within each block are filtered by the provided EventFilter, and only those events that match the filter are returned. If no filter is provided, all events are returned. Responses are returned for each block containing at least one event that matches the filter. Additionally, heatbeat responses (SubscribeEventsResponse with no events) are returned periodically to allow clients to track which blocks were searched. Clients can use this information to determine which block to start from when reconnecting. Errors: - InvalidArgument is returned if the request contains an invalid EventFilter.
message
executiondata.proto:430The request for SubscribeEventsFromLatest
optional filter = 1
Filter to apply to events for each block searched. If no filter is provided, all events are returned.
uint64 heartbeat_interval = 2
Interval in block heights at which the server should return a heartbeat message to the client. The heartbeat is a normal SubscribeEventsResponse with no events, and allows clients to track which blocks were searched. Clients can use this information to determine which block to start from when reconnecting. The interval is calculated from the last response returned, which could be either another heartbeat or a response containing events.
entities.EventEncodingVersion event_encoding_version = 3
Preferred event encoding version of the block events payload. Possible variants: 1. CCF 2. JSON-CDC
GetRegisterValues gets the values for the given register IDs as of the given block height
message
executiondata.proto:516request for GetRegisterValues
uint64 block_height = 1
Block height of the execution state being queried.
repeated register_ids = 2
Register IDs of the Ledger.RegisterID format with an owner and key.
message
executiondata.proto:526response for GetRegisterValues
repeated bytes values = 1
raw register values at the given height.
rpc SubscribeAccountStatusesFromStartBlockID (, stream )
executiondata.proto:205SubscribeAccountStatusesFromStartBlockID streams account statuses for all 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. Events within each block are filtered by the provided StatusFilter, and only those events that match the filter are returned. If no filter is provided, all events are returned. Responses are returned for each block containing at least one event that matches the filter. Additionally, heartbeat responses (SubscribeAccountStatusesResponse with no events) are returned periodically to allow clients to track which blocks were searched. Clients can use this information to determine which block to start from when reconnecting. Errors: - InvalidArgument is returned if the request contains an invalid StatusFilter or start block. - NotFound is returned if the start block is not currently available on the node. This may happen if the block was from a previous spork, or if the block has yet not been received.
message
executiondata.proto:533The request for SubscribeAccountStatusesFromStartBlockID
bytes start_block_id = 1
Block ID of the first block to search for events. Only one of start_block_id and start_block_height may be provided, otherwise an InvalidArgument error is returned. If neither are provided, the latest sealed block is used.
optional filter = 2
Filter to apply to events for each block searched. If no filter is provided, all statuses are returned.
uint64 heartbeat_interval = 3
Interval in block heights at which the server should return a heartbeat message to the client. The heartbeat is a normal SubscribeAccountStatusesResponse with no events, and allows clients to track which blocks were searched. Clients can use this information to determine which block to start from when reconnecting. The interval is calculated from the last response returned, which could be either another heartbeat or a response containing events.
entities.EventEncodingVersion event_encoding_version = 4
Preferred event encoding version of the block events payload. Possible variants: 1. CCF 2. JSON-CDC
rpc SubscribeAccountStatusesFromStartHeight (, stream )
executiondata.proto:229SubscribeAccountStatusesFromStartHeight streams account statuses for all 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. Events within each block are filtered by the provided StatusFilter, and only those events that match the filter are returned. If no filter is provided, all events are returned. Responses are returned for each block containing at least one event that matches the filter. Additionally, heartbeat responses (SubscribeAccountStatusesResponse with no events) are returned periodically to allow clients to track which blocks were searched. Clients can use this information to determine which block to start from when reconnecting. Errors: - InvalidArgument is returned if the request contains an invalid StatusFilter or start block. - NotFound is returned if the start block is not currently available on the node. This may happen if the block was from a previous spork, or if the block has yet not been received.
message
executiondata.proto:562The request for SubscribeAccountStatusesFromStartHeight
uint64 start_block_height = 1
Block height of the first block to search for events. Only one of start_block_id and start_block_height may be provided, otherwise an InvalidArgument error is returned. If neither are provided, the latest sealed block is used.
optional filter = 2
Filter to apply to events for each block searched. If no filter is provided, all statuses are returned.
uint64 heartbeat_interval = 3
Interval in block heights at which the server should return a heartbeat message to the client. The heartbeat is a normal SubscribeAccountStatusesResponse with no events, and allows clients to track which blocks were searched. Clients can use this information to determine which block to start from when reconnecting. The interval is calculated from the last response returned, which could be either another heartbeat or a response containing events.
entities.EventEncodingVersion event_encoding_version = 4
Preferred event encoding version of the block events payload. Possible variants: 1. CCF 2. JSON-CDC
rpc SubscribeAccountStatusesFromLatestBlock (, stream )
executiondata.proto:253SubscribeAccountStatusesFromLatestBlock streams account statuses for all blocks starting at the last sealed block, 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. Events within each block are filtered by the provided StatusFilter, and only those events that match the filter are returned. If no filter is provided, all events are returned. Responses are returned for each block containing at least one event that matches the filter. Additionally, heartbeat responses (SubscribeAccountStatusesResponse with no events) are returned periodically to allow clients to track which blocks were searched. Clients can use this information to determine which block to start from when reconnecting. Errors: - InvalidArgument is returned if the request contains an invalid StatusFilter or start block. - NotFound is returned if the start block is not currently available on the node. This may happen if the block was from a previous spork, or if the block has yet not been received.
message
executiondata.proto:591The request for SubscribeAccountStatusesFromLatestBlock
optional filter = 1
Filter to apply to events for each block searched. If no filter is provided, all statuses are returned.
uint64 heartbeat_interval = 2
Interval in block heights at which the server should return a heartbeat message to the client. The heartbeat is a normal SubscribeAccountStatusesResponse with no events, and allows clients to track which blocks were searched. Clients can use this information to determine which block to start from when reconnecting. The interval is calculated from the last response returned, which could be either another heartbeat or a response containing events.
entities.EventEncodingVersion event_encoding_version = 3
Preferred event encoding version of the block events payload. Possible variants: 1. CCF 2. JSON-CDC
message
executiondata.proto:477EventFilter defines the filter to apply to block events. Filters are applied as an OR operation, i.e. any event matching any of the filters is returned. If no filters are provided, all events are returned. If there are any invalid filters, the API will return an InvalidArgument error.
Used in: , , ,
repeated string event_type = 1
A list of full event types to include. All events exactly matching any of the provided event types will be returned. Event types have 2 formats: - Protocol events: flow.[event name] - Smart contract events: A.[contract address].[contract name].[event name]
repeated string contract = 2
A list of contracts who's events should be included. All events emitted by any of the provided contracts will be returned. Contracts have the following name formats: - Protocol events: flow - Smart contract events: A.[contract address].[contract name] This filter matches on the full contract including its address, not just the contract's name.
repeated string address = 3
A list of addresses who's events should be included. All events emitted by any contract held by any of the provided addresses will be returned. Addresses must be Flow account addresses in hex format and valid for the network the node is connected to. i.e. only a mainnet address is valid for a mainnet node. Addresses may optionally include the 0x prefix.
message
executiondata.proto:643StatusesFilter defines the filter to apply to block events. Filters match for events with types in the included event_type list, that are related to at least one address from the provided address list. An event who's type matches but address does not is ignored, and vice versa. If no event_types are provided, all account related protocol event types are matched. If no addresses are provided, any address matches. If there are any invalid filters, the API will return an InvalidArgument error.
Used in: , ,
repeated string event_type = 1
A list of full event types to include. All events exactly matching any of the provided event types will be returned. Event types must be protocol events. e.g. flow.[event name]
repeated string address = 3
A list of addresses who's events should be included. All events matching the provided event_types that are related to any of the provided addresses will be returned. If no addresses are provided, all events matching event_types will be returned. Addresses must be Flow account addresses in hex format and valid for the network the node is connected to. i.e. only a mainnet address is valid for a mainnet node. Addresses may optionally include the 0x prefix.
message
executiondata.proto:614The response for SubscribeAccountStatuses
Used as response type in: ExecutionDataAPI.SubscribeAccountStatusesFromLatestBlock, ExecutionDataAPI.SubscribeAccountStatusesFromStartBlockID, ExecutionDataAPI.SubscribeAccountStatusesFromStartHeight
bytes block_id = 1
Block ID of the block containing the events.
uint64 block_height = 2
Block height of the block containing the events.
uint64 message_index = 3
The message index of the response message. Used by the client to ensure they received all messages. Starts from "0".
repeated results = 4
The API may return no results which signals a periodic heartbeat. This allows clients to track which blocks were searched. Client can use this information to determine which block to start from when reconnecting.
message
executiondata.proto:624Used in:
bytes address = 1
Unique identifier for the account being streamed
repeated events = 2
Events matching the StatusFilter in the request.
message
executiondata.proto:453The response for SubscribeEvents
Used as response type in: ExecutionDataAPI.SubscribeEvents, ExecutionDataAPI.SubscribeEventsFromLatest, ExecutionDataAPI.SubscribeEventsFromStartBlockID, ExecutionDataAPI.SubscribeEventsFromStartHeight
bytes block_id = 1
Block ID of the block containing the events.
uint64 block_height = 2
Block height of the block containing the events.
repeated events = 3
Events matching the EventFilter in the request. The API may return no events which signals a periodic heartbeat. This allows clients to track which blocks were searched. Client can use this information to determine which block to start from when reconnecting.
optional block_timestamp = 4
Timestamp from the block containing the events.
uint64 message_index = 5
The message index of the response message. Used by the client to ensure they received all messages. Starts from "0".
message
executiondata.proto:296The response for SubscribeExecutionData
Used as response type in: ExecutionDataAPI.SubscribeExecutionData, ExecutionDataAPI.SubscribeExecutionDataFromLatest, ExecutionDataAPI.SubscribeExecutionDataFromStartBlockHeight, ExecutionDataAPI.SubscribeExecutionDataFromStartBlockID
uint64 block_height = 1
Block height of the block containing the execution data.
optional block_execution_data = 2
BlockExecutionData for the block. Note: The block's ID is included within the BlockExecutionData.
optional block_timestamp = 3
Timestamp from the block containing the execution data.