Class OnChainYieldsApi

OnChainYieldsApi - object-oriented interface OnChainYieldsApi

Implements

OnChainYieldsApiInterface

Index

Constructors

Methods

getOnChainYieldsLockedPersonalLeftQuota getOnChainYieldsLockedProductList getOnChainYieldsLockedProductPosition getOnChainYieldsLockedRedemptionRecord getOnChainYieldsLockedRewardsHistory getOnChainYieldsLockedSubscriptionPreview getOnChainYieldsLockedSubscriptionRecord onChainYieldsAccount redeemOnChainYieldsLockedProduct setOnChainYieldsLockedAutoSubscribe setOnChainYieldsLockedProductRedeemOption subscribeOnChainYieldsLockedProduct

Constructors

constructor

new OnChainYieldsApi(configuration: ConfigurationRestAPI): OnChainYieldsApi
Parameters
- configuration: ConfigurationRestAPI
Returns OnChainYieldsApi
- Defined in clients/staking/src/rest-api/modules/on-chain-yields-api.ts:1391

Methods

getOnChainYieldsLockedPersonalLeftQuota

getOnChainYieldsLockedPersonalLeftQuota(
requestParameters: GetOnChainYieldsLockedPersonalLeftQuotaRequest,
): Promise<RestApiResponse<GetOnChainYieldsLockedPersonalLeftQuotaResponse>>
Get On-chain Yields Locked Personal Left Quota

Weight: 50
Parameters
- requestParameters: GetOnChainYieldsLockedPersonalLeftQuotaRequest
  Request parameters.
Returns Promise<RestApiResponse<GetOnChainYieldsLockedPersonalLeftQuotaResponse>>
Throws
Memberof
OnChainYieldsApi

See
Binance API Documentation
Implementation of OnChainYieldsApiInterface.getOnChainYieldsLockedPersonalLeftQuota
- Defined in clients/staking/src/rest-api/modules/on-chain-yields-api.ts:1408

getOnChainYieldsLockedProductList

getOnChainYieldsLockedProductList(
requestParameters?: GetOnChainYieldsLockedProductListRequest,
): Promise<RestApiResponse<GetOnChainYieldsLockedProductListResponse>>
Get available On-chain Yields Locked product list

Get available On-chain Yields Locked product list

Weight: 50
Parameters
- requestParameters: GetOnChainYieldsLockedProductListRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetOnChainYieldsLockedProductListResponse>>
Throws
Memberof
OnChainYieldsApi

See
Binance API Documentation
Implementation of OnChainYieldsApiInterface.getOnChainYieldsLockedProductList
- Defined in clients/staking/src/rest-api/modules/on-chain-yields-api.ts:1440

getOnChainYieldsLockedProductPosition

getOnChainYieldsLockedProductPosition(
requestParameters?: GetOnChainYieldsLockedProductPositionRequest,
): Promise<RestApiResponse<GetOnChainYieldsLockedProductPositionResponse>>
Get On-chain Yields Locked Product Position

Weight: 50
Parameters
- requestParameters: GetOnChainYieldsLockedProductPositionRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetOnChainYieldsLockedProductPositionResponse>>
Throws
Memberof
OnChainYieldsApi

See
Binance API Documentation
Implementation of OnChainYieldsApiInterface.getOnChainYieldsLockedProductPosition
- Defined in clients/staking/src/rest-api/modules/on-chain-yields-api.ts:1472

getOnChainYieldsLockedRedemptionRecord

getOnChainYieldsLockedRedemptionRecord(
requestParameters?: GetOnChainYieldsLockedRedemptionRecordRequest,
): Promise<RestApiResponse<GetOnChainYieldsLockedRedemptionRecordResponse>>
Get On-chain Yields Locked Redemption Record

The time between startTime and endTime cannot be longer than 3 months. If startTime and endTime are both not sent, then the last 30 days' data will be returned. If startTime is sent but endTime is not sent, the next 30 days' data beginning from startTime will be returned. If endTime is sent but startTime is not sent, the 30 days' data before endTime will be returned.

Weight: 50
Parameters
- requestParameters: GetOnChainYieldsLockedRedemptionRecordRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetOnChainYieldsLockedRedemptionRecordResponse>>
Throws
Memberof
OnChainYieldsApi

See
Binance API Documentation
Implementation of OnChainYieldsApiInterface.getOnChainYieldsLockedRedemptionRecord
- Defined in clients/staking/src/rest-api/modules/on-chain-yields-api.ts:1511

getOnChainYieldsLockedRewardsHistory

