Interface AccountApiInterface

AccountApi - interface AccountApi

interface AccountApiInterface {
    accountFundingFlow(
        requestParameters: AccountFundingFlowRequest,
    ): Promise<RestApiResponse<AccountFundingFlowResponse>>;
    getDownloadIdForOptionTransactionHistory(
        requestParameters: GetDownloadIdForOptionTransactionHistoryRequest,
    ): Promise<
        RestApiResponse<GetDownloadIdForOptionTransactionHistoryResponse>,
    >;
    getOptionTransactionHistoryDownloadLinkById(
        requestParameters: GetOptionTransactionHistoryDownloadLinkByIdRequest,
    ): Promise<
        RestApiResponse<GetOptionTransactionHistoryDownloadLinkByIdResponse>,
    >;
    optionAccountInformation(
        requestParameters?: OptionAccountInformationRequest,
    ): Promise<RestApiResponse<OptionAccountInformationResponse>>;
}

Implemented by

DerivativesTradingOptionsRestAPI.AccountApi

Index

Methods

accountFundingFlow getDownloadIdForOptionTransactionHistory getOptionTransactionHistoryDownloadLinkById optionAccountInformation

Methods

accountFundingFlow

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

Weight: 1
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:235

getDownloadIdForOptionTransactionHistory

getDownloadIdForOptionTransactionHistory(
requestParameters: GetDownloadIdForOptionTransactionHistoryRequest,
): Promise<
RestApiResponse<GetDownloadIdForOptionTransactionHistoryResponse>,
>
Get download id for option transaction history

Request Limitation is 5 times per month, shared by > front end download page and rest api The time between startTime and endTime can not be longer than 1 year

Weight: 5
Parameters
- requestParameters: GetDownloadIdForOptionTransactionHistoryRequest
  Request parameters.
Returns Promise<RestApiResponse<GetDownloadIdForOptionTransactionHistoryResponse>>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-options/src/rest-api/modules/account-api.ts:252

getOptionTransactionHistoryDownloadLinkById

getOptionTransactionHistoryDownloadLinkById(
requestParameters: GetOptionTransactionHistoryDownloadLinkByIdRequest,
): Promise<
RestApiResponse<GetOptionTransactionHistoryDownloadLinkByIdResponse>,
>
Get option transaction history download Link by Id

Download link expiration: 24h

Weight: 5
Parameters
- requestParameters: GetOptionTransactionHistoryDownloadLinkByIdRequest
  Request parameters.
Returns Promise<RestApiResponse<GetOptionTransactionHistoryDownloadLinkByIdResponse>>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-options/src/rest-api/modules/account-api.ts:268

optionAccountInformation

optionAccountInformation(
requestParameters?: OptionAccountInformationRequest,
): Promise<RestApiResponse<OptionAccountInformationResponse>>
Get current account information.

Weight: 3
Parameters
- OptionalrequestParameters: OptionAccountInformationRequest
  Request parameters.
Returns Promise<RestApiResponse<OptionAccountInformationResponse>>
Throws
Memberof
AccountApiInterface
- Defined in clients/derivatives-trading-options/src/rest-api/modules/account-api.ts:282