Class EarnApi

EarnApi - object-oriented interface EarnApi

Implements

EarnApiInterface

Index

Constructors

Methods

getFlexibleSubscriptionPreview getLockedSubscriptionPreview redeemFlexibleProduct redeemLockedProduct setFlexibleAutoSubscribe setLockedAutoSubscribe setLockedProductRedeemOption subscribeFlexibleProduct subscribeLockedProduct

Constructors

constructor

new EarnApi(configuration: ConfigurationRestAPI): EarnApi
Parameters
- configuration: ConfigurationRestAPI
Returns EarnApi
- Defined in clients/simple-earn/src/rest-api/modules/earn-api.ts:943

Methods

getFlexibleSubscriptionPreview

getFlexibleSubscriptionPreview(
requestParameters: GetFlexibleSubscriptionPreviewRequest,
): Promise<RestApiResponse<GetFlexibleSubscriptionPreviewResponse>>
Get Flexible Subscription Preview

Weight: 150
Parameters
- requestParameters: GetFlexibleSubscriptionPreviewRequest
  Request parameters.
Returns Promise<RestApiResponse<GetFlexibleSubscriptionPreviewResponse>>
Throws
Memberof
EarnApi

See
Binance API Documentation
Implementation of EarnApiInterface.getFlexibleSubscriptionPreview
- Defined in clients/simple-earn/src/rest-api/modules/earn-api.ts:960

getLockedSubscriptionPreview

getLockedSubscriptionPreview(
requestParameters: GetLockedSubscriptionPreviewRequest,
): Promise<RestApiResponse<GetLockedSubscriptionPreviewResponse>>
Get Locked Subscription Preview

Weight: 150
Parameters
- requestParameters: GetLockedSubscriptionPreviewRequest
  Request parameters.
Returns Promise<RestApiResponse<GetLockedSubscriptionPreviewResponse>>
Throws
Memberof
EarnApi

See
Binance API Documentation
Implementation of EarnApiInterface.getLockedSubscriptionPreview
- Defined in clients/simple-earn/src/rest-api/modules/earn-api.ts:991

redeemFlexibleProduct

redeemFlexibleProduct(
requestParameters: RedeemFlexibleProductRequest,
): Promise<RestApiResponse<RedeemFlexibleProductResponse>>
Redeem Flexible Product

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

Weight: 1
Parameters
- requestParameters: RedeemFlexibleProductRequest
  Request parameters.
Returns Promise<RestApiResponse<RedeemFlexibleProductResponse>>
Throws
Memberof
EarnApi

See
Binance API Documentation
Implementation of EarnApiInterface.redeemFlexibleProduct
- Defined in clients/simple-earn/src/rest-api/modules/earn-api.ts:1024

redeemLockedProduct

redeemLockedProduct(
requestParameters: RedeemLockedProductRequest,
): Promise<RestApiResponse<RedeemLockedProductResponse>>
Redeem 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: RedeemLockedProductRequest
  Request parameters.
Returns Promise<RestApiResponse<RedeemLockedProductResponse>>
Throws
Memberof
EarnApi

See
Binance API Documentation
Implementation of EarnApiInterface.redeemLockedProduct
- Defined in clients/simple-earn/src/rest-api/modules/earn-api.ts:1058

setFlexibleAutoSubscribe

setFlexibleAutoSubscribe(
requestParameters: SetFlexibleAutoSubscribeRequest,
): Promise<RestApiResponse<SetFlexibleAutoSubscribeResponse>>
Set Flexible Auto Subscribe

Weight: 150
Parameters
- requestParameters: SetFlexibleAutoSubscribeRequest
  Request parameters.
Returns Promise<RestApiResponse<SetFlexibleAutoSubscribeResponse>>
Throws
Memberof
EarnApi

See
Binance API Documentation
Implementation of EarnApiInterface.setFlexibleAutoSubscribe
- Defined in clients/simple-earn/src/rest-api/modules/earn-api.ts:1087

setLockedAutoSubscribe