getOnChainYieldsLockedRewardsHistory(
requestParameters?: GetOnChainYieldsLockedRewardsHistoryRequest,
): Promise<RestApiResponse<GetOnChainYieldsLockedRewardsHistoryResponse>>
Get On-chain Yields Locked Rewards History

The time between startTime and endTime cannot be longer than 3 months. If startTime and endTime are both not sent, then the last 30 days' data will be returned. If startTime is sent but endTime is not sent, the next 30 days' data beginning from startTime will be returned. If endTime is sent but startTime is not sent, the 30 days' data before endTime will be returned.

Weight: 50
Parameters
- requestParameters: GetOnChainYieldsLockedRewardsHistoryRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetOnChainYieldsLockedRewardsHistoryResponse>>
Throws
Memberof
OnChainYieldsApi

See
Binance API Documentation
Implementation of OnChainYieldsApiInterface.getOnChainYieldsLockedRewardsHistory
- Defined in clients/staking/src/rest-api/modules/on-chain-yields-api.ts:1552

getOnChainYieldsLockedSubscriptionPreview

getOnChainYieldsLockedSubscriptionPreview(
requestParameters: GetOnChainYieldsLockedSubscriptionPreviewRequest,
): Promise<
RestApiResponse<GetOnChainYieldsLockedSubscriptionPreviewResponse>,
>
Get On-chain Yields Locked Subscription Preview

Weight: 50
Parameters
- requestParameters: GetOnChainYieldsLockedSubscriptionPreviewRequest
  Request parameters.
Returns Promise<RestApiResponse<GetOnChainYieldsLockedSubscriptionPreviewResponse>>
Throws
Memberof
OnChainYieldsApi

See
Binance API Documentation
Implementation of OnChainYieldsApiInterface.getOnChainYieldsLockedSubscriptionPreview
- Defined in clients/staking/src/rest-api/modules/on-chain-yields-api.ts:1587

getOnChainYieldsLockedSubscriptionRecord

getOnChainYieldsLockedSubscriptionRecord(
requestParameters?: GetOnChainYieldsLockedSubscriptionRecordRequest,
): Promise<
RestApiResponse<GetOnChainYieldsLockedSubscriptionRecordResponse>,
>
Get On-chain Yields Locked Subscription Record

The time between startTime and endTime cannot be longer than 3 months. If startTime and endTime are both not sent, then the last 30 days' data will be returned. If startTime is sent but endTime is not sent, the next 30 days' data beginning from startTime will be returned. If endTime is sent but startTime is not sent, the 30 days' data before endTime will be returned.

Weight: 50
Parameters
- requestParameters: GetOnChainYieldsLockedSubscriptionRecordRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetOnChainYieldsLockedSubscriptionRecordResponse>>
Throws
Memberof
OnChainYieldsApi

See
Binance API Documentation
Implementation of OnChainYieldsApiInterface.getOnChainYieldsLockedSubscriptionRecord
- Defined in clients/staking/src/rest-api/modules/on-chain-yields-api.ts:1624

onChainYieldsAccount

onChainYieldsAccount(
requestParameters?: OnChainYieldsAccountRequest,
): Promise<RestApiResponse<OnChainYieldsAccountResponse>>
On-chain Yields Account query

Weight: 50
Parameters
- requestParameters: OnChainYieldsAccountRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<OnChainYieldsAccountResponse>>
Throws
Memberof
OnChainYieldsApi

See
Binance API Documentation
Implementation of OnChainYieldsApiInterface.onChainYieldsAccount
- Defined in clients/staking/src/rest-api/modules/on-chain-yields-api.ts:1660

redeemOnChainYieldsLockedProduct

redeemOnChainYieldsLockedProduct(
requestParameters: RedeemOnChainYieldsLockedProductRequest,
): Promise<RestApiResponse<RedeemOnChainYieldsLockedProductResponse>>
Redeem On-chain Yields Locked Product

You need to open Enable Spot & Margin Trading permission for the API Key which requests this endpoint.

Weight: 1/3s per account
Parameters
- requestParameters: RedeemOnChainYieldsLockedProductRequest
  Request parameters.
Returns Promise<RestApiResponse<RedeemOnChainYieldsLockedProductResponse>>
Throws
Memberof
OnChainYieldsApi

See
Binance API Documentation
Implementation of OnChainYieldsApiInterface.redeemOnChainYieldsLockedProduct
- Defined in clients/staking/src/rest-api/modules/on-chain-yields-api.ts:1690

setOnChainYieldsLockedAutoSubscribe

setOnChainYieldsLockedAutoSubscribe(
requestParameters: SetOnChainYieldsLockedAutoSubscribeRequest,
): Promise<RestApiResponse<SetOnChainYieldsLockedAutoSubscribeResponse>>
Set On-chain Yield locked auto subscribe

