zklighter-perps 1.0.120 → 1.0.122

package/openapi.json

@@ -103,6 +103,13 @@
           }
         },
         "parameters": [
+          {
+            "name": "authorization",
+            "description": " make required after integ is done",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
           {
             "name": "account_index",
             "in": "query",
@@ -119,8 +126,9 @@
           },
           {
             "name": "auth",
+            "description": " made optional to support header auth clients",
             "in": "query",
-            "required": true,
+            "required": false,
             "type": "string"
           }
         ],
@@ -152,10 +160,18 @@
           }
         },
         "parameters": [
+          {
+            "name": "authorization",
+            "description": " make required after integ is done",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
           {
             "name": "auth",
+            "description": " made optional to support header auth clients",
             "in": "query",
-            "required": true,
+            "required": false,
             "type": "string"
           },
           {
@@ -231,6 +247,13 @@
           }
         },
         "parameters": [
+          {
+            "name": "authorization",
+            "description": " make required after integ is done",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
           {
             "name": "account_index",
             "in": "query",
@@ -240,8 +263,9 @@
           },
           {
             "name": "auth",
+            "description": " made optional to support header auth clients",
             "in": "query",
-            "required": true,
+            "required": false,
             "type": "string"
           }
         ],
@@ -254,6 +278,63 @@
         "description": "Get account limits"
       }
     },
