zklighter-perps 1.0.184 → 1.0.186

package/openapi.json

@@ -106,7 +106,14 @@
           {
             "name": "authorization",
             "description": " make required after integ is done",
-            "in": "header",
+            "in": "query",
+            "required": false,
+            "type": "string"
+          },
+          {
+            "name": "auth",
+            "description": " made optional to support header auth clients",
+            "in": "query",
             "required": false,
             "type": "string"
           },
@@ -123,13 +130,6 @@
             "required": true,
             "type": "integer",
             "format": "int16"
-          },
-          {
-            "name": "auth",
-            "description": " made optional to support header auth clients",
-            "in": "query",
-            "required": false,
-            "type": "string"
           }
         ],
         "tags": [
@@ -163,7 +163,7 @@
           {
             "name": "authorization",
             "description": " make required after integ is done",
-            "in": "header",
+            "in": "query",
             "required": false,
             "type": "string"
           },
@@ -247,13 +247,6 @@
           }
         },
         "parameters": [
-          {
-            "name": "authorization",
-            "description": " make required after integ is done",
-            "in": "header",
-            "required": false,
-            "type": "string"
-          },
           {
             "name": "account_index",
             "in": "query",
@@ -261,6 +254,13 @@
             "type": "integer",
             "format": "int64"
           },
+          {
+            "name": "authorization",
+            "description": " make required after integ is done",
+            "in": "query",
+            "required": false,
+            "type": "string"
+          },
           {
             "name": "auth",
             "description": " made optional to support header auth clients",
@@ -354,12 +354,6 @@
           }
         },
         "parameters": [
-          {
-            "name": "authorization",
-            "in": "header",
-            "required": false,
-            "type": "string"
-          },
           {
             "name": "index",
             "in": "query",
@@ -392,20 +386,28 @@
             "type": "string"
           },
           {
-            "name": "types",
+            "name": "authorization",
+            "description": " make required after integ is done",
             "in": "query",
             "required": false,
-            "type": "array",
-            "items": {
-              "type": "integer",
-              "format": "uint8"
-            }
+            "type": "string"
           },
           {
             "name": "auth",
+            "description": " made optional to support header auth clients",
             "in": "query",
             "required": false,
             "type": "string"
+          },
+          {
+            "name": "types",
+            "in": "query",
+            "required": false,
+            "type": "array",
+            "items": {
+              "type": "integer",
+              "format": "uint8"
+            }
           }
         ],
         "tags": [
@@ -452,6 +454,98 @@
         "description": "Get accounts by l1_address returns all accounts associated with the given L1 address"
       }
     },
