comments

src/inverse-client.ts

@@ -33,7 +33,11 @@ export class InverseClient extends SharedEndpoints {
     return this;
   }
 
-  //------------Market Data Endpoints------------>
+  /**
+   *
+   * Market Data Endpoints
+   *
+   */
 
   getKline(params: {
     symbol: string;
@@ -112,7 +116,13 @@ export class InverseClient extends SharedEndpoints {
     return this.requestWrapper.get('v2/public/premium-index-kline', params);
   }
 
-  //-----------Account Data Endpoints------------>
+  /**
+   *
+   * Account Data Endpoints
+   *
+   */
+  
+  //Active Orders
 
   placeActiveOrder(orderRequest: {
     side: string;
@@ -172,6 +182,8 @@ export class InverseClient extends SharedEndpoints {
     return this.requestWrapper.get('v2/private/order', params);
   }
   
+  //Conditional Orders
+
   placeConditionalOrder(params: {
     side: string;
     symbol: string;
@@ -231,6 +243,8 @@ export class InverseClient extends SharedEndpoints {
     return this.requestWrapper.get('v2/private/stop-order', params);
   }
   
+  //Position
+
   /**
    * @deprecated use getPosition() instead
    */
@@ -305,6 +319,8 @@ export class InverseClient extends SharedEndpoints {
     return this.requestWrapper.get('v2/private/trade/closed-pnl/list', params);
   }
 
+  //Risk Limit
+  
   getRiskLimitList(): GenericAPIResponse {
     return this.requestWrapper.get('open-api/wallet/risk-limit/list');
   }
@@ -316,6 +332,8 @@ export class InverseClient extends SharedEndpoints {
     return this.requestWrapper.post('open-api/wallet/risk-limit', params);
   }
   
+  //Funding
+
   getLastFundingRate(params: {
     symbol: string;
   }): GenericAPIResponse {
@@ -334,6 +352,8 @@ export class InverseClient extends SharedEndpoints {
     return this.requestWrapper.get('v2/private/funding/predicted-funding', params);
   }
   
+  //misc
+
   getLcpInfo(params: {
     symbol: string;
   }): GenericAPIResponse {