+    "/api/v1/accountMetadata": {
+      "get": {
+        "summary": "accountMetadata",
+        "operationId": "accountMetadata",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/AccountMetadatas"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "authorization",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
+          {
+            "name": "by",
+            "in": "query",
+            "required": true,
+            "type": "string",
+            "enum": [
+              "index",
+              "l1_address"
+            ]
+          },
+          {
+            "name": "value",
+            "in": "query",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "name": "auth",
+            "in": "query",
+            "required": false,
+            "type": "string"
+          }
+        ],
+        "tags": [
+          "account"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Get account metadatas"
+      }
+    },
     "/api/v1/accountPendingTxs": {
       "get": {
         "summary": "accountPendingTxs",
@@ -827,6 +908,13 @@
           }
         },
         "parameters": [
+          {
+            "name": "authorization",
+            "description": " make required after integ is done",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
           {
             "name": "account_index",
             "in": "query",
@@ -836,8 +924,9 @@
           },
           {
             "name": "auth",
+            "description": " made optional to support header auth clients",
             "in": "query",
-            "required": true,
+            "required": false,
             "type": "string"
           },
           {
@@ -999,6 +1088,13 @@
           }
         },
         "parameters": [
+          {
+            "name": "authorization",
+            "description": " make required after integ is done",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
           {
             "name": "body",
             "in": "body",
@@ -1036,6 +1132,13 @@
           }
         },
         "parameters": [
+          {
+            "name": "authorization",
+            "description": " make required after integ is done",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
           {
             "name": "account_index",
             "in": "query",
@@ -1045,8 +1148,9 @@
           },
           {
             "name": "auth",
+            "description": " made optional to support header auth clients",
             "in": "query",
-            "required": true,
+            "required": false,
             "type": "string"
           }
         ],
@@ -1223,6 +1327,55 @@
         "description": "Get is account whitelisted"
       }
     },
+    "/api/v1/l1Metadata": {
+      "get": {
+        "summary": "l1Metadata",
+        "operationId": "l1Metadata",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/L1Metadata"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "authorization",
+            "description": " make required after integ is done",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
+          {
+            "name": "auth",
+            "description": " made optional to support header auth clients",
+            "in": "query",
+            "required": false,
+            "type": "string"
+          },
+          {
+            "name": "l1_address",
+            "in": "query",
+            "required": true,
+            "type": "string"
+          }
+        ],
+        "tags": [
+          "account"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Get L1 metadata"
+      }
+    },
     "/api/v1/layer1BasicInfo": {
       "get": {
         "summary": "layer1BasicInfo",
@@ -1292,6 +1445,78 @@
         "description": "Get points leaderboard"
       }
     },
+    "/api/v1/liquidations": {
+      "get": {
+        "summary": "liquidations",
+        "operationId": "liquidations",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/LiquidationInfos"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "authorization",
+            "description": " make required after integ is done",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
+          {
+            "name": "auth",
+            "description": " made optional to support header auth clients",
+            "in": "query",
+            "required": false,
+            "type": "string"
+          },
+          {
+            "name": "account_index",
+            "in": "query",
+            "required": true,
+            "type": "integer",
+            "format": "int64"
+          },
+          {
+            "name": "market_id",
+            "in": "query",
+            "required": false,
+            "type": "integer",
+            "format": "uint8"
+          },
+          {
+            "name": "cursor",
+            "in": "query",
+            "required": false,
+            "type": "string"
+          },
+          {
+            "name": "limit",
+            "in": "query",
+            "required": true,
+            "type": "integer",
+            "format": "int64",
+            "minimum": 1,
+            "maximum": 100
+          }
+        ],
+        "tags": [
+          "account"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Get liquidation infos"
+      }
+    },
     "/api/v1/nextNonce": {
       "get": {
         "summary": "nextNonce",
@@ -1354,6 +1579,13 @@
           }
         },
         "parameters": [
+          {
+            "name": "authorization",
+            "description": " make required after integ is done",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
           {
             "name": "body",
             "in": "body",
@@ -1555,6 +1787,12 @@
           }
         },
         "parameters": [
+          {
+            "name": "authorization",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
           {
             "name": "auth",
             "in": "query",
@@ -1652,6 +1890,12 @@
           }
         },
         "parameters": [
+          {
+            "name": "authorization",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
           {
             "name": "auth",
             "in": "query",
@@ -1729,6 +1973,12 @@
           }
         },
         "parameters": [
+          {
+            "name": "authorization",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
           {
             "name": "auth",
             "in": "query",
@@ -1844,6 +2094,13 @@
           }
         },
         "parameters": [
+          {
+            "name": "authorization",
+            "description": " make required after integ is done",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
           {
             "name": "body",
             "in": "body",
@@ -1881,10 +2138,18 @@
           }
         },
         "parameters": [
+          {
+            "name": "authorization",
+            "description": " make required after integ is done",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
           {
             "name": "auth",
+            "description": " made optional to support header auth clients",
             "in": "query",
-            "required": true,
+            "required": false,
             "type": "string"
           },
           {
@@ -1923,10 +2188,18 @@
           }
         },
         "parameters": [
+          {
+            "name": "authorization",
+            "description": " make required after integ is done",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
           {
             "name": "auth",
+            "description": " made optional to support header auth clients",
             "in": "query",
-            "required": true,
+            "required": false,
             "type": "string"
           },
           {
@@ -2076,6 +2349,13 @@
           }
         },
         "parameters": [
+          {
+            "name": "authorization",
+            "description": " make required after integ is done",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
           {
             "name": "body",
             "in": "body",
@@ -2113,6 +2393,12 @@
           }
         },
         "parameters": [
+          {
+            "name": "authorization",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
           {
             "name": "auth",
             "in": "query",
@@ -2348,6 +2634,13 @@
           }
         },
         "parameters": [
+          {
+            "name": "authorizatio",
+            "description": " make required after integ is done",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
           {
             "name": "account_index",
             "in": "query",
@@ -2357,8 +2650,9 @@
           },
           {
             "name": "auth",
+            "description": " made optional to support header auth clients",
             "in": "query",
-            "required": true,
+            "required": false,
             "type": "string"
           },
           {
@@ -2613,6 +2907,10 @@
     "AccountMetadata": {
       "type": "object",
       "properties": {
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
+        },
         "name": {
           "type": "string"
         },
@@ -2621,23 +2919,45 @@
         },
         "can_invite": {
           "type": "boolean",
-          "format": "boolean"
+          "format": "boolean",
+          "description": " Remove After FE uses L1 meta endpoint"
         },
         "referral_points_percentage": {
-          "type": "string"
-        },
-        "max_referral_usage_limit": {
-          "type": "integer",
-          "format": "int32"
+          "type": "string",
+          "description": " Remove After FE uses L1 meta endpoint"
         }
       },
       "title": "AccountMetadata",
       "required": [
+        "account_index",
         "name",
         "description",
         "can_invite",
-        "referral_points_percentage",
-        "max_referral_usage_limit"
+        "referral_points_percentage"
+      ]
+    },
+    "AccountMetadatas": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "example": "200"
+        },
+        "message": {
+          "type": "string"
+        },
+        "account_metadatas": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/AccountMetadata"
+          }
+        }
+      },
+      "title": "AccountMetadatas",
+      "required": [
+        "code",
+        "account_metadatas"
       ]
     },
     "AccountPnL": {
@@ -3428,6 +3748,10 @@
           "type": "string",
           "example": "46342"
         },
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
+        },
         "name": {
           "type": "string"
         },
@@ -3436,14 +3760,12 @@
         },
         "can_invite": {
           "type": "boolean",
-          "format": "boolean"
+          "format": "boolean",
+          "description": " Remove After FE uses L1 meta endpoint"
         },
         "referral_points_percentage": {
-          "type": "string"
-        },
-        "max_referral_usage_limit": {
-          "type": "integer",
-          "format": "int32"
+          "type": "string",
+          "description": " Remove After FE uses L1 meta endpoint"
         },
         "positions": {
           "type": "array",
@@ -3476,11 +3798,11 @@
         "pending_order_count",
         "status",
         "collateral",
+        "account_index",
         "name",
         "description",
         "can_invite",
         "referral_points_percentage",
-        "max_referral_usage_limit",
         "positions",
         "total_asset_value",
         "pool_info",
@@ -3878,6 +4200,27 @@
         "deposit_amount_left"
       ]
     },
+    "L1Metadata": {
+      "type": "object",
+      "properties": {
+        "l1_address": {
+          "type": "string"
+        },
+        "can_invite": {
+          "type": "boolean",
+          "format": "boolean"
+        },
+        "referral_points_percentage": {
+          "type": "string"
+        }
+      },
+      "title": "L1Metadata",
+      "required": [
+        "l1_address",
+        "can_invite",
+        "referral_points_percentage"
+      ]
+    },
     "L1ProviderInfo": {
       "type": "object",
       "properties": {
@@ -4016,6 +4359,122 @@
         "entryId"
       ]
     },
+    "LiqTrade": {
+      "type": "object",
+      "properties": {
+        "price": {
+          "type": "string"
+        },
+        "size": {
+          "type": "string"
+        },
+        "taker_fee": {
+          "type": "integer",
+          "format": "int32"
+        },
+        "maker_fee": {
+          "type": "integer",
+          "format": "int32"
+        }
+      },
+      "title": "LiqTrade",
+      "required": [
+        "price",
+        "size",
+        "taker_fee",
+        "maker_fee"
+      ]
+    },
+    "Liquidation": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "market_id": {
+          "type": "integer",
+          "format": "uint8"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "partial",
+            "deleverage"
+          ]
+        },
+        "trade": {
+          "$ref": "#/definitions/LiqTrade"
+        },
+        "info": {
+          "$ref": "#/definitions/LiquidationInfo"
+        },
+        "executed_at": {
+          "type": "integer",
+          "format": "int64"
+        }
+      },
+      "title": "Liquidation",
+      "required": [
+        "id",
+        "market_id",
+        "type",
+        "trade",
+        "info",
+        "executed_at"
+      ]
+    },
+    "LiquidationInfo": {
+      "type": "object",
+      "properties": {
+        "positions": {
+          "$ref": "#/definitions/mapuint8AccountPosition"
+        },
+        "risk_info_before": {
+          "$ref": "#/definitions/RiskInfo"
+        },
+        "risk_info_after": {
+          "$ref": "#/definitions/RiskInfo"
+        },
+        "mark_prices": {
+          "$ref": "#/definitions/mapuint8uint32"
+        }
+      },
+      "title": "LiquidationInfo",
+      "required": [
+        "positions",
+        "risk_info_before",
+        "risk_info_after",
+        "mark_prices"
+      ]
+    },
+    "LiquidationInfos": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "example": "200"
+        },
+        "message": {
+          "type": "string"
+        },
+        "liquidations": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Liquidation"
+          }
+        },
+        "next_cursor": {
+          "type": "string"
+        }
+      },
+      "title": "LiquidationInfos",
+      "required": [
+        "code",
+        "liquidations"
+      ]
+    },
     "MarketInfo": {
       "type": "object",
       "properties": {
@@ -4966,6 +5425,10 @@
           "type": "string",
           "example": "46342"
         },
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
+        },
         "name": {
           "type": "string"
         },
