Interface AccountApiInterface

AccountApi - interface AccountApi

interface AccountApiInterface {
    accountFundingFlow(
        requestParameters: AccountFundingFlowRequest,
    ): Promise<RestApiResponse<AccountFundingFlowResponse>>;
    optionMarginAccountInformation(
        requestParameters?: OptionMarginAccountInformationRequest,
    ): Promise<RestApiResponse<OptionMarginAccountInformationResponse>>;
}

Implemented by

DerivativesTradingOptionsRestAPI.AccountApi

Index

Methods

accountFundingFlow optionMarginAccountInformation

Methods

accountFundingFlow

accountFundingFlow(
requestParameters: AccountFundingFlowRequest,
): Promise<RestApiResponse<AccountFundingFlowResponse>>
Query account funding flows.

Weight(IP): 1

Security Type: USER_DATA

Notes:
- Only support querying data in the past 3 months
Parameters
- requestParameters: AccountFundingFlowRequest
  Request parameters.
Returns Promise<RestApiResponse<AccountFundingFlowResponse>>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-options/src/rest-api/modules/account-api.ts:153

optionMarginAccountInformation

optionMarginAccountInformation(
requestParameters?: OptionMarginAccountInformationRequest,
): Promise<RestApiResponse<OptionMarginAccountInformationResponse>>
Get current account information.

Weight(IP): 3

Security Type: USER_DATA
Parameters
- OptionalrequestParameters: OptionMarginAccountInformationRequest
  Request parameters.
Returns Promise<RestApiResponse<OptionMarginAccountInformationResponse>>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-options/src/rest-api/modules/account-api.ts:169