Interface MarketDataApiInterface

MarketDataApi - interface MarketDataApi

interface MarketDataApiInterface {
    getPortfolioMarginAssetLeverage(): Promise<
        RestApiResponse<GetPortfolioMarginAssetLeverageResponse>,
    >;
    portfolioMarginCollateralRate(): Promise<
        RestApiResponse<PortfolioMarginCollateralRateResponse>,
    >;
    portfolioMarginProTieredCollateralRate(
        requestParameters?: PortfolioMarginProTieredCollateralRateRequest,
    ): Promise<RestApiResponse<PortfolioMarginProTieredCollateralRateResponse>>;
    queryPortfolioMarginAssetIndexPrice(
        requestParameters?: QueryPortfolioMarginAssetIndexPriceRequest,
    ): Promise<RestApiResponse<QueryPortfolioMarginAssetIndexPriceResponse>>;
}

Implemented by

DerivativesTradingPortfolioMarginProRestAPI.MarketDataApi

Index

Methods

getPortfolioMarginAssetLeverage portfolioMarginCollateralRate portfolioMarginProTieredCollateralRate queryPortfolioMarginAssetIndexPrice

Methods

getPortfolioMarginAssetLeverage

getPortfolioMarginAssetLeverage(): Promise<
RestApiResponse<GetPortfolioMarginAssetLeverageResponse>,
>
Get Portfolio Margin Asset Leverage

Weight: 50

Returns Promise<RestApiResponse<GetPortfolioMarginAssetLeverageResponse>>
Throws
Memberof
MarketDataApiInterface
- Defined in clients/derivatives-trading-portfolio-margin-pro/src/rest-api/modules/market-data-api.ts:151

portfolioMarginCollateralRate

portfolioMarginCollateralRate(): Promise<
RestApiResponse<PortfolioMarginCollateralRateResponse>,
>
Portfolio Margin Collateral Rate

Weight: 50

Returns Promise<RestApiResponse<PortfolioMarginCollateralRateResponse>>
Throws
Memberof
MarketDataApiInterface
- Defined in clients/derivatives-trading-portfolio-margin-pro/src/rest-api/modules/market-data-api.ts:164

portfolioMarginProTieredCollateralRate

portfolioMarginProTieredCollateralRate(
requestParameters?: PortfolioMarginProTieredCollateralRateRequest,
): Promise<RestApiResponse<PortfolioMarginProTieredCollateralRateResponse>>
Portfolio Margin PRO Tiered Collateral Rate

Weight: 50
Parameters
- OptionalrequestParameters: PortfolioMarginProTieredCollateralRateRequest
  Request parameters.
Returns Promise<RestApiResponse<PortfolioMarginProTieredCollateralRateResponse>>
Throws
Memberof
MarketDataApiInterface
- Defined in clients/derivatives-trading-portfolio-margin-pro/src/rest-api/modules/market-data-api.ts:178

queryPortfolioMarginAssetIndexPrice

queryPortfolioMarginAssetIndexPrice(
requestParameters?: QueryPortfolioMarginAssetIndexPriceRequest,
): Promise<RestApiResponse<QueryPortfolioMarginAssetIndexPriceResponse>>
Query Portfolio Margin Asset Index Price

Weight: 1 if send asset or 50 if not send asset
Parameters
- OptionalrequestParameters: QueryPortfolioMarginAssetIndexPriceRequest
  Request parameters.
Returns Promise<RestApiResponse<QueryPortfolioMarginAssetIndexPriceResponse>>
Throws
Memberof
MarketDataApiInterface
- Defined in clients/derivatives-trading-portfolio-margin-pro/src/rest-api/modules/market-data-api.ts:192