@@ -4974,14 +5437,12 @@
         },
         "can_invite": {
           "type": "boolean",
-          "format": "boolean"
+          "format": "boolean",
+          "description": " Remove After FE uses L1 meta endpoint"
         },
         "referral_points_percentage": {
-          "type": "string"
-        },
-        "max_referral_usage_limit": {
-          "type": "integer",
-          "format": "int32"
+          "type": "string",
+          "description": " Remove After FE uses L1 meta endpoint"
         },
         "total_asset_value": {
           "type": "string",
@@ -5005,11 +5466,11 @@
         "pending_order_count",
         "status",
         "collateral",
+        "account_index",
         "name",
         "description",
         "can_invite",
         "referral_points_percentage",
-        "max_referral_usage_limit",
         "total_asset_value",
         "pool_info"
       ]
@@ -5269,7 +5730,8 @@
           "example": "'liq:17:5898'"
         },
         "auth": {
-          "type": "string"
+          "type": "string",
+          "description": " made optional to support header auth clients"
         },
         "account_index": {
           "type": "integer",
@@ -5279,7 +5741,6 @@
       "title": "ReqAckNotif",
       "required": [
         "notif_id",
-        "auth",
         "account_index"
       ]
     },
@@ -5327,7 +5788,8 @@
       "type": "object",
       "properties": {
         "auth": {
-          "type": "string"
+          "type": "string",
+          "description": " made optional to support header auth clients"
         },
         "account_index": {
           "type": "integer",
@@ -5336,7 +5798,6 @@
       },
       "title": "ReqCreateReferralCode",
       "required": [
-        "auth",
         "account_index"
       ]
     },
