Class EthStakingApi

EthStakingApi - object-oriented interface EthStakingApi

Implements

EthStakingApiInterface

Index

Constructors

Methods

ethStakingAccount getCurrentEthStakingQuota getEthRedemptionHistory getEthStakingHistory getWbethRateHistory getWbethRewardsHistory getWbethUnwrapHistory getWbethWrapHistory redeemEth subscribeEthStaking wrapBeth

Constructors

constructor

new EthStakingApi(configuration: ConfigurationRestAPI): EthStakingApi
Parameters
- configuration: ConfigurationRestAPI
Returns EthStakingApi
- Defined in clients/staking/src/rest-api/modules/eth-staking-api.ts:1246

Methods

ethStakingAccount

ethStakingAccount(
requestParameters?: EthStakingAccountRequest,
): Promise<RestApiResponse<EthStakingAccountResponse>>
ETH Staking account

Weight(IP): 150

Security Type: USER_DATA
Parameters
- requestParameters: EthStakingAccountRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<EthStakingAccountResponse>>
Throws
Memberof
EthStakingApi

See
Binance API Documentation
Implementation of EthStakingApiInterface.ethStakingAccount
- Defined in clients/staking/src/rest-api/modules/eth-staking-api.ts:1265

getCurrentEthStakingQuota

getCurrentEthStakingQuota(
requestParameters?: GetCurrentEthStakingQuotaRequest,
): Promise<RestApiResponse<GetCurrentEthStakingQuotaResponse>>
Get current ETH staking quota

Weight(IP): 150

Security Type: USER_DATA
Parameters
- requestParameters: GetCurrentEthStakingQuotaRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetCurrentEthStakingQuotaResponse>>
Throws
Memberof
EthStakingApi

See
Binance API Documentation
Implementation of EthStakingApiInterface.getCurrentEthStakingQuota
- Defined in clients/staking/src/rest-api/modules/eth-staking-api.ts:1297

getEthRedemptionHistory

getEthRedemptionHistory(
requestParameters?: GetEthRedemptionHistoryRequest,
): Promise<RestApiResponse<GetEthRedemptionHistoryResponse>>
Get ETH redemption history

Weight(IP): 150

Security Type: USER_DATA

Notes:
- 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.
Parameters
- requestParameters: GetEthRedemptionHistoryRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetEthRedemptionHistoryResponse>>
Throws
Memberof
EthStakingApi

See
Binance API Documentation
Implementation of EthStakingApiInterface.getEthRedemptionHistory
- Defined in clients/staking/src/rest-api/modules/eth-staking-api.ts:1338

getEthStakingHistory

getEthStakingHistory(
requestParameters?: GetEthStakingHistoryRequest,
): Promise<RestApiResponse<GetEthStakingHistoryResponse>>
Get ETH staking history

Weight(IP): 150

Security Type: USER_DATA

Notes:
- 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.
Parameters
- requestParameters: GetEthStakingHistoryRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetEthStakingHistoryResponse>>
Throws
Memberof
EthStakingApi

See
Binance API Documentation
Implementation of EthStakingApiInterface.getEthStakingHistory
- Defined in clients/staking/src/rest-api/modules/eth-staking-api.ts:1384

getWbethRateHistory

getWbethRateHistory(
requestParameters?: GetWbethRateHistoryRequest,
): Promise<RestApiResponse<GetWbethRateHistoryResponse>>
Get WBETH Rate History

Weight(IP): 150

Security Type: USER_DATA

Notes:
- 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.
Parameters
- requestParameters: GetWbethRateHistoryRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetWbethRateHistoryResponse>>
Throws
Memberof
EthStakingApi

See
Binance API Documentation
Implementation of EthStakingApiInterface.getWbethRateHistory
- Defined in clients/staking/src/rest-api/modules/eth-staking-api.ts:1430

getWbethRewardsHistory

getWbethRewardsHistory(
requestParameters?: GetWbethRewardsHistoryRequest,
): Promise<RestApiResponse<GetWbethRewardsHistoryResponse>>
Get WBETH rewards history

Weight(IP): 150

Security Type: USER_DATA

Notes:
- 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.
Parameters
- requestParameters: GetWbethRewardsHistoryRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetWbethRewardsHistoryResponse>>
Throws
Memberof
EthStakingApi

See
Binance API Documentation
Implementation of EthStakingApiInterface.getWbethRewardsHistory
- Defined in clients/staking/src/rest-api/modules/eth-staking-api.ts:1475

getWbethUnwrapHistory

getWbethUnwrapHistory(
requestParameters?: GetWbethUnwrapHistoryRequest,
): Promise<RestApiResponse<GetWbethUnwrapHistoryResponse>>
Get WBETH unwrap history

Weight(IP): 150

Security Type: USER_DATA

