Interface BlocksApiInterface

BlocksApi - interface

Export

Interface

BlocksApiInterface

Hierarchy

BlocksApiInterface

Implemented by

BlocksApi

Index

Methods

getBlockByBurnBlockHash getBlockByBurnBlockHashRaw getBlockByBurnBlockHeight getBlockByBurnBlockHeightRaw getBlockByHash getBlockByHashRaw getBlockByHeight getBlockByHeightRaw getBlockList getBlockListRaw

Methods

getBlockByBurnBlockHash

getBlockByBurnBlockHash(requestParameters: GetBlockByBurnBlockHashRequest, initOverrides?: RequestInit): Promise<Block>
Retrieves block details of a specific block for a given burnchain block hash Get block by burnchain block hash
Parameters
- requestParameters: GetBlockByBurnBlockHashRequest
- Optional initOverrides: RequestInit
Returns Promise<Block>
- Defined in src/generated/apis/BlocksApi.ts:68

getBlockByBurnBlockHashRaw

getBlockByBurnBlockHashRaw(requestParameters: GetBlockByBurnBlockHashRequest, initOverrides?: RequestInit): Promise<ApiResponse<Block>>
Retrieves block details of a specific block for a given burnchain block hash

Summary
Get block by burnchain block hash

Throws

Memberof
BlocksApiInterface
Parameters
- requestParameters: GetBlockByBurnBlockHashRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<Block>>
- Defined in src/generated/apis/BlocksApi.ts:62

getBlockByBurnBlockHeight

getBlockByBurnBlockHeight(requestParameters: GetBlockByBurnBlockHeightRequest, initOverrides?: RequestInit): Promise<Block>
Retrieves block details of a specific block for a given burn chain height Get block by burnchain height
Parameters
- requestParameters: GetBlockByBurnBlockHeightRequest
- Optional initOverrides: RequestInit
Returns Promise<Block>
- Defined in src/generated/apis/BlocksApi.ts:84

getBlockByBurnBlockHeightRaw

getBlockByBurnBlockHeightRaw(requestParameters: GetBlockByBurnBlockHeightRequest, initOverrides?: RequestInit): Promise<ApiResponse<Block>>
Retrieves block details of a specific block for a given burn chain height

Summary
Get block by burnchain height

Throws

Memberof
BlocksApiInterface
Parameters
- requestParameters: GetBlockByBurnBlockHeightRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<Block>>
- Defined in src/generated/apis/BlocksApi.ts:78

getBlockByHash

getBlockByHash(requestParameters: GetBlockByHashRequest, initOverrides?: RequestInit): Promise<Block>
Retrieves block details of a specific block for a given chain height. You can use the hash from your latest block ('get_block_list' API) to get your block details. Get block by hash
Parameters
- requestParameters: GetBlockByHashRequest
- Optional initOverrides: RequestInit
Returns Promise<Block>
- Defined in src/generated/apis/BlocksApi.ts:100

getBlockByHashRaw

getBlockByHashRaw(requestParameters: GetBlockByHashRequest, initOverrides?: RequestInit): Promise<ApiResponse<Block>>
Retrieves block details of a specific block for a given chain height. You can use the hash from your latest block ('get_block_list' API) to get your block details.

Summary
Get block by hash

Throws

Memberof
BlocksApiInterface
Parameters
- requestParameters: GetBlockByHashRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<Block>>
- Defined in src/generated/apis/BlocksApi.ts:94

getBlockByHeight

getBlockByHeight(requestParameters: GetBlockByHeightRequest, initOverrides?: RequestInit): Promise<Block>
Retrieves block details of a specific block at a given block height Get block by height
Parameters
- requestParameters: GetBlockByHeightRequest
- Optional initOverrides: RequestInit
Returns Promise<Block>
- Defined in src/generated/apis/BlocksApi.ts:116

getBlockByHeightRaw

getBlockByHeightRaw(requestParameters: GetBlockByHeightRequest, initOverrides?: RequestInit): Promise<ApiResponse<Block>>
Retrieves block details of a specific block at a given block height

Summary
Get block by height

Throws

Memberof
BlocksApiInterface
Parameters
- requestParameters: GetBlockByHeightRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<Block>>
- Defined in src/generated/apis/BlocksApi.ts:110

getBlockList

getBlockList(requestParameters: GetBlockListRequest, initOverrides?: RequestInit): Promise<BlockListResponse>
Retrieves a list of recently mined blocks If you need to actively monitor new blocks, we highly recommend subscribing to WebSockets or Socket.io for real-time updates. Get recent blocks
Parameters
- requestParameters: GetBlockListRequest
- Optional initOverrides: RequestInit
Returns Promise<BlockListResponse>
- Defined in src/generated/apis/BlocksApi.ts:133

getBlockListRaw

getBlockListRaw(requestParameters: GetBlockListRequest, initOverrides?: RequestInit): Promise<ApiResponse<BlockListResponse>>
Retrieves a list of recently mined blocks If you need to actively monitor new blocks, we highly recommend subscribing to WebSockets or Socket.io for real-time updates.

Summary
Get recent blocks

Throws

Memberof
BlocksApiInterface
Parameters
- requestParameters: GetBlockListRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<BlockListResponse>>
- Defined in src/generated/apis/BlocksApi.ts:127

Interface BlocksApiInterface

Export

Interface

Hierarchy

Implemented by

Index

Methods

Methods

getBlockByBurnBlockHash

Parameters

requestParameters: GetBlockByBurnBlockHashRequest

Optional initOverrides: RequestInit

Returns Promise<Block>

getBlockByBurnBlockHashRaw

Summary

Throws

Memberof

Parameters

requestParameters: GetBlockByBurnBlockHashRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<Block>>

getBlockByBurnBlockHeight

Parameters

requestParameters: GetBlockByBurnBlockHeightRequest

Optional initOverrides: RequestInit

Returns Promise<Block>

getBlockByBurnBlockHeightRaw

Summary

Throws

Memberof

Parameters

requestParameters: GetBlockByBurnBlockHeightRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<Block>>

getBlockByHash

Parameters

requestParameters: GetBlockByHashRequest

Optional initOverrides: RequestInit

Returns Promise<Block>

getBlockByHashRaw

Summary

Throws

Memberof

Parameters

requestParameters: GetBlockByHashRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<Block>>

getBlockByHeight

Parameters

requestParameters: GetBlockByHeightRequest

Optional initOverrides: RequestInit

Returns Promise<Block>

getBlockByHeightRaw

Summary

Throws

Memberof

Parameters

requestParameters: GetBlockByHeightRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<Block>>

getBlockList

Parameters

requestParameters: GetBlockListRequest

Optional initOverrides: RequestInit

Returns Promise<BlockListResponse>

getBlockListRaw

Summary

Throws

Memberof

Parameters

requestParameters: GetBlockListRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<BlockListResponse>>

Settings

Member Visibility

Theme

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit