Class BfusdApi

BfusdApi - object-oriented interface BfusdApi

Implements

BfusdApiInterface

Index

Constructors

Methods

getBfusdAccount getBfusdQuotaDetails getBfusdRateHistory getBfusdRedemptionHistory getBfusdRewardsHistory getBfusdSubscriptionHistory redeemBfusd subscribeBfusd

Constructors

constructor

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

Methods

getBfusdAccount

getBfusdAccount(
requestParameters?: GetBfusdAccountRequest,
): Promise<RestApiResponse<GetBfusdAccountResponse>>
Get BFUSD account information.

Weight(IP): 150

Security Type: USER_DATA
Parameters
- requestParameters: GetBfusdAccountRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetBfusdAccountResponse>>
Throws
Memberof
BfusdApi

See
Binance API Documentation
Implementation of BfusdApiInterface.getBfusdAccount
- Defined in clients/simple-earn/src/rest-api/modules/bfusd-api.ts:940

getBfusdQuotaDetails

getBfusdQuotaDetails(
requestParameters?: GetBfusdQuotaDetailsRequest,
): Promise<RestApiResponse<GetBfusdQuotaDetailsResponse>>
Get BFUSD quota details including subscription quota, fast redemption quota, and standard redemption quota.

Weight(IP): 150

Security Type: USER_DATA
Parameters
- requestParameters: GetBfusdQuotaDetailsRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetBfusdQuotaDetailsResponse>>
Throws
Memberof
BfusdApi

See
Binance API Documentation
Implementation of BfusdApiInterface.getBfusdQuotaDetails
- Defined in clients/simple-earn/src/rest-api/modules/bfusd-api.ts:972

getBfusdRateHistory

getBfusdRateHistory(
requestParameters?: GetBfusdRateHistoryRequest,
): Promise<RestApiResponse<GetBfusdRateHistoryResponse>>
Get BFUSD rate history sorted by descending order.

Weight(IP): 150

Security Type: USER_DATA

Notes:
- The time between startTime and endTime cannot be longer than 6 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, endTime will default to current time, and results from startTime onward will be returned.
- If endTime is sent but startTime is not sent, startTime defaults to the current time minus one month, and data between startTime and endTime will be returned.
Parameters
- requestParameters: GetBfusdRateHistoryRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetBfusdRateHistoryResponse>>
Throws
Memberof
BfusdApi

See
Binance API Documentation
Implementation of BfusdApiInterface.getBfusdRateHistory
- Defined in clients/simple-earn/src/rest-api/modules/bfusd-api.ts:1014

getBfusdRedemptionHistory

getBfusdRedemptionHistory(
requestParameters?: GetBfusdRedemptionHistoryRequest,
): Promise<RestApiResponse<GetBfusdRedemptionHistoryResponse>>
Get BFUSD redemption history

Weight(IP): 150

Security Type: USER_DATA

Notes:
- The time between startTime and endTime cannot be longer than 6 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, endTime will default to current time, and results from startTime onward will be returned.
- If endTime is sent but startTime is not sent, startTime defaults to the current time minus one month, and data between startTime and endTime will be returned.
Parameters
- requestParameters: GetBfusdRedemptionHistoryRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetBfusdRedemptionHistoryResponse>>
Throws
Memberof
BfusdApi

See
Binance API Documentation
Implementation of BfusdApiInterface.getBfusdRedemptionHistory
- Defined in clients/simple-earn/src/rest-api/modules/bfusd-api.ts:1060

getBfusdRewardsHistory

getBfusdRewardsHistory(
requestParameters?: GetBfusdRewardsHistoryRequest,
): Promise<RestApiResponse<GetBfusdRewardsHistoryResponse>>
Get BFUSD rewards history

Weight(IP): 150

Security Type: USER_DATA

Notes:
- The time between startTime and endTime cannot be longer than 6 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, endTime will default to current time, and results from startTime onward will be returned.
- If endTime is sent but startTime is not sent, startTime defaults to the current time minus one month, and data between startTime and endTime will be returned.
Parameters
- requestParameters: GetBfusdRewardsHistoryRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetBfusdRewardsHistoryResponse>>
Throws
Memberof
BfusdApi