Weight: 50
Parameters
- requestParameters: SetOnChainYieldsLockedAutoSubscribeRequest
  Request parameters.
Returns Promise<RestApiResponse<SetOnChainYieldsLockedAutoSubscribeResponse>>
Throws
Memberof
OnChainYieldsApi

See
Binance API Documentation
Implementation of OnChainYieldsApiInterface.setOnChainYieldsLockedAutoSubscribe
- Defined in clients/staking/src/rest-api/modules/on-chain-yields-api.ts:1721

setOnChainYieldsLockedProductRedeemOption

setOnChainYieldsLockedProductRedeemOption(
requestParameters: SetOnChainYieldsLockedProductRedeemOptionRequest,
): Promise<
RestApiResponse<SetOnChainYieldsLockedProductRedeemOptionResponse>,
>
Set On-chain Yields redeem option for Locked product

Weight: 50
Parameters
- requestParameters: SetOnChainYieldsLockedProductRedeemOptionRequest
  Request parameters.
Returns Promise<RestApiResponse<SetOnChainYieldsLockedProductRedeemOptionResponse>>
Throws
Memberof
OnChainYieldsApi

See
Binance API Documentation
Implementation of OnChainYieldsApiInterface.setOnChainYieldsLockedProductRedeemOption
- Defined in clients/staking/src/rest-api/modules/on-chain-yields-api.ts:1752

subscribeOnChainYieldsLockedProduct

subscribeOnChainYieldsLockedProduct(
requestParameters: SubscribeOnChainYieldsLockedProductRequest,
): Promise<RestApiResponse<SubscribeOnChainYieldsLockedProductResponse>>
Subscribe On-chain Yields Locked Product

You need to open Enable Spot & Margin Trading permission for the API Key which requests this endpoint.

Weight: 200
Parameters
- requestParameters: SubscribeOnChainYieldsLockedProductRequest
  Request parameters.
Returns Promise<RestApiResponse<SubscribeOnChainYieldsLockedProductResponse>>
Throws
Memberof
OnChainYieldsApi

See
Binance API Documentation
Implementation of OnChainYieldsApiInterface.subscribeOnChainYieldsLockedProduct
- Defined in clients/staking/src/rest-api/modules/on-chain-yields-api.ts:1785

Class OnChainYieldsApi

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns OnChainYieldsApi

Methods

getOnChainYieldsLockedPersonalLeftQuota

Parameters

Returns Promise<RestApiResponse<GetOnChainYieldsLockedPersonalLeftQuotaResponse>>

Throws

Memberof

See

getOnChainYieldsLockedProductList

Parameters

Returns Promise<RestApiResponse<GetOnChainYieldsLockedProductListResponse>>

Throws

Memberof

See

getOnChainYieldsLockedProductPosition

Parameters

Returns Promise<RestApiResponse<GetOnChainYieldsLockedProductPositionResponse>>

Throws

Memberof

See

getOnChainYieldsLockedRedemptionRecord

Parameters

Returns Promise<RestApiResponse<GetOnChainYieldsLockedRedemptionRecordResponse>>

Throws

Memberof

See

getOnChainYieldsLockedRewardsHistory

Parameters

Returns Promise<RestApiResponse<GetOnChainYieldsLockedRewardsHistoryResponse>>

Throws

Memberof

See

getOnChainYieldsLockedSubscriptionPreview

Parameters

Returns Promise<RestApiResponse<GetOnChainYieldsLockedSubscriptionPreviewResponse>>

Throws

Memberof

See

getOnChainYieldsLockedSubscriptionRecord

Parameters

Returns Promise<RestApiResponse<GetOnChainYieldsLockedSubscriptionRecordResponse>>

Throws

Memberof

See

onChainYieldsAccount

Parameters

Returns Promise<RestApiResponse<OnChainYieldsAccountResponse>>

Throws

Memberof

See

redeemOnChainYieldsLockedProduct

Parameters

Returns Promise<RestApiResponse<RedeemOnChainYieldsLockedProductResponse>>

Throws

Memberof

See

setOnChainYieldsLockedAutoSubscribe

Parameters

Returns Promise<RestApiResponse<SetOnChainYieldsLockedAutoSubscribeResponse>>

Throws

Memberof

See

setOnChainYieldsLockedProductRedeemOption

Parameters

Returns Promise<RestApiResponse<SetOnChainYieldsLockedProductRedeemOptionResponse>>

Throws

Memberof

See

subscribeOnChainYieldsLockedProduct

Parameters

Returns Promise<RestApiResponse<SubscribeOnChainYieldsLockedProductResponse>>

Throws