+    "/api/v1/airdrop": {
+      "get": {
+        "summary": "airdrop",
+        "operationId": "airdrop",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/AirdropPercentages"
+            }
+          },
+          "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": "l1_address",
+            "in": "query",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "name": "auth",
+            "in": "query",
+            "required": false,
+            "type": "string"
+          }
+        ],
+        "tags": [
+          "account"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Get airdrop percentages"
+      }
+    },
+    "/api/v1/airdrop/create": {
+      "post": {
+        "summary": "airdrop_create",
+        "operationId": "airdrop_create",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          },
+          "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": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/ReqCreateAirdropPercentages"
+            }
+          }
+        ],
+        "tags": [
+          "account"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Create airdrop percentages"
+      }
+    },
     "/api/v1/announcement": {
       "get": {
         "summary": "announcement",
@@ -986,17 +1080,10 @@
           {
             "name": "authorization",
             "description": " make required after integ is done",
-            "in": "header",
+            "in": "query",
             "required": false,
             "type": "string"
           },
-          {
-            "name": "account_index",
-            "in": "query",
-            "required": true,
-            "type": "integer",
-            "format": "int64"
-          },
           {
             "name": "auth",
             "description": " made optional to support header auth clients",
@@ -1004,6 +1091,13 @@
             "required": false,
             "type": "string"
           },
+          {
+            "name": "account_index",
+            "in": "query",
+            "required": true,
+            "type": "integer",
+            "format": "int64"
+          },
           {
             "name": "l1_address",
             "in": "query",
@@ -1141,12 +1235,14 @@
         "parameters": [
           {
             "name": "authorization",
-            "in": "header",
+            "description": " make required after integ is done",
+            "in": "query",
             "required": false,
             "type": "string"
           },
           {
             "name": "auth",
+            "description": " made optional to support header auth clients",
             "in": "query",
             "required": false,
             "type": "string"
@@ -1277,23 +1373,23 @@
           {
             "name": "authorization",
             "description": " make required after integ is done",
-            "in": "header",
+            "in": "query",
             "required": false,
             "type": "string"
           },
-          {
-            "name": "account_index",
-            "in": "query",
-            "required": true,
-            "type": "integer",
-            "format": "int64"
-          },
           {
             "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"
           }
         ],
         "tags": [
@@ -1734,7 +1830,7 @@
           {
             "name": "authorization",
             "description": " make required after integ is done",
-            "in": "header",
+            "in": "query",
             "required": false,
             "type": "string"
           },
@@ -2036,12 +2132,14 @@
         "parameters": [
           {
             "name": "authorization",
-            "in": "header",
+            "description": " make required after integ is done",
+            "in": "query",
             "required": false,
             "type": "string"
           },
           {
             "name": "auth",
+            "description": " made optional to support header auth clients",
             "in": "query",
             "required": false,
             "type": "string"
@@ -2139,12 +2237,14 @@
         "parameters": [
           {
             "name": "authorization",
-            "in": "header",
+            "description": " make required after integ is done",
+            "in": "query",
             "required": false,
             "type": "string"
           },
           {
             "name": "auth",
+            "description": " made optional to support header auth clients",
             "in": "query",
             "required": false,
             "type": "string"
@@ -2222,12 +2322,14 @@
         "parameters": [
           {
             "name": "authorization",
-            "in": "header",
+            "description": " make required after integ is done",
+            "in": "query",
             "required": false,
             "type": "string"
           },
           {
             "name": "auth",
+            "description": " made optional to support header auth clients",
             "in": "query",
             "required": false,
             "type": "string"
@@ -2388,7 +2490,7 @@
           {
             "name": "authorization",
             "description": " make required after integ is done",
-            "in": "header",
+            "in": "query",
             "required": false,
             "type": "string"
           },
@@ -2482,7 +2584,7 @@
           {
             "name": "authorization",
             "description": " make required after integ is done",
-            "in": "header",
+            "in": "query",
             "required": false,
             "type": "string"
           },
@@ -2716,6 +2818,135 @@
         "description": "Set account metadata"
       }
     },
+    "/api/v1/tokens": {
+      "get": {
+        "summary": "tokens",
+        "operationId": "tokens",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/RespGetApiTokens"
+            }
+          },
+          "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": "account_index",
+            "in": "query",
+            "required": true,
+            "type": "integer",
+            "format": "int64"
+          }
+        ],
+        "tags": [
+          "account"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Get api tokens of an account"
+      }
+    },
+    "/api/v1/tokens/create": {
+      "post": {
+        "summary": "tokens_create",
+        "operationId": "tokens_create",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/RespPostApiToken"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "authorization",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/ReqPostApiToken"
+            }
+          }
+        ],
+        "tags": [
+          "account"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Create api token"
+      }
+    },
+    "/api/v1/tokens/revoke": {
+      "post": {
+        "summary": "tokens_revoke",
+        "operationId": "tokens_revoke",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/RespRevokeApiToken"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "authorization",
+            "in": "header",
+            "required": false,
+            "type": "string"
+          },
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/ReqRevokeApiToken"
+            }
+          }
+        ],
+        "tags": [
+          "account"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Revoke api token"
+      }
+    },
     "/api/v1/trades": {
       "get": {
         "summary": "trades",
@@ -2737,12 +2968,14 @@
         "parameters": [
           {
             "name": "authorization",
-            "in": "header",
+            "description": " make required after integ is done",
+            "in": "query",
             "required": false,
             "type": "string"
           },
           {
             "name": "auth",
+            "description": " made optional to support header auth clients",
             "in": "query",
             "required": false,
             "type": "string"
@@ -2888,17 +3121,10 @@
           {
             "name": "authorization",
             "description": " make required after integ is done",
-            "in": "header",
+            "in": "query",
             "required": false,
             "type": "string"
           },
-          {
-            "name": "account_index",
-            "in": "query",
-            "required": true,
-            "type": "integer",
-            "format": "int64"
-          },
           {
             "name": "auth",
             "description": " made optional to support header auth clients",
@@ -2906,6 +3132,13 @@
             "required": false,
             "type": "string"
           },
+          {
+            "name": "account_index",
+            "in": "query",
+            "required": true,
+            "type": "integer",
+            "format": "int64"
+          },
           {
             "name": "cursor",
             "in": "query",
@@ -2943,12 +3176,14 @@
         "parameters": [
           {
             "name": "authorization",
-            "in": "header",
+            "description": " make required after integ is done",
+            "in": "query",
             "required": false,
             "type": "string"
           },
           {
             "name": "auth",
+            "description": " made optional to support header auth clients",
             "in": "query",
             "required": false,
             "type": "string"
@@ -3125,17 +3360,10 @@
           {
             "name": "authorization",
             "description": " make required after integ is done",
-            "in": "header",
+            "in": "query",
             "required": false,
             "type": "string"
           },
-          {
-            "name": "account_index",
-            "in": "query",
-            "required": true,
-            "type": "integer",
-            "format": "int64"
-          },
           {
             "name": "auth",
             "description": " made optional to support header auth clients",
@@ -3143,6 +3371,13 @@
             "required": false,
             "type": "string"
           },
+          {
+            "name": "account_index",
+            "in": "query",
+            "required": true,
+            "type": "integer",
+            "format": "int64"
+          },
           {
             "name": "cursor",
             "in": "query",
@@ -3790,6 +4025,41 @@
         "total_volume"
       ]
     },
+    "AirdropPercentageItem": {
+      "type": "object",
+      "properties": {
+        "l1_address": {
+          "type": "string"
+        },
+        "percentage": {
+          "type": "string"
+        }
+      },
+      "title": "AirdropPercentageItem",
+      "required": [
+        "l1_address",
+        "percentage"
+      ]
+    },
+    "AirdropPercentages": {
+      "type": "object",
+      "properties": {
+        "l1_address": {
+          "type": "string"
+        },
+        "percentages": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/AirdropPercentageItem"
+          }
+        }
+      },
+      "title": "AirdropPercentages",
+      "required": [
+        "l1_address",
+        "percentages"
+      ]
+    },
     "Announcement": {
       "type": "object",
       "properties": {
@@ -3845,29 +4115,74 @@
       "properties": {
         "account_index": {
           "type": "integer",
-          "format": "int64",
-          "example": "3"
+          "format": "int64",
+          "example": "3"
+        },
+        "api_key_index": {
+          "type": "integer",
+          "format": "uint8",
+          "example": "0"
+        },
+        "nonce": {
+          "type": "integer",
+          "format": "int64",
+          "example": "722"
+        },
+        "public_key": {
+          "type": "string"
+        }
+      },
+      "title": "ApiKey",
+      "required": [
+        "account_index",
+        "api_key_index",
+        "nonce",
+        "public_key"
+      ]
+    },
+    "ApiToken": {
+      "type": "object",
+      "properties": {
+        "token_id": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "api_token": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
         },
-        "api_key_index": {
+        "expiry": {
           "type": "integer",
-          "format": "uint8",
-          "example": "0"
+          "format": "int64"
         },
-        "nonce": {
-          "type": "integer",
-          "format": "int64",
-          "example": "722"
+        "sub_account_access": {
+          "type": "boolean",
+          "format": "boolean"
         },
-        "public_key": {
+        "revoked": {
+          "type": "boolean",
+          "format": "boolean"
+        },
+        "scopes": {
           "type": "string"
         }
       },
-      "title": "ApiKey",
+      "title": "ApiToken",
       "required": [
+        "token_id",
+        "api_token",
+        "name",
         "account_index",
-        "api_key_index",
-        "nonce",
-        "public_key"
+        "expiry",
+        "sub_account_access",
+        "revoked",
+        "scopes"
       ]
     },
     "Asset": {
@@ -3954,6 +4269,19 @@
         "asset_details"
       ]
     },
+    "Auth": {
+      "type": "object",
+      "properties": {
+        "auth": {
+          "type": "string",
+          "description": " made optional to support header auth clients"
+        }
+      },
+      "title": "Auth",
+      "required": [
+        "auth"
+      ]
+    },
     "Block": {
       "type": "object",
       "properties": {
@@ -6963,6 +7291,29 @@
         "new_tier"
       ]
     },
+    "ReqCreateAirdropPercentages": {
+      "type": "object",
+      "properties": {
+        "l1_address": {
+          "type": "string"
+        },
+        "percentages": {
+          "type": "string"
+        },
+        "signature": {
+          "type": "string"
+        },
+        "auth": {
+          "type": "string"
+        }
+      },
+      "title": "ReqCreateAirdropPercentages",
+      "required": [
+        "l1_address",
+        "percentages",
+        "signature"
+      ]
+    },
     "ReqCreateIntentAddress": {
       "type": "object",
       "properties": {
@@ -7026,7 +7377,8 @@
       "type": "object",
       "properties": {
         "auth": {
-          "type": "string"
+          "type": "string",
+          "description": " made optional to support header auth clients"
         },
         "account_index": {
           "type": "integer",
@@ -7094,6 +7446,10 @@
     "ReqGetAccountActiveOrders": {
       "type": "object",
       "properties": {
+        "auth": {
+          "type": "string",
+          "description": " made optional to support header auth clients"
+        },
         "account_index": {
           "type": "integer",
           "format": "int64"
@@ -7101,10 +7457,6 @@
         "market_id": {
           "type": "integer",
           "format": "int16"
-        },
-        "auth": {
-          "type": "string",
-          "description": " made optional to support header auth clients"
         }
       },
       "title": "ReqGetAccountActiveOrders",
@@ -7227,7 +7579,8 @@
       "type": "object",
       "properties": {
         "auth": {
-          "type": "string"
+          "type": "string",
+          "description": " made optional to support header auth clients"
         },
         "by": {
           "type": "string",
@@ -7301,18 +7654,47 @@
         "value": {
           "type": "string"
         },
+        "auth": {
+          "type": "string",
+          "description": " made optional to support header auth clients"
+        },
         "types": {
           "type": "array",
           "items": {
             "type": "integer",
             "format": "uint8"
           }
+        }
+      },
+      "title": "ReqGetAccountTxs"
+    },
+    "ReqGetAirdropPercentages": {
+      "type": "object",
+      "properties": {
+        "l1_address": {
+          "type": "string"
         },
         "auth": {
           "type": "string"
         }
       },
-      "title": "ReqGetAccountTxs"
+      "title": "ReqGetAirdropPercentages",
+      "required": [
+        "l1_address"
+      ]
+    },
+    "ReqGetApiTokens": {
+      "type": "object",
+      "properties": {
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
+        }
+      },
+      "title": "ReqGetApiTokens",
+      "required": [
+        "account_index"
+      ]
     },
     "ReqGetAssetDetails": {
       "type": "object",
@@ -7449,14 +7831,14 @@
     "ReqGetDepositHistory": {
       "type": "object",
       "properties": {
-        "account_index": {
-          "type": "integer",
-          "format": "int64"
-        },
         "auth": {
           "type": "string",
           "description": " made optional to support header auth clients"
         },
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
+        },
         "l1_address": {
           "type": "string"
         },
@@ -7485,13 +7867,13 @@
     "ReqGetFastWithdrawInfo": {
       "type": "object",
       "properties": {
-        "account_index": {
-          "type": "integer",
-          "format": "int64"
-        },
         "auth": {
           "type": "string",
           "description": " made optional to support header auth clients"
+        },
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
         }
       },
       "title": "ReqGetFastWithdrawInfo",
@@ -7733,7 +8115,8 @@
       "type": "object",
       "properties": {
         "auth": {
-          "type": "string"
+          "type": "string",
+          "description": " made optional to support header auth clients"
         },
         "account_index": {
           "type": "integer",
@@ -7773,7 +8156,8 @@
       "type": "object",
       "properties": {
         "auth": {
-          "type": "string"
+          "type": "string",
+          "description": " made optional to support header auth clients"
         },
         "filter": {
           "type": "string",
@@ -7924,7 +8308,8 @@
       "type": "object",
       "properties": {
         "auth": {
-          "type": "string"
+          "type": "string",
+          "description": " made optional to support header auth clients"
         },
         "market_id": {
           "type": "integer",
@@ -8010,7 +8395,8 @@
       "type": "object",
       "properties": {
         "auth": {
-          "type": "string"
+          "type": "string",
+          "description": " made optional to support header auth clients"
         },
         "account_index": {
           "type": "integer",
@@ -8030,14 +8416,14 @@
     "ReqGetTransferHistory": {
       "type": "object",
       "properties": {
-        "account_index": {
-          "type": "integer",
-          "format": "int64"
-        },
         "auth": {
           "type": "string",
           "description": " made optional to support header auth clients"
         },
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
+        },
         "cursor": {
           "type": "string"
         }
@@ -8070,14 +8456,14 @@
     "ReqGetWithdrawHistory": {
       "type": "object",
       "properties": {
-        "account_index": {
-          "type": "integer",
-          "format": "int64"
-        },
         "auth": {
           "type": "string",
           "description": " made optional to support header auth clients"
         },
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
+        },
         "cursor": {
           "type": "string"
         },
@@ -8107,6 +8493,56 @@
         "l1_address"
       ]
     },
+    "ReqPostApiToken": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "expiry": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "sub_account_access": {
+          "type": "boolean",
+          "format": "boolean"
+        },
+        "scopes": {
+          "type": "string",
+          "example": "read.*",
+          "default": "read.*"
+        }
+      },
+      "title": "ReqPostApiToken",
+      "required": [
+        "name",
+        "account_index",
+        "expiry",
+        "sub_account_access"
+      ]
+    },
+    "ReqRevokeApiToken": {
+      "type": "object",
+      "properties": {
+        "token_id": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
+        }
+      },
+      "title": "ReqRevokeApiToken",
+      "required": [
+        "token_id",
+        "account_index"
+      ]
+    },
     "ReqSendTx": {
       "type": "object",
       "properties": {
@@ -8269,6 +8705,30 @@
         "code"
       ]
     },
+    "RespGetApiTokens": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "example": "200"
+        },
+        "message": {
+          "type": "string"
+        },
+        "api_tokens": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ApiToken"
+          }
+        }
+      },
+      "title": "RespGetApiTokens",
+      "required": [
+        "code",
+        "api_tokens"
+      ]
+    },
     "RespGetBridgesByL1Addr": {
       "type": "object",
       "properties": {
@@ -8366,6 +8826,60 @@
         "is_next_bridge_fast"
       ]
     },
+    "RespPostApiToken": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "example": "200"
+        },
+        "message": {
+          "type": "string"
+        },
+        "token_id": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "api_token": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "account_index": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "expiry": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "sub_account_access": {
+          "type": "boolean",
+          "format": "boolean"
+        },
+        "revoked": {
+          "type": "boolean",
+          "format": "boolean"
+        },
+        "scopes": {
+          "type": "string"
+        }
+      },
+      "title": "RespPostApiToken",
+      "required": [
+        "code",
+        "token_id",
+        "api_token",
+        "name",
+        "account_index",
+        "expiry",
+        "sub_account_access",
+        "revoked",
+        "scopes"
+      ]
+    },
     "RespPublicPoolsMetadata": {
       "type": "object",
       "properties": {
@@ -8390,6 +8904,33 @@
         "public_pools"
       ]
     },
+    "RespRevokeApiToken": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "example": "200"
+        },
+        "message": {
+          "type": "string"
+        },
+        "token_id": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "revoked": {
+          "type": "boolean",
+          "format": "boolean"
+        }
+      },
+      "title": "RespRevokeApiToken",
+      "required": [
+        "code",
+        "token_id",
+        "revoked"
+      ]
+    },
     "RespSendTx": {
       "type": "object",
       "properties": {