@@ -5362,14 +5823,14 @@
           "type": "string"
         },
         "auth": {
-          "type": "string"
+          "type": "string",
+          "description": " made optional to support header auth clients"
         }
       },
       "title": "ReqFastwithdraw",
       "required": [
         "tx_info",
-        "to_address",
-        "auth"
+        "to_address"
       ]
     },
     "ReqGetAccount": {
@@ -5404,14 +5865,14 @@
           "format": "uint8"
         },
         "auth": {
-          "type": "string"
+          "type": "string",
+          "description": " made optional to support header auth clients"
         }
       },
       "title": "ReqGetAccountActiveOrders",
       "required": [
         "account_index",
-        "market_id",
-        "auth"
+        "market_id"
       ]
     },
     "ReqGetAccountApiKeys": {
@@ -5448,7 +5909,8 @@
       "type": "object",
       "properties": {
         "auth": {
-          "type": "string"
+          "type": "string",
+          "description": " made optional to support header auth clients"
         },
         "account_index": {
           "type": "integer",
@@ -5479,7 +5941,6 @@
       },
       "title": "ReqGetAccountInactiveOrders",
       "required": [
-        "auth",
         "account_index",
         "limit"
       ]
@@ -5492,13 +5953,36 @@
           "format": "int64"
         },
         "auth": {
-          "type": "string"
+          "type": "string",
+          "description": " made optional to support header auth clients"
         }
       },
       "title": "ReqGetAccountLimits",
       "required": [
-        "account_index",
-        "auth"
+        "account_index"
+      ]
+    },
+    "ReqGetAccountMetadata": {
+      "type": "object",
+      "properties": {
+        "by": {
+          "type": "string",
+          "enum": [
+            "index",
+            "l1_address"
+          ]
+        },
+        "value": {
+          "type": "string"
+        },
+        "auth": {
+          "type": "string"
+        }
+      },
+      "title": "ReqGetAccountMetadata",
+      "required": [
+        "by",
+        "value"
       ]
     },
     "ReqGetAccountPendingTxs": {
@@ -5725,7 +6209,8 @@
           "format": "int64"
         },
         "auth": {
-          "type": "string"
+          "type": "string",
+          "description": " made optional to support header auth clients"
         },
         "l1_address": {
           "type": "string"
@@ -5745,7 +6230,6 @@
       "title": "ReqGetDepositHistory",
       "required": [
         "account_index",
-        "auth",
         "l1_address"
       ]
     },
