Class StackingRewardsApi

Hierarchy

BaseAPI
- StackingRewardsApi

Implements

StackingRewardsApiInterface

Index

Constructors

constructor

new StackingRewardsApi(configuration?: Configuration): StackingRewardsApi
Parameters
- configuration: Configuration = ...
Returns StackingRewardsApi
Inherited from BaseAPI.constructor
- Defined in src/generated/runtime.ts:27

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

getBurnchainRewardList

getBurnchainRewardList(requestParameters: GetBurnchainRewardListRequest, initOverrides?: RequestInit): Promise<BurnchainRewardListResponse>
Retrieves a list of recent burnchain (e.g. Bitcoin) reward recipients with the associated amounts and block info Get recent burnchain reward recipients
Parameters
- requestParameters: GetBurnchainRewardListRequest
- Optional initOverrides: RequestInit
Returns Promise<BurnchainRewardListResponse>
Implementation of StackingRewardsApiInterface.getBurnchainRewardList
- Defined in src/generated/apis/StackingRewardsApi.ts:186

getBurnchainRewardListByAddress

getBurnchainRewardListByAddress(requestParameters: GetBurnchainRewardListByAddressRequest, initOverrides?: RequestInit): Promise<BurnchainRewardListResponse>
Retrieves a list of recent burnchain (e.g. Bitcoin) rewards for the given recipient with the associated amounts and block info Get recent burnchain reward for the given recipient
Parameters
- requestParameters: GetBurnchainRewardListByAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<BurnchainRewardListResponse>
Implementation of StackingRewardsApiInterface.getBurnchainRewardListByAddress
- Defined in src/generated/apis/StackingRewardsApi.ts:226

getBurnchainRewardListByAddressRaw

getBurnchainRewardListByAddressRaw(requestParameters: GetBurnchainRewardListByAddressRequest, initOverrides?: RequestInit): Promise<ApiResponse<BurnchainRewardListResponse>>
Retrieves a list of recent burnchain (e.g. Bitcoin) rewards for the given recipient with the associated amounts and block info Get recent burnchain reward for the given recipient
Parameters
- requestParameters: GetBurnchainRewardListByAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<BurnchainRewardListResponse>>
Implementation of StackingRewardsApiInterface.getBurnchainRewardListByAddressRaw
- Defined in src/generated/apis/StackingRewardsApi.ts:195

getBurnchainRewardListRaw

getBurnchainRewardListRaw(requestParameters: GetBurnchainRewardListRequest, initOverrides?: RequestInit): Promise<ApiResponse<BurnchainRewardListResponse>>
Retrieves a list of recent burnchain (e.g. Bitcoin) reward recipients with the associated amounts and block info Get recent burnchain reward recipients
Parameters
- requestParameters: GetBurnchainRewardListRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<BurnchainRewardListResponse>>
Implementation of StackingRewardsApiInterface.getBurnchainRewardListRaw
- Defined in src/generated/apis/StackingRewardsApi.ts:159

getBurnchainRewardSlotHolders

getBurnchainRewardSlotHolders(requestParameters: GetBurnchainRewardSlotHoldersRequest, initOverrides?: RequestInit): Promise<BurnchainRewardSlotHolderListResponse>
Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments. Get recent reward slot holders
Parameters
- requestParameters: GetBurnchainRewardSlotHoldersRequest
- Optional initOverrides: RequestInit
Returns Promise<BurnchainRewardSlotHolderListResponse>
Implementation of StackingRewardsApiInterface.getBurnchainRewardSlotHolders
- Defined in src/generated/apis/StackingRewardsApi.ts:262

getBurnchainRewardSlotHoldersByAddress

getBurnchainRewardSlotHoldersByAddress(requestParameters: GetBurnchainRewardSlotHoldersByAddressRequest, initOverrides?: RequestInit): Promise<BurnchainRewardSlotHolderListResponse>
Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments for a given reward slot holder recipient address. Get recent reward slot holder entries for the given address
Parameters
- requestParameters: GetBurnchainRewardSlotHoldersByAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<BurnchainRewardSlotHolderListResponse>
Implementation of StackingRewardsApiInterface.getBurnchainRewardSlotHoldersByAddress
- Defined in src/generated/apis/StackingRewardsApi.ts:302

getBurnchainRewardSlotHoldersByAddressRaw

getBurnchainRewardSlotHoldersByAddressRaw(requestParameters: GetBurnchainRewardSlotHoldersByAddressRequest, initOverrides?: RequestInit): Promise<ApiResponse<BurnchainRewardSlotHolderListResponse>>
Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments for a given reward slot holder recipient address. Get recent reward slot holder entries for the given address
Parameters
- requestParameters: GetBurnchainRewardSlotHoldersByAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<BurnchainRewardSlotHolderListResponse>>
Implementation of StackingRewardsApiInterface.getBurnchainRewardSlotHoldersByAddressRaw
- Defined in src/generated/apis/StackingRewardsApi.ts:271