setLockedAutoSubscribe(
requestParameters: SetLockedAutoSubscribeRequest,
): Promise<RestApiResponse<SetLockedAutoSubscribeResponse>>
Set locked auto subscribe

Weight: 150
Parameters
- requestParameters: SetLockedAutoSubscribeRequest
  Request parameters.
Returns Promise<RestApiResponse<SetLockedAutoSubscribeResponse>>
Throws
Memberof
EarnApi

See
Binance API Documentation
Implementation of EarnApiInterface.setLockedAutoSubscribe
- Defined in clients/simple-earn/src/rest-api/modules/earn-api.ts:1117

setLockedProductRedeemOption

setLockedProductRedeemOption(
requestParameters: SetLockedProductRedeemOptionRequest,
): Promise<RestApiResponse<SetLockedProductRedeemOptionResponse>>
Set redeem option for Locked product

Weight: 50
Parameters
- requestParameters: SetLockedProductRedeemOptionRequest
  Request parameters.
Returns Promise<RestApiResponse<SetLockedProductRedeemOptionResponse>>
Throws
Memberof
EarnApi

See
Binance API Documentation
Implementation of EarnApiInterface.setLockedProductRedeemOption
- Defined in clients/simple-earn/src/rest-api/modules/earn-api.ts:1147

subscribeFlexibleProduct

subscribeFlexibleProduct(
requestParameters: SubscribeFlexibleProductRequest,
): Promise<RestApiResponse<SubscribeFlexibleProductResponse>>
Subscribe Flexible Product

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

Weight: 1
Parameters
- requestParameters: SubscribeFlexibleProductRequest
  Request parameters.
Returns Promise<RestApiResponse<SubscribeFlexibleProductResponse>>
Throws
Memberof
EarnApi

See
Binance API Documentation
Implementation of EarnApiInterface.subscribeFlexibleProduct
- Defined in clients/simple-earn/src/rest-api/modules/earn-api.ts:1179

subscribeLockedProduct

subscribeLockedProduct(
requestParameters: SubscribeLockedProductRequest,
): Promise<RestApiResponse<SubscribeLockedProductResponse>>
Subscribe Locked Product

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

Weight: 1
Parameters
- requestParameters: SubscribeLockedProductRequest
  Request parameters.
Returns Promise<RestApiResponse<SubscribeLockedProductResponse>>
Throws
Memberof
EarnApi

See
Binance API Documentation
Implementation of EarnApiInterface.subscribeLockedProduct
- Defined in clients/simple-earn/src/rest-api/modules/earn-api.ts:1213

Class EarnApi

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns EarnApi

Methods

getFlexibleSubscriptionPreview

Parameters

Returns Promise<RestApiResponse<GetFlexibleSubscriptionPreviewResponse>>

Throws

Memberof

See

getLockedSubscriptionPreview

Parameters

Returns Promise<RestApiResponse<GetLockedSubscriptionPreviewResponse>>

Throws

Memberof

See

redeemFlexibleProduct

Parameters

Returns Promise<RestApiResponse<RedeemFlexibleProductResponse>>

Throws

Memberof

See

redeemLockedProduct

Parameters

Returns Promise<RestApiResponse<RedeemLockedProductResponse>>

Throws

Memberof

See

setFlexibleAutoSubscribe

Parameters

Returns Promise<RestApiResponse<SetFlexibleAutoSubscribeResponse>>

Throws

Memberof

See

setLockedAutoSubscribe

Parameters

Returns Promise<RestApiResponse<SetLockedAutoSubscribeResponse>>

Throws

Memberof

See

setLockedProductRedeemOption

Parameters

Returns Promise<RestApiResponse<SetLockedProductRedeemOptionResponse>>

Throws

Memberof

See

subscribeFlexibleProduct

Parameters

Returns Promise<RestApiResponse<SubscribeFlexibleProductResponse>>

Throws

Memberof

See

subscribeLockedProduct

Parameters

Returns Promise<RestApiResponse<SubscribeLockedProductResponse>>

Throws

Memberof

See

Settings

On This Page