See
Binance API Documentation
Implementation of BfusdApiInterface.getBfusdRewardsHistory
- Defined in clients/simple-earn/src/rest-api/modules/bfusd-api.ts:1106

getBfusdSubscriptionHistory

getBfusdSubscriptionHistory(
requestParameters?: GetBfusdSubscriptionHistoryRequest,
): Promise<RestApiResponse<GetBfusdSubscriptionHistoryResponse>>
Get BFUSD subscription history

Weight(IP): 150

Security Type: USER_DATA

Notes:
- The time between startTime and endTime cannot be longer than 6 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, endTime will default to current time, and results from startTime onward will be returned.
- If endTime is sent but startTime is not sent, startTime defaults to the current time advanced by one month, and data between startTime and endTime will be returned.
Parameters
- requestParameters: GetBfusdSubscriptionHistoryRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetBfusdSubscriptionHistoryResponse>>
Throws
Memberof
BfusdApi

See
Binance API Documentation
Implementation of BfusdApiInterface.getBfusdSubscriptionHistory
- Defined in clients/simple-earn/src/rest-api/modules/bfusd-api.ts:1152

redeemBfusd

redeemBfusd(
requestParameters: RedeemBfusdRequest,
): Promise<RestApiResponse<RedeemBfusdResponse>>
Redeem BFUSD to USDT

Weight(IP): 150

Security Type: TRADE

Notes:
- You need to open Enable Spot & Margin Trading permission for the API Key which requests this endpoint.
- This API only supports BFUSD redemption to the Spot Account. Redemptions to the Funding Account or any other account type are not supported.
Parameters
- requestParameters: RedeemBfusdRequest
  Request parameters.
Returns Promise<RestApiResponse<RedeemBfusdResponse>>
Throws
Memberof
BfusdApi

See
Binance API Documentation
Implementation of BfusdApiInterface.redeemBfusd
- Defined in clients/simple-earn/src/rest-api/modules/bfusd-api.ts:1193

subscribeBfusd

subscribeBfusd(
requestParameters: SubscribeBfusdRequest,
): Promise<RestApiResponse<SubscribeBfusdResponse>>
Subscribe BFUSD

Weight(IP): 150

Security Type: TRADE

Notes:
- You need to open Enable Spot & Margin Trading permission for the API Key which requests this endpoint.
- This API only supports BFUSD subscription using assets held in the Spot Account. Subscriptions initiated from the Funding Account or any other account type are not supported.
Parameters
- requestParameters: SubscribeBfusdRequest
  Request parameters.
Returns Promise<RestApiResponse<SubscribeBfusdResponse>>
Throws
Memberof
BfusdApi

See
Binance API Documentation
Implementation of BfusdApiInterface.subscribeBfusd
- Defined in clients/simple-earn/src/rest-api/modules/bfusd-api.ts:1231

Class BfusdApi

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns BfusdApi

Methods

getBfusdAccount

Parameters

Returns Promise<RestApiResponse<GetBfusdAccountResponse>>

Throws

Memberof

See

getBfusdQuotaDetails

Parameters

Returns Promise<RestApiResponse<GetBfusdQuotaDetailsResponse>>

Throws

Memberof

See

getBfusdRateHistory

Parameters

Returns Promise<RestApiResponse<GetBfusdRateHistoryResponse>>

Throws

Memberof

See

getBfusdRedemptionHistory

Parameters

Returns Promise<RestApiResponse<GetBfusdRedemptionHistoryResponse>>

Throws

Memberof

See

getBfusdRewardsHistory

Parameters

Returns Promise<RestApiResponse<GetBfusdRewardsHistoryResponse>>

Throws

Memberof

See

getBfusdSubscriptionHistory

Parameters

Returns Promise<RestApiResponse<GetBfusdSubscriptionHistoryResponse>>

Throws

Memberof

See

redeemBfusd

Parameters

Returns Promise<RestApiResponse<RedeemBfusdResponse>>

Throws

Memberof

See

subscribeBfusd

Parameters

Returns Promise<RestApiResponse<SubscribeBfusdResponse>>

Throws

Memberof

See

Settings

On This Page