Class SolStakingApi

SolStakingApi - object-oriented interface SolStakingApi

Implements

SolStakingApiInterface

Index

Constructors

Methods

claimBoostRewards getBnsolRateHistory getBnsolRewardsHistory getBoostRewardsHistory getSolRedemptionHistory getSolStakingHistory getSolStakingQuotaDetails getUnclaimedRewards redeemSol solStakingAccount subscribeSolStaking

Constructors

constructor

new SolStakingApi(configuration: ConfigurationRestAPI): SolStakingApi
Parameters
- configuration: ConfigurationRestAPI
Returns SolStakingApi
- Defined in clients/staking/src/rest-api/modules/sol-staking-api.ts:1184

Methods

claimBoostRewards

claimBoostRewards(
requestParameters?: ClaimBoostRewardsRequest,
): Promise<RestApiResponse<ClaimBoostRewardsResponse>>
Claim Boost APR Airdrop Rewards

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: ClaimBoostRewardsRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<ClaimBoostRewardsResponse>>
Throws
Memberof
SolStakingApi

See
Binance API Documentation
Implementation of SolStakingApiInterface.claimBoostRewards
- Defined in clients/staking/src/rest-api/modules/sol-staking-api.ts:1206

getBnsolRateHistory

getBnsolRateHistory(
requestParameters?: GetBnsolRateHistoryRequest,
): Promise<RestApiResponse<GetBnsolRateHistoryResponse>>
Get BNSOL 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: GetBnsolRateHistoryRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetBnsolRateHistoryResponse>>
Throws
Memberof
SolStakingApi

See
Binance API Documentation
Implementation of SolStakingApiInterface.getBnsolRateHistory
- Defined in clients/staking/src/rest-api/modules/sol-staking-api.ts:1247

getBnsolRewardsHistory

getBnsolRewardsHistory(
requestParameters?: GetBnsolRewardsHistoryRequest,
): Promise<RestApiResponse<GetBnsolRewardsHistoryResponse>>
Get BNSOL 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: GetBnsolRewardsHistoryRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetBnsolRewardsHistoryResponse>>
Throws
Memberof
SolStakingApi

See
Binance API Documentation
Implementation of SolStakingApiInterface.getBnsolRewardsHistory
- Defined in clients/staking/src/rest-api/modules/sol-staking-api.ts:1292

getBoostRewardsHistory

getBoostRewardsHistory(
requestParameters: GetBoostRewardsHistoryRequest,
): Promise<RestApiResponse<GetBoostRewardsHistoryResponse>>
Get Boost 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: GetBoostRewardsHistoryRequest
  Request parameters.
Returns Promise<RestApiResponse<GetBoostRewardsHistoryResponse>>
Throws
Memberof
SolStakingApi

See
Binance API Documentation
Implementation of SolStakingApiInterface.getBoostRewardsHistory
- Defined in clients/staking/src/rest-api/modules/sol-staking-api.ts:1337

getSolRedemptionHistory

getSolRedemptionHistory(
requestParameters?: GetSolRedemptionHistoryRequest,
): Promise<RestApiResponse<GetSolRedemptionHistoryResponse>>
Get SOL 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: GetSolRedemptionHistoryRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetSolRedemptionHistoryResponse>>
Throws
Memberof
SolStakingApi

See
Binance API Documentation
Implementation of SolStakingApiInterface.getSolRedemptionHistory
- Defined in clients/staking/src/rest-api/modules/sol-staking-api.ts:1383

getSolStakingHistory

getSolStakingHistory(
requestParameters?: GetSolStakingHistoryRequest,
): Promise<RestApiResponse<GetSolStakingHistoryResponse>>
Get SOL 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: GetSolStakingHistoryRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetSolStakingHistoryResponse>>
Throws
Memberof
SolStakingApi

See
Binance API Documentation
Implementation of SolStakingApiInterface.getSolStakingHistory
- Defined in clients/staking/src/rest-api/modules/sol-staking-api.ts:1429

getSolStakingQuotaDetails

getSolStakingQuotaDetails(
requestParameters?: GetSolStakingQuotaDetailsRequest,
): Promise<RestApiResponse<GetSolStakingQuotaDetailsResponse>>
Get SOL staking quota

Weight(IP): 150