getBurnchainRewardSlotHoldersRaw

getBurnchainRewardSlotHoldersRaw(requestParameters: GetBurnchainRewardSlotHoldersRequest, initOverrides?: RequestInit): Promise<ApiResponse<BurnchainRewardSlotHolderListResponse>>
Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments. Get recent reward slot holders
Parameters
- requestParameters: GetBurnchainRewardSlotHoldersRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<BurnchainRewardSlotHolderListResponse>>
Implementation of StackingRewardsApiInterface.getBurnchainRewardSlotHoldersRaw
- Defined in src/generated/apis/StackingRewardsApi.ts:235

getBurnchainRewardsTotalByAddress

getBurnchainRewardsTotalByAddress(requestParameters: GetBurnchainRewardsTotalByAddressRequest, initOverrides?: RequestInit): Promise<BurnchainRewardsTotal>
Retrieves the total burnchain (e.g. Bitcoin) rewards for a given recipient address Get total burnchain rewards for the given recipient
Parameters
- requestParameters: GetBurnchainRewardsTotalByAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<BurnchainRewardsTotal>
Implementation of StackingRewardsApiInterface.getBurnchainRewardsTotalByAddress
- Defined in src/generated/apis/StackingRewardsApi.ts:334

getBurnchainRewardsTotalByAddressRaw

getBurnchainRewardsTotalByAddressRaw(requestParameters: GetBurnchainRewardsTotalByAddressRequest, initOverrides?: RequestInit): Promise<ApiResponse<BurnchainRewardsTotal>>
Retrieves the total burnchain (e.g. Bitcoin) rewards for a given recipient address Get total burnchain rewards for the given recipient
Parameters
- requestParameters: GetBurnchainRewardsTotalByAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<BurnchainRewardsTotal>>
Implementation of StackingRewardsApiInterface.getBurnchainRewardsTotalByAddressRaw
- Defined in src/generated/apis/StackingRewardsApi.ts:311

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in src/generated/runtime.ts:47

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in src/generated/runtime.ts:31

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in src/generated/runtime.ts:42

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in src/generated/runtime.ts:37

Class StackingRewardsApi

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = ...

Returns StackingRewardsApi

Properties

Protected configuration

Methods

getBurnchainRewardList

Parameters

requestParameters: GetBurnchainRewardListRequest

Optional initOverrides: RequestInit

Returns Promise<BurnchainRewardListResponse>

getBurnchainRewardListByAddress

Parameters

requestParameters: GetBurnchainRewardListByAddressRequest

Optional initOverrides: RequestInit

Returns Promise<BurnchainRewardListResponse>

getBurnchainRewardListByAddressRaw

Parameters

requestParameters: GetBurnchainRewardListByAddressRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<BurnchainRewardListResponse>>

getBurnchainRewardListRaw

Parameters

requestParameters: GetBurnchainRewardListRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<BurnchainRewardListResponse>>

getBurnchainRewardSlotHolders

Parameters

requestParameters: GetBurnchainRewardSlotHoldersRequest

Optional initOverrides: RequestInit

Returns Promise<BurnchainRewardSlotHolderListResponse>

getBurnchainRewardSlotHoldersByAddress

Parameters

requestParameters: GetBurnchainRewardSlotHoldersByAddressRequest

Optional initOverrides: RequestInit

Returns Promise<BurnchainRewardSlotHolderListResponse>

getBurnchainRewardSlotHoldersByAddressRaw

Parameters

requestParameters: GetBurnchainRewardSlotHoldersByAddressRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<BurnchainRewardSlotHolderListResponse>>

getBurnchainRewardSlotHoldersRaw

Parameters

requestParameters: GetBurnchainRewardSlotHoldersRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<BurnchainRewardSlotHolderListResponse>>

getBurnchainRewardsTotalByAddress

Parameters

requestParameters: GetBurnchainRewardsTotalByAddressRequest

Optional initOverrides: RequestInit

Returns Promise<BurnchainRewardsTotal>

getBurnchainRewardsTotalByAddressRaw

Parameters

requestParameters: GetBurnchainRewardsTotalByAddressRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<BurnchainRewardsTotal>>

Protected request

Parameters

context: RequestOpts

Optional initOverrides: RequestInit

Returns Promise<Response>

withMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

Rest ...middlewares: Middleware[]

Returns T

withPostMiddleware

Type Parameters

T extends BaseAPI<T>

`Protected` configuration

`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

`Protected` request

`Optional` initOverrides: RequestInit

`Rest` ...middlewares: Middleware[]

`Rest` ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]

`Rest` ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]