Interface TradeApiInterface

TradeApi - interface TradeApi

interface TradeApiInterface {
    checkDualInvestmentAccounts(
        requestParameters?: CheckDualInvestmentAccountsRequest,
    ): Promise<RestApiResponse<CheckDualInvestmentAccountsResponse>>;
    getDualInvestmentPositions(
        requestParameters?: GetDualInvestmentPositionsRequest,
    ): Promise<RestApiResponse<GetDualInvestmentPositionsResponse>>;
    subscribeDualInvestmentProducts(
        requestParameters: SubscribeDualInvestmentProductsRequest,
    ): Promise<RestApiResponse<SubscribeDualInvestmentProductsResponse>>;
}

Implemented by

DualInvestmentRestAPI.TradeApi

Index

Methods

checkDualInvestmentAccounts getDualInvestmentPositions subscribeDualInvestmentProducts

Methods

checkDualInvestmentAccounts

checkDualInvestmentAccounts(
requestParameters?: CheckDualInvestmentAccountsRequest,
): Promise<RestApiResponse<CheckDualInvestmentAccountsResponse>>
Check Dual Investment accounts

Weight(IP): 1

Security Type: USER_DATA
Parameters
- OptionalrequestParameters: CheckDualInvestmentAccountsRequest
  Request parameters.
Returns Promise<RestApiResponse<CheckDualInvestmentAccountsResponse>>
Throws
Memberof
TradeApiInterface
- Defined in clients/dual-investment/src/rest-api/modules/trade-api.ts:201

getDualInvestmentPositions

getDualInvestmentPositions(
requestParameters?: GetDualInvestmentPositionsRequest,
): Promise<RestApiResponse<GetDualInvestmentPositionsResponse>>
Get Dual Investment positions (batch)

Weight(IP): 1

Security Type: USER_DATA
Parameters
- OptionalrequestParameters: GetDualInvestmentPositionsRequest
  Request parameters.
Returns Promise<RestApiResponse<GetDualInvestmentPositionsResponse>>
Throws
Memberof
TradeApiInterface
- Defined in clients/dual-investment/src/rest-api/modules/trade-api.ts:217

subscribeDualInvestmentProducts

subscribeDualInvestmentProducts(
requestParameters: SubscribeDualInvestmentProductsRequest,
): Promise<RestApiResponse<SubscribeDualInvestmentProductsResponse>>
Subscribe Dual Investment products

Weight(IP): 1

Security Type: USER_DATA

Notes:
- Failed messages:
- Products are not available. This means APR changed to a lower value, or the order is unavailable.
- Failed. This means system or network errors.
Parameters
- requestParameters: SubscribeDualInvestmentProductsRequest
  Request parameters.
Returns Promise<RestApiResponse<SubscribeDualInvestmentProductsResponse>>
Throws
Memberof
TradeApiInterface
- Defined in clients/dual-investment/src/rest-api/modules/trade-api.ts:238