Security Type: USER_DATA
Parameters
- requestParameters: GetSolStakingQuotaDetailsRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetSolStakingQuotaDetailsResponse>>
Throws
Memberof
SolStakingApi

See
Binance API Documentation
Implementation of SolStakingApiInterface.getSolStakingQuotaDetails
- Defined in clients/staking/src/rest-api/modules/sol-staking-api.ts:1466

getUnclaimedRewards

getUnclaimedRewards(
requestParameters?: GetUnclaimedRewardsRequest,
): Promise<RestApiResponse<GetUnclaimedRewardsResponse>>
Get Unclaimed rewards

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: GetUnclaimedRewardsRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetUnclaimedRewardsResponse>>
Throws
Memberof
SolStakingApi

See
Binance API Documentation
Implementation of SolStakingApiInterface.getUnclaimedRewards
- Defined in clients/staking/src/rest-api/modules/sol-staking-api.ts:1507

redeemSol

redeemSol(
requestParameters: RedeemSolRequest,
): Promise<RestApiResponse<RedeemSolResponse>>
Redeem BNSOL get SOL

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: RedeemSolRequest
  Request parameters.
Returns Promise<RestApiResponse<RedeemSolResponse>>
Throws
Memberof
SolStakingApi

See
Binance API Documentation
Implementation of SolStakingApiInterface.redeemSol
- Defined in clients/staking/src/rest-api/modules/sol-staking-api.ts:1542

solStakingAccount

solStakingAccount(
requestParameters?: SolStakingAccountRequest,
): Promise<RestApiResponse<SolStakingAccountResponse>>
SOL Staking account

Weight(IP): 150

Security Type: USER_DATA
Parameters
- requestParameters: SolStakingAccountRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<SolStakingAccountResponse>>
Throws
Memberof
SolStakingApi

See
Binance API Documentation
Implementation of SolStakingApiInterface.solStakingAccount
- Defined in clients/staking/src/rest-api/modules/sol-staking-api.ts:1575

subscribeSolStaking

subscribeSolStaking(
requestParameters: SubscribeSolStakingRequest,
): Promise<RestApiResponse<SubscribeSolStakingResponse>>
Subscribe SOL 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: SubscribeSolStakingRequest
  Request parameters.
Returns Promise<RestApiResponse<SubscribeSolStakingResponse>>
Throws
Memberof
SolStakingApi

See
Binance API Documentation
Implementation of SolStakingApiInterface.subscribeSolStaking
- Defined in clients/staking/src/rest-api/modules/sol-staking-api.ts:1610

Class SolStakingApi

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SolStakingApi

Methods

claimBoostRewards

Parameters

Returns Promise<RestApiResponse<ClaimBoostRewardsResponse>>

Throws

Memberof

See

getBnsolRateHistory

Parameters

Returns Promise<RestApiResponse<GetBnsolRateHistoryResponse>>

Throws

Memberof

See

getBnsolRewardsHistory

Parameters

Returns Promise<RestApiResponse<GetBnsolRewardsHistoryResponse>>

Throws

Memberof

See

getBoostRewardsHistory

Parameters

Returns Promise<RestApiResponse<GetBoostRewardsHistoryResponse>>

Throws

Memberof

See

getSolRedemptionHistory

Parameters

Returns Promise<RestApiResponse<GetSolRedemptionHistoryResponse>>

Throws

Memberof

See

getSolStakingHistory

Parameters

Returns Promise<RestApiResponse<GetSolStakingHistoryResponse>>

Throws

Memberof

See

getSolStakingQuotaDetails

Parameters

Returns Promise<RestApiResponse<GetSolStakingQuotaDetailsResponse>>

Throws

Memberof

See

getUnclaimedRewards

Parameters

Returns Promise<RestApiResponse<GetUnclaimedRewardsResponse>>

Throws

Memberof

See

redeemSol

Parameters

Returns Promise<RestApiResponse<RedeemSolResponse>>

Throws

Memberof

See

solStakingAccount

Parameters

Returns Promise<RestApiResponse<SolStakingAccountResponse>>

Throws

Memberof

See

subscribeSolStaking

Parameters

Returns Promise<RestApiResponse<SubscribeSolStakingResponse>>

Throws

Memberof

See

Settings

On This Page