Figure Tech Block API
Block API is a data aggregate layer of prejoined blockchain data that offers fast response times for transaction information.
Block API requires an
apiKey to access any endpoint and is passed in as a header value. Please reach out for access and an api key.
This API is a gRPC based service, the data is populated by the provenance event-stream. Data is then aggregated by addresses that make up accounts, contracts, scopes, and markers. Endpoints are available for transactions and block information based on the previous list.
Since addresses and blocks can have many transactions, transaction related endpoints are paged and by default 10 records per page are returned.
Certain endpoints can optionally return ancillary information such as transactions to a block query and transaction events to a transaction query. This option is called
Prefer and can be added in an endpoint request to get the preferred data returned.
Block information is available and returns a block per height request. You can
Prefer to return transactions in a request and transactions are paged.
Transactions can be queried by a specific transaction hash or by an address. Transcations contain a JSON representation of their messages and are tagged by which blockchain module the message belongs to. For example, if the transaction message contains bank module transfer information then it will be tagged as a "Bank" transaction. Transactions can have multiple tags.
Transactions can also return preferred data like transaction events and are paged.
If you are looking for specific transaction groupings like transactions that belong to a contract address you can query the contract address specific endpoint.
If you are looking for specific transaction groupings like transactions that belong to a marker address you can query the marker address specific endpoint.
If you are looking for specific transaction groupings like transactions that belong to a metadata address , like a scope address, you can query the metadata address specific endpoint.
Scope transaction messages are grouped by scope ids and can be queried by a scope id. The resulting data will be all historical messages and height that a scope change occurred.
The status endpoint provides information on the last block committed into our API. This is a good health check to understand if the API is ever behind the current blockchain height.