Class PerpAPI

Hierarchy

PerpExecuteAPI<this> & PerpQueryAPI<this>
- PerpAPI

Index

Constructors

Properties

Methods

settlePnl getPerpPrices getMultiProductPerpPrices

Constructors

constructor

new PerpAPI(context): PerpAPI
Parameters
- context: VertexClientContext
Returns PerpAPI
Inherited from Mixin(PerpExecuteAPI, PerpQueryAPI).constructor
- Defined in apis/base.ts:12

Properties

`Readonly`context

context: VertexClientContext

Methods

settlePnl

settlePnl(params): Promise<void>
Parameters
- params: SettlePnlParams
Returns Promise<void>
Inherited from Mixin(PerpExecuteAPI, PerpQueryAPI).settlePnl
- Defined in apis/perp/PerpExecuteAPI.ts:5

getPerpPrices

getPerpPrices(params): Promise<IndexerPerpPrices>
Gets the latest index & mark price for a perp product
Parameters
- params: GetIndexerPerpPricesParams
Returns Promise<IndexerPerpPrices>
Inherited from Mixin(PerpExecuteAPI, PerpQueryAPI).getPerpPrices
- Defined in apis/perp/PerpQueryAPI.ts:12

getMultiProductPerpPrices

getMultiProductPerpPrices(params): Promise<GetIndexerMultiProductPerpPricesResponse>
Gets the latest index & mark price for multiple perp products
Parameters
- params: GetIndexerMultiProductPerpPricesParams
Returns Promise<GetIndexerMultiProductPerpPricesResponse>
Inherited from Mixin(PerpExecuteAPI, PerpQueryAPI).getMultiProductPerpPrices
- Defined in apis/perp/PerpQueryAPI.ts:20