Class BlocksService

Hierarchy

  • BlocksService

Constructors

constructor

Properties

httpRequest

Methods

getBlockByHeight getBlockByVersion

Constructors

constructor

Properties

Readonly httpRequest

httpRequest: BaseHttpRequest

Methods

getBlockByHeight

  • Get blocks by height This endpoint allows you to get the transactions in a block and the corresponding block information.

    Transactions are limited by max default transactions size. If not all transactions are present, the user will need to query for the rest of the transactions via the get transactions API.

    If the block is pruned, it will return a 410

    Returns

    Block

    Throws

    ApiError

    Parameters

    • blockHeight: number

      Block height to lookup. Starts at 0

    • Optional withTransactions: boolean

      If set to true, include all transactions in the block

      If not provided, no transactions will be retrieved

    Returns CancelablePromise<Block>

getBlockByVersion

  • Get blocks by version This endpoint allows you to get the transactions in a block and the corresponding block information given a version in the block.

    Transactions are limited by max default transactions size. If not all transactions are present, the user will need to query for the rest of the transactions via the get transactions API.

    If the block has been pruned, it will return a 410

    Returns

    Block

    Throws

    ApiError

    Parameters

    • version: number

      Ledger version to lookup block information for.

    • Optional withTransactions: boolean

      If set to true, include all transactions in the block

      If not provided, no transactions will be retrieved

    Returns CancelablePromise<Block>

Settings

Member Visibility

Theme

Generated using TypeDoc