Notes:
- 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.
Parameters
- requestParameters: GetWbethUnwrapHistoryRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetWbethUnwrapHistoryResponse>>
Throws
Memberof
EthStakingApi

See
Binance API Documentation
Implementation of EthStakingApiInterface.getWbethUnwrapHistory
- Defined in clients/staking/src/rest-api/modules/eth-staking-api.ts:1520

getWbethWrapHistory

getWbethWrapHistory(
requestParameters?: GetWbethWrapHistoryRequest,
): Promise<RestApiResponse<GetWbethWrapHistoryResponse>>
Get WBETH wrap history

Weight(IP): 150

Security Type: USER_DATA

Notes:
- 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.
Parameters
- requestParameters: GetWbethWrapHistoryRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetWbethWrapHistoryResponse>>
Throws
Memberof
EthStakingApi

See
Binance API Documentation
Implementation of EthStakingApiInterface.getWbethWrapHistory
- Defined in clients/staking/src/rest-api/modules/eth-staking-api.ts:1565

redeemEth

redeemEth(
requestParameters: RedeemEthRequest,
): Promise<RestApiResponse<RedeemEthResponse>>
Redeem WBETH or BETH and get ETH

Weight(IP): 150

Security Type: TRADE

Notes:
- You need to open Enable Spot & Margin Trading permission for the API Key which requests this endpoint.
Parameters
- requestParameters: RedeemEthRequest
  Request parameters.
Returns Promise<RestApiResponse<RedeemEthResponse>>
Throws
Memberof
EthStakingApi

See
Binance API Documentation
Implementation of EthStakingApiInterface.redeemEth
- Defined in clients/staking/src/rest-api/modules/eth-staking-api.ts:1604

subscribeEthStaking

subscribeEthStaking(
requestParameters: SubscribeEthStakingRequest,
): Promise<RestApiResponse<SubscribeEthStakingResponse>>
Subscribe ETH Staking

Weight(IP): 150

Security Type: TRADE

Notes:
- You need to open Enable Spot & Margin Trading permission for the API Key which requests this endpoint.
Parameters
- requestParameters: SubscribeEthStakingRequest
  Request parameters.
Returns Promise<RestApiResponse<SubscribeEthStakingResponse>>
Throws
Memberof
EthStakingApi

See
Binance API Documentation
Implementation of EthStakingApiInterface.subscribeEthStaking
- Defined in clients/staking/src/rest-api/modules/eth-staking-api.ts:1641

wrapBeth

wrapBeth(
requestParameters: WrapBethRequest,
): Promise<RestApiResponse<WrapBethResponse>>
Wrap BETH

Weight(IP): 150

Security Type: TRADE

Notes:
- You need to open Enable Spot & Margin Trading permission for the API Key which requests this endpoint.
Parameters
- requestParameters: WrapBethRequest
  Request parameters.
Returns Promise<RestApiResponse<WrapBethResponse>>
Throws
Memberof
EthStakingApi

See
Binance API Documentation
Implementation of EthStakingApiInterface.wrapBeth
- Defined in clients/staking/src/rest-api/modules/eth-staking-api.ts:1677

Class EthStakingApi

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns EthStakingApi

Methods

ethStakingAccount

Parameters

Returns Promise<RestApiResponse<EthStakingAccountResponse>>

Throws

Memberof

See

getCurrentEthStakingQuota

Parameters

Returns Promise<RestApiResponse<GetCurrentEthStakingQuotaResponse>>

Throws

Memberof

See

getEthRedemptionHistory

Parameters

Returns Promise<RestApiResponse<GetEthRedemptionHistoryResponse>>

Throws

Memberof

See

getEthStakingHistory

Parameters

Returns Promise<RestApiResponse<GetEthStakingHistoryResponse>>

Throws

Memberof

See

getWbethRateHistory

Parameters

Returns Promise<RestApiResponse<GetWbethRateHistoryResponse>>

Throws

Memberof

See

getWbethRewardsHistory

Parameters

Returns Promise<RestApiResponse<GetWbethRewardsHistoryResponse>>

Throws

Memberof

See

getWbethUnwrapHistory

Parameters

Returns Promise<RestApiResponse<GetWbethUnwrapHistoryResponse>>

Throws

Memberof

See

getWbethWrapHistory

Parameters

Returns Promise<RestApiResponse<GetWbethWrapHistoryResponse>>

Throws

Memberof

See

redeemEth

Parameters

Returns Promise<RestApiResponse<RedeemEthResponse>>

Throws

Memberof

See

subscribeEthStaking

Parameters

Returns Promise<RestApiResponse<SubscribeEthStakingResponse>>

Throws

Memberof

See

wrapBeth

Parameters

Returns Promise<RestApiResponse<WrapBethResponse>>

Throws

Memberof

See

Settings

On This Page