@@ -5761,13 +6245,13 @@
           "format": "int64"
         },
         "auth": {
-          "type": "string"
+          "type": "string",
+          "description": " made optional to support header auth clients"
         }
       },
       "title": "ReqGetFastWithdrawInfo",
       "required": [
-        "account_index",
-        "auth"
+        "account_index"
       ]
     },
     "ReqGetFundings": {
@@ -5807,6 +6291,22 @@
         "count_back"
       ]
     },
+    "ReqGetL1Metadata": {
+      "type": "object",
+      "properties": {
+        "auth": {
+          "type": "string",
+          "description": " made optional to support header auth clients"
+        },
+        "l1_address": {
+          "type": "string"
+        }
+      },
+      "title": "ReqGetL1Metadata",
+      "required": [
+        "l1_address"
+      ]
+    },
     "ReqGetL1Tx": {
       "type": "object",
       "properties": {
@@ -5850,6 +6350,37 @@
         "type"
       ]
     },
+    "ReqGetLiquidationInfos": {
+      "type": "object",
+      "properties": {
+        "auth": {
+          "type": "string",
+          "description": " made optional to support header auth clients"
+        },
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "market_id": {
+          "type": "integer",
+          "format": "uint8"
+        },
+        "cursor": {
+          "type": "string"
+        },
+        "limit": {
+          "type": "integer",
+          "format": "int64",
+          "maximum": 100,
+          "minimum": 1
+        }
+      },
+      "title": "ReqGetLiquidationInfos",
+      "required": [
+        "account_index",
+        "limit"
+      ]
+    },
     "ReqGetNextNonce": {
       "type": "object",
       "properties": {
@@ -6071,7 +6602,8 @@
       "type": "object",
       "properties": {
         "auth": {
-          "type": "string"
+          "type": "string",
+          "description": " made optional to support header auth clients"
         },
         "account_index": {
           "type": "integer",
@@ -6080,7 +6612,6 @@
       },
       "title": "ReqGetReferralCode",
       "required": [
-        "auth",
         "account_index"
       ]
     },
@@ -6088,7 +6619,8 @@
       "type": "object",
       "properties": {
         "auth": {
-          "type": "string"
+          "type": "string",
+          "description": " made optional to support header auth clients"
         },
         "account_index": {
           "type": "integer",
@@ -6097,7 +6629,6 @@
       },
       "title": "ReqGetReferralPoints",
       "required": [
-        "auth",
         "account_index"
       ]
     },
@@ -6190,7 +6721,8 @@
           "format": "int64"
         },
         "auth": {
-          "type": "string"
+          "type": "string",
+          "description": " made optional to support header auth clients"
         },
         "cursor": {
           "type": "string"
@@ -6206,8 +6738,7 @@
       },
       "title": "ReqGetWithdrawHistory",
       "required": [
-        "account_index",
-        "auth"
+        "account_index"
       ]
     },
     "ReqIsWhitelisted": {
@@ -6385,6 +6916,34 @@
         "code"
       ]
     },
+    "RiskInfo": {
+      "type": "object",
+      "properties": {
+        "collateral": {
+          "type": "string"
+        },
+        "total_account_value": {
+          "type": "string"
+        },
+        "initial_margin_req": {
+          "type": "string"
+        },
+        "maintenance_margin_req": {
+          "type": "string"
+        },
+        "close_out_margin_req": {
+          "type": "string"
+        }
+      },
+      "title": "RiskInfo",
+      "required": [
+        "collateral",
+        "total_account_value",
+        "initial_margin_req",
+        "maintenance_margin_req",
+        "close_out_margin_req"
+      ]
+    },
     "SimpleOrder": {
       "type": "object",
       "properties": {