Interface MicroblocksApiInterface

MicroblocksApi - interface

Export

Interface

MicroblocksApiInterface

Hierarchy

MicroblocksApiInterface

Implemented by

MicroblocksApi

Index

Methods

getMicroblockByHash getMicroblockByHashRaw getMicroblockList getMicroblockListRaw getUnanchoredTxs getUnanchoredTxsRaw

Methods

getMicroblockByHash

getMicroblockByHash(requestParameters: GetMicroblockByHashRequest, initOverrides?: RequestInit): Promise<Microblock>
Retrieves a specific microblock by hash Get microblock
Parameters
- requestParameters: GetMicroblockByHashRequest
- Optional initOverrides: RequestInit
Returns Promise<Microblock>
- Defined in src/generated/apis/MicroblocksApi.ts:59

getMicroblockByHashRaw

getMicroblockByHashRaw(requestParameters: GetMicroblockByHashRequest, initOverrides?: RequestInit): Promise<ApiResponse<Microblock>>
Retrieves a specific microblock by hash

Summary
Get microblock

Throws

Memberof
MicroblocksApiInterface
Parameters
- requestParameters: GetMicroblockByHashRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<Microblock>>
- Defined in src/generated/apis/MicroblocksApi.ts:53

getMicroblockList

getMicroblockList(requestParameters: GetMicroblockListRequest, initOverrides?: RequestInit): Promise<MicroblockListResponse>
Retrieves a list of microblocks. If you need to actively monitor new microblocks, we highly recommend subscribing to WebSockets or Socket.io for real-time updates. Get recent microblocks
Parameters
- requestParameters: GetMicroblockListRequest
- Optional initOverrides: RequestInit
Returns Promise<MicroblockListResponse>
- Defined in src/generated/apis/MicroblocksApi.ts:76

getMicroblockListRaw

getMicroblockListRaw(requestParameters: GetMicroblockListRequest, initOverrides?: RequestInit): Promise<ApiResponse<MicroblockListResponse>>
Retrieves a list of microblocks. If you need to actively monitor new microblocks, we highly recommend subscribing to WebSockets or Socket.io for real-time updates.

Summary
Get recent microblocks

Throws

Memberof
MicroblocksApiInterface
Parameters
- requestParameters: GetMicroblockListRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<MicroblockListResponse>>
- Defined in src/generated/apis/MicroblocksApi.ts:70

getUnanchoredTxs

getUnanchoredTxs(initOverrides?: RequestInit): Promise<UnanchoredTransactionListResponse>
Retrieves transactions that have been streamed in microblocks but not yet accepted or rejected in an anchor block Get the list of current transactions that belong to unanchored microblocks
Parameters
- Optional initOverrides: RequestInit
Returns Promise<UnanchoredTransactionListResponse>
- Defined in src/generated/apis/MicroblocksApi.ts:91

getUnanchoredTxsRaw

getUnanchoredTxsRaw(initOverrides?: RequestInit): Promise<ApiResponse<UnanchoredTransactionListResponse>>
Retrieves transactions that have been streamed in microblocks but not yet accepted or rejected in an anchor block

Summary
Get the list of current transactions that belong to unanchored microblocks

Throws

Memberof
MicroblocksApiInterface
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<UnanchoredTransactionListResponse>>
- Defined in src/generated/apis/MicroblocksApi.ts:85

Interface MicroblocksApiInterface

Export

Interface

Hierarchy

Implemented by

Index

Methods

Methods

getMicroblockByHash

Parameters

requestParameters: GetMicroblockByHashRequest

Optional initOverrides: RequestInit

Returns Promise<Microblock>

getMicroblockByHashRaw

Summary

Throws

Memberof

Parameters

requestParameters: GetMicroblockByHashRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<Microblock>>

getMicroblockList

Parameters

requestParameters: GetMicroblockListRequest

Optional initOverrides: RequestInit

Returns Promise<MicroblockListResponse>

getMicroblockListRaw

Summary

Throws

Memberof

Parameters

requestParameters: GetMicroblockListRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<MicroblockListResponse>>

getUnanchoredTxs

Parameters

Optional initOverrides: RequestInit

Returns Promise<UnanchoredTransactionListResponse>

getUnanchoredTxsRaw

Summary

Throws

Memberof

Parameters

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<UnanchoredTransactionListResponse>>

Settings

Member Visibility

Theme

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit