feat(): add/update missing v5 market endpoints. add api doc examples for each endpoint.

This commit is contained in:
tiagosiebler
2023-06-07 12:13:25 +01:00
parent 15d5ae00cf
commit 4f563a65a5
21 changed files with 322 additions and 4 deletions

View File

@@ -1,5 +1,5 @@
import { KlineIntervalV3 } from '../shared';
import { CategoryV5, OptionTypeV5 } from '../v5-shared';
import { CategoryV5, InstrumentStatusV5, OptionTypeV5 } from '../v5-shared';
export interface GetKlineParamsV5 {
category: 'spot' | 'linear' | 'inverse';
@@ -40,6 +40,7 @@ export interface GetPremiumIndexPriceKlineParamsV5 {
export interface GetInstrumentsInfoParamsV5 {
category: CategoryV5;
symbol?: string;
status?: InstrumentStatusV5;
baseCoin?: string;
limit?: number;
cursor?: string;
@@ -95,7 +96,7 @@ export interface GetOpenInterestParamsV5 {
export interface GetHistoricalVolatilityParamsV5 {
category: 'option';
baseCoin?: string;
period?: number;
period?: 7 | 14 | 21 | 30 | 60 | 90 | 180 | 270;
startTime?: number;
endTime?: number;
}
@@ -116,3 +117,11 @@ export interface GetOptionDeliveryPriceParamsV5 {
limit?: number;
cursor?: string;
}
export interface GetDeliveryPriceParamsV5 {
category: 'linear' | 'inverse' | 'option';
symbol?: string;
baseCoin?: string;
limit?: number;
cursor?: string;
}

View File

@@ -24,7 +24,7 @@ export type OHLCVKlineV5 = [
string,
string,
string,
string
string,
];
/**
@@ -257,8 +257,15 @@ export interface RiskLimitV5 {
maxLeverage: string;
}
/** @deprecated use DeliveryPriceV5 instead */
export interface OptionDeliveryPriceV5 {
symbol: string;
deliveryPrice: string;
deliveryTime: string;
}
export interface DeliveryPriceV5 {
symbol: string;
deliveryPrice: string;
deliveryTime: string;
}

View File

@@ -4,7 +4,12 @@ export type ContractTypeV5 =
| 'LinearPerpetual'
| 'InverseFutures';
export type InstrumentStatusV5 = 'Pending' | 'Trading' | 'Settling' | 'Closed';
export type InstrumentStatusV5 =
| 'PreLaunch'
| 'Trading'
| 'Settling'
| 'Delivering'
| 'Closed';
export type OrderFilterV5 = 'Order' | 'tpslOrder';
export type OrderSideV5 = 'Buy' | 'Sell';