zklighter-perps 1.0.119 → 1.0.121

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,15 +278,15 @@
         "description": "Get account limits"
       }
     },
-    "/api/v1/accountOrders": {
+    "/api/v1/accountMetadata": {
       "get": {
-        "summary": "accountOrders",
-        "operationId": "accountOrders",
+        "summary": "accountMetadata",
+        "operationId": "accountMetadata",
         "responses": {
           "200": {
             "description": "A successful response.",
             "schema": {
-              "$ref": "#/definitions/Orders"
+              "$ref": "#/definitions/AccountMetadatas"
             }
           },
           "400": {
@@ -274,48 +298,41 @@
         },
         "parameters": [
           {
-            "name": "auth",
-            "in": "query",
-            "required": true,
+            "name": "authorization",
+            "in": "header",
+            "required": false,
             "type": "string"
           },
           {
-            "name": "account_index",
+            "name": "by",
             "in": "query",
             "required": true,
-            "type": "integer",
-            "format": "int64"
+            "type": "string",
+            "enum": [
+              "index",
+              "l1_address"
+            ]
           },
           {
-            "name": "market_id",
+            "name": "value",
             "in": "query",
             "required": true,
-            "type": "integer",
-            "format": "uint8"
+            "type": "string"
           },
           {
-            "name": "cursor",
+            "name": "auth",
             "in": "query",
             "required": false,
             "type": "string"
-          },
-          {
-            "name": "limit",
-            "in": "query",
-            "required": true,
-            "type": "integer",
-            "format": "int64",
-            "minimum": 1,
-            "maximum": 100
           }
         ],
         "tags": [
-          "order"
+          "account"
         ],
         "consumes": [
           "multipart/form-data"
         ],
-        "description": "Get account orders"
+        "description": "Get account metadatas"
       }
     },
     "/api/v1/accountPendingTxs": {
@@ -891,6 +908,13 @@
           }
         },
         "parameters": [
+          {
+            "name": "authorization",
+            "description": " make required after integ is done",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
           {
             "name": "account_index",
             "in": "query",
@@ -900,8 +924,9 @@
           },
           {
             "name": "auth",
+            "description": " made optional to support header auth clients",
             "in": "query",
-            "required": true,
+            "required": false,
             "type": "string"
           },
           {
@@ -1063,6 +1088,13 @@
           }
         },
         "parameters": [
+          {
+            "name": "authorization",
+            "description": " make required after integ is done",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
           {
             "name": "body",
             "in": "body",
@@ -1100,6 +1132,13 @@
           }
         },
         "parameters": [
+          {
+            "name": "authorization",
+            "description": " make required after integ is done",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
           {
             "name": "account_index",
             "in": "query",
@@ -1109,8 +1148,9 @@
           },
           {
             "name": "auth",
+            "description": " made optional to support header auth clients",
             "in": "query",
-            "required": true,
+            "required": false,
             "type": "string"
           }
         ],
@@ -1158,42 +1198,6 @@
         "description": "Request funds from faucet"
       }
     },
-    "/api/v1/feeBucket": {
-      "get": {
-        "summary": "feeBucket",
-        "operationId": "feeBucket",
-        "responses": {
-          "200": {
-            "description": "A successful response.",
-            "schema": {
-              "$ref": "#/definitions/FeeBucket"
-            }
-          },
-          "400": {
-            "description": "Bad request",
-            "schema": {
-              "$ref": "#/definitions/ResultCode"
-            }
-          }
-        },
-        "parameters": [
-          {
-            "name": "account_index",
-            "in": "query",
-            "required": true,
-            "type": "integer",
-            "format": "int64"
-          }
-        ],
-        "tags": [
-          "account"
-        ],
-        "consumes": [
-          "multipart/form-data"
-        ],
-        "description": "Get account fee bucket"
-      }
-    },
     "/api/v1/funding-rates": {
       "get": {
         "summary": "funding-rates",
@@ -1323,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",
@@ -1454,6 +1507,13 @@
           }
         },
         "parameters": [
+          {
+            "name": "authorization",
+            "description": " make required after integ is done",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
           {
             "name": "body",
             "in": "body",
@@ -1655,6 +1715,12 @@
           }
         },
         "parameters": [
+          {
+            "name": "authorization",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
           {
             "name": "auth",
             "in": "query",
@@ -1752,6 +1818,12 @@
           }
         },
         "parameters": [
+          {
+            "name": "authorization",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
           {
             "name": "auth",
             "in": "query",
@@ -1829,6 +1901,12 @@
           }
         },
         "parameters": [
+          {
+            "name": "authorization",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
           {
             "name": "auth",
             "in": "query",
@@ -1944,6 +2022,13 @@
           }
         },
         "parameters": [
+          {
+            "name": "authorization",
+            "description": " make required after integ is done",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
           {
             "name": "body",
             "in": "body",
@@ -1981,10 +2066,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"
           },
           {
@@ -2023,10 +2116,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"
           },
           {
@@ -2176,6 +2277,13 @@
           }
         },
         "parameters": [
+          {
+            "name": "authorization",
+            "description": " make required after integ is done",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
           {
             "name": "body",
             "in": "body",
@@ -2213,6 +2321,12 @@
           }
         },
         "parameters": [
+          {
+            "name": "authorization",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
           {
             "name": "auth",
             "in": "query",
@@ -2259,10 +2373,9 @@
             "required": false,
             "type": "string",
             "enum": [
-              "asc",
               "desc"
             ],
-            "default": "asc"
+            "default": "desc"
           },
           {
             "name": "cursor",
@@ -2449,6 +2562,13 @@
           }
         },
         "parameters": [
+          {
+            "name": "authorizatio",
+            "description": " make required after integ is done",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
           {
             "name": "account_index",
             "in": "query",
@@ -2458,8 +2578,9 @@
           },
           {
             "name": "auth",
+            "description": " made optional to support header auth clients",
             "in": "query",
-            "required": true,
+            "required": false,
             "type": "string"
           },
           {
@@ -2714,6 +2835,10 @@
     "AccountMetadata": {
       "type": "object",
       "properties": {
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
+        },
         "name": {
           "type": "string"
         },
@@ -2722,23 +2847,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": {
@@ -3529,6 +3676,10 @@
           "type": "string",
           "example": "46342"
         },
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
+        },
         "name": {
           "type": "string"
         },
@@ -3537,14 +3688,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",
@@ -3577,11 +3726,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",
@@ -3839,29 +3988,6 @@
         "daily_trades_count"
       ]
     },
-    "FeeBucket": {
-      "type": "object",
-      "properties": {
-        "vip_tier": {
-          "type": "integer",
-          "format": "uint8"
-        },
-        "taker_fee": {
-          "type": "integer",
-          "format": "int32"
-        },
-        "maker_fee": {
-          "type": "integer",
-          "format": "int32"
-        }
-      },
-      "title": "FeeBucket",
-      "required": [
-        "vip_tier",
-        "taker_fee",
-        "maker_fee"
-      ]
-    },
     "Funding": {
       "type": "object",
       "properties": {
@@ -4002,6 +4128,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": {
@@ -5090,6 +5237,10 @@
           "type": "string",
           "example": "46342"
         },
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
+        },
         "name": {
           "type": "string"
         },
@@ -5098,14 +5249,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",
@@ -5129,11 +5278,11 @@
         "pending_order_count",
         "status",
         "collateral",
+        "account_index",
         "name",
         "description",
         "can_invite",
         "referral_points_percentage",
-        "max_referral_usage_limit",
         "total_asset_value",
         "pool_info"
       ]
@@ -5393,7 +5542,8 @@
           "example": "'liq:17:5898'"
         },
         "auth": {
-          "type": "string"
+          "type": "string",
+          "description": " made optional to support header auth clients"
         },
         "account_index": {
           "type": "integer",
@@ -5403,7 +5553,6 @@
       "title": "ReqAckNotif",
       "required": [
         "notif_id",
-        "auth",
         "account_index"
       ]
     },
@@ -5451,7 +5600,8 @@
       "type": "object",
       "properties": {
         "auth": {
-          "type": "string"
+          "type": "string",
+          "description": " made optional to support header auth clients"
         },
         "account_index": {
           "type": "integer",
@@ -5460,7 +5610,6 @@
       },
       "title": "ReqCreateReferralCode",
       "required": [
-        "auth",
         "account_index"
       ]
     },
@@ -5486,14 +5635,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": {
@@ -5528,14 +5677,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": {
@@ -5572,7 +5721,8 @@
       "type": "object",
       "properties": {
         "auth": {
-          "type": "string"
+          "type": "string",
+          "description": " made optional to support header auth clients"
         },
         "account_index": {
           "type": "integer",
@@ -5603,7 +5753,6 @@
       },
       "title": "ReqGetAccountInactiveOrders",
       "required": [
-        "auth",
         "account_index",
         "limit"
       ]
@@ -5616,45 +5765,36 @@
           "format": "int64"
         },
         "auth": {
-          "type": "string"
+          "type": "string",
+          "description": " made optional to support header auth clients"
         }
       },
       "title": "ReqGetAccountLimits",
       "required": [
-        "account_index",
-        "auth"
+        "account_index"
       ]
     },
-    "ReqGetAccountOrders": {
+    "ReqGetAccountMetadata": {
       "type": "object",
       "properties": {
-        "auth": {
-          "type": "string"
-        },
-        "account_index": {
-          "type": "integer",
-          "format": "int64"
-        },
-        "market_id": {
-          "type": "integer",
-          "format": "uint8"
+        "by": {
+          "type": "string",
+          "enum": [
+            "index",
+            "l1_address"
+          ]
         },
-        "cursor": {
+        "value": {
           "type": "string"
         },
-        "limit": {
-          "type": "integer",
-          "format": "int64",
-          "maximum": 100,
-          "minimum": 1
+        "auth": {
+          "type": "string"
         }
       },
-      "title": "ReqGetAccountOrders",
+      "title": "ReqGetAccountMetadata",
       "required": [
-        "auth",
-        "account_index",
-        "market_id",
-        "limit"
+        "by",
+        "value"
       ]
     },
     "ReqGetAccountPendingTxs": {
@@ -5881,7 +6021,8 @@
           "format": "int64"
         },
         "auth": {
-          "type": "string"
+          "type": "string",
+          "description": " made optional to support header auth clients"
         },
         "l1_address": {
           "type": "string"
@@ -5901,7 +6042,6 @@
       "title": "ReqGetDepositHistory",
       "required": [
         "account_index",
-        "auth",
         "l1_address"
       ]
     },
@@ -5917,24 +6057,11 @@
           "format": "int64"
         },
         "auth": {
-          "type": "string"
+          "type": "string",
+          "description": " made optional to support header auth clients"
         }
       },
       "title": "ReqGetFastWithdrawInfo",
-      "required": [
-        "account_index",
-        "auth"
-      ]
-    },
-    "ReqGetFeeBucket": {
-      "type": "object",
-      "properties": {
-        "account_index": {
-          "type": "integer",
-          "format": "int64"
-        }
-      },
-      "title": "ReqGetFeeBucket",
       "required": [
         "account_index"
       ]
@@ -5976,6 +6103,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": {
@@ -6240,7 +6383,8 @@
       "type": "object",
       "properties": {
         "auth": {
-          "type": "string"
+          "type": "string",
+          "description": " made optional to support header auth clients"
         },
         "account_index": {
           "type": "integer",
@@ -6249,7 +6393,6 @@
       },
       "title": "ReqGetReferralCode",
       "required": [
-        "auth",
         "account_index"
       ]
     },
@@ -6257,7 +6400,8 @@
       "type": "object",
       "properties": {
         "auth": {
-          "type": "string"
+          "type": "string",
+          "description": " made optional to support header auth clients"
         },
         "account_index": {
           "type": "integer",
@@ -6266,7 +6410,6 @@
       },
       "title": "ReqGetReferralPoints",
       "required": [
-        "auth",
         "account_index"
       ]
     },
@@ -6301,10 +6444,9 @@
         "sort_dir": {
           "type": "string",
           "enum": [
-            "asc",
             "desc"
           ],
-          "default": "asc"
+          "default": "desc"
         },
         "cursor": {
           "type": "string"
@@ -6360,7 +6502,8 @@
           "format": "int64"
         },
         "auth": {
-          "type": "string"
+          "type": "string",
+          "description": " made optional to support header auth clients"
         },
         "cursor": {
           "type": "string"
@@ -6376,8 +6519,7 @@
       },
       "title": "ReqGetWithdrawHistory",
       "required": [
-        "account_index",
-        "auth"
+        "account_index"
       ]
     },
     "ReqIsWhitelisted": {
@@ -6525,13 +6667,17 @@
         },
         "withdraw_limit": {
           "type": "string"
+        },
+        "max_withdrawal_amount": {
+          "type": "string"
         }
       },
       "title": "RespGetFastwithdrawalInfo",
       "required": [
         "code",
         "to_account_index",
-        "withdraw_limit"
+        "withdraw_limit",
+        "max_withdrawal_amount"
       ]
     },
     "ResultCode": {
@@ -6753,13 +6899,16 @@
           "example": "0"
         },
         "taker_position_size_before": {
-          "type": "integer",
-          "format": "int64",
+          "type": "string",
           "example": "0"
         },
         "taker_entry_quote_before": {
+          "type": "string",
+          "example": "0"
+        },
+        "taker_initial_margin_fraction_before": {
           "type": "integer",
-          "format": "int64",
+          "format": "uin16",
           "example": "0"
         },
         "taker_position_sign_changed": {
@@ -6773,13 +6922,16 @@
           "example": "0"
         },
         "maker_position_size_before": {
-          "type": "integer",
-          "format": "int64",
+          "type": "string",
           "example": "0"
         },
         "maker_entry_quote_before": {
+          "type": "string",
+          "example": "0"
+        },
+        "maker_initial_margin_fraction_before": {
           "type": "integer",
-          "format": "int64",
+          "format": "uin16",
           "example": "0"
         },
         "maker_position_sign_changed": {
@@ -6807,10 +6959,12 @@
         "taker_fee",
         "taker_position_size_before",
         "taker_entry_quote_before",
+        "taker_initial_margin_fraction_before",
         "taker_position_sign_changed",
         "maker_fee",
         "maker_position_size_before",
         "maker_entry_quote_before",
+        "maker_initial_margin_fraction_before",
         "maker_position_sign_changed"
       ]
     },