zklighter-perps 1.0.188 → 1.0.190

package/openapi.json

@@ -867,6 +867,92 @@
         "description": "Get if next bridge is fast"
       }
     },
+    "/api/v1/candles": {
+      "get": {
+        "summary": "candles",
+        "operationId": "candles",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/Candles"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "market_id",
+            "in": "query",
+            "required": true,
+            "type": "integer",
+            "format": "int16"
+          },
+          {
+            "name": "resolution",
+            "in": "query",
+            "required": true,
+            "type": "string",
+            "enum": [
+              "1m",
+              "5m",
+              "15m",
+              "30m",
+              "1h",
+              "4h",
+              "12h",
+              "1d",
+              "1w"
+            ]
+          },
+          {
+            "name": "start_timestamp",
+            "in": "query",
+            "required": true,
+            "type": "integer",
+            "format": "int64",
+            "minimum": 0,
+            "maximum": 5000000000000
+          },
+          {
+            "name": "end_timestamp",
+            "in": "query",
+            "required": true,
+            "type": "integer",
+            "format": "int64",
+            "minimum": 0,
+            "maximum": 5000000000000
+          },
+          {
+            "name": "count_back",
+            "in": "query",
+            "required": true,
+            "type": "integer",
+            "format": "int64"
+          },
+          {
+            "name": "set_timestamp_to_end",
+            "in": "query",
+            "required": false,
+            "type": "boolean",
+            "format": "boolean",
+            "default": "false"
+          }
+        ],
+        "tags": [
+          "candlestick"
+        ],
+        "consumes": [
+          "multipart/form-data"
+        ],
+        "description": "Get candles (optimized with shortened fields and smaller response size)"
+      }
+    },
     "/api/v1/candlesticks": {
       "get": {
         "summary": "candlesticks",
@@ -1612,6 +1698,38 @@
         "description": "Coin Gecko Orderbook"
       }
     },
+    "/api/v1/gecko/tickers": {
+      "get": {
+        "summary": "gecko_tickers",
+        "operationId": "gecko_tickers",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/GeckoTickers"
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "schema": {
+              "$ref": "#/definitions/ResultCode"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "auth",
+            "in": "header",
+            "required": true,
+            "type": "string"
+          }
+        ],
+        "tags": [
+          "gecko"
+        ],
+        "description": "Coin Gecko Spot Tickers"
+      }
+    },
     "/api/v1/geoLocation": {
       "get": {
         "summary": "geoLocation",
@@ -2343,7 +2461,8 @@
               "all",
               "user",
               "protocol",
-              "account_index"
+              "account_index",
+              "stake"
             ]
           },
           {
@@ -3512,6 +3631,11 @@
         "collateral": {
           "type": "string",
           "example": "46342"
+        },
+        "transaction_time": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1257894000000000"
         }
       },
       "title": "Account",
@@ -3526,7 +3650,8 @@
         "pending_order_count",
         "available_balance",
         "status",
-        "collateral"
+        "collateral",
+        "transaction_time"
       ]
     },
     "AccountApiKeys": {
@@ -4130,6 +4255,11 @@
         },
         "public_key": {
           "type": "string"
+        },
+        "transaction_time": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1257894000000000"
         }
       },
       "title": "ApiKey",
@@ -4137,7 +4267,8 @@
         "account_index",
         "api_key_index",
         "nonce",
-        "public_key"
+        "public_key",
+        "transaction_time"
       ]
     },
     "ApiToken": {
@@ -4515,6 +4646,129 @@
         "networks"
       ]
     },
+    "Candle": {
+      "type": "object",
+      "properties": {
+        "t": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1640995200",
+          "description": " timestamp"
+        },
+        "o": {
+          "type": "number",
+          "format": "double",
+          "example": "3024.66",
+          "description": " open"
+        },
+        "h": {
+          "type": "number",
+          "format": "double",
+          "example": "3034.66",
+          "description": " high"
+        },
+        "l": {
+          "type": "number",
+          "format": "double",
+          "example": "3014.66",
+          "description": " low"
+        },
+        "c": {
+          "type": "number",
+          "format": "double",
+          "example": "3024.66",
+          "description": " close"
+        },
+        "O": {
+          "type": "number",
+          "format": "double",
+          "example": "3024.66",
+          "description": " open_raw"
+        },
+        "H": {
+          "type": "number",
+          "format": "double",
+          "example": "3034.66",
+          "description": " high_raw"
+        },
+        "L": {
+          "type": "number",
+          "format": "double",
+          "example": "3014.66",
+          "description": " low_raw"
+        },
+        "C": {
+          "type": "number",
+          "format": "double",
+          "example": "3024.66",
+          "description": " close_raw"
+        },
+        "v": {
+          "type": "number",
+          "format": "double",
+          "example": "235.25",
+          "description": " volume0"
+        },
+        "V": {
+          "type": "number",
+          "format": "double",
+          "example": "93566.25",
+          "description": " volume1"
+        },
+        "i": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1",
+          "description": " last_trade_id"
+        }
+      },
+      "title": "Candle",
+      "required": [
+        "t",
+        "o",
+        "h",
+        "l",
+        "c",
+        "O",
+        "H",
+        "L",
+        "C",
+        "v",
+        "V",
+        "i"
+      ]
+    },
+    "Candles": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32",
+          "example": "200"
+        },
+        "message": {
+          "type": "string"
+        },
+        "r": {
+          "type": "string",
+          "example": "15m",
+          "description": " resolution"
+        },
+        "c": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Candle"
+          },
+          "description": " candles"
+        }
+      },
+      "title": "Candles",
+      "required": [
+        "code",
+        "r",
+        "c"
+      ]
+    },
     "Candlestick": {
       "type": "object",
       "properties": {
@@ -4577,6 +4831,11 @@
           "type": "integer",
           "format": "int64",
           "example": "1"
+        },
+        "trade_count": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1503241"
         }
       },
       "title": "Candlestick",
@@ -4592,7 +4851,8 @@
         "close_raw",
         "volume0",
         "volume1",
-        "last_trade_id"
+        "last_trade_id",
+        "trade_count"
       ]
     },
     "Candlesticks": {
@@ -4926,6 +5186,11 @@
           "type": "string",
           "example": "46342"
         },
+        "transaction_time": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1257894000000000"
+        },
         "account_index": {
           "type": "integer",
           "format": "int64"
@@ -4988,6 +5253,7 @@
         "available_balance",
         "status",
         "collateral",
+        "transaction_time",
         "account_index",
         "name",
         "description",
@@ -5205,6 +5471,11 @@
           "format": "uint8",
           "example": "0"
         },
+        "transaction_time": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1257894000000000"
+        },
         "committed_at": {
           "type": "integer",
           "format": "int64",
@@ -5235,6 +5506,7 @@
         "sequence_index",
         "parent_hash",
         "api_key_index",
+        "transaction_time",
         "committed_at",
         "verified_at"
       ]
@@ -5591,6 +5863,80 @@
         "asks"
       ]
     },
+    "GeckoTicker": {
+      "type": "object",
+      "properties": {
+        "ticker_id": {
+          "type": "string"
+        },
+        "base_currency": {
+          "type": "string"
+        },
+        "target_currency": {
+          "type": "string"
+        },
+        "last_price": {
+          "type": "number",
+          "format": "double"
+        },
+        "base_volume": {
+          "type": "number",
+          "format": "double"
+        },
+        "target_volume": {
+          "type": "number",
+          "format": "double"
+        },
+        "pool_id": {
+          "type": "string"
+        },
+        "bid": {
+          "type": "number",
+          "format": "double"
+        },
+        "ask": {
+          "type": "number",
+          "format": "double"
+        },
+        "high": {
+          "type": "number",
+          "format": "double"
+        },
+        "low": {
+          "type": "number",
+          "format": "double"
+        }
+      },
+      "title": "GeckoTicker",
+      "required": [
+        "ticker_id",
+        "base_currency",
+        "target_currency",
+        "last_price",
+        "base_volume",
+        "target_volume",
+        "pool_id",
+        "bid",
+        "ask",
+        "high",
+        "low"
+      ]
+    },
+    "GeckoTickers": {
+      "type": "object",
+      "properties": {
+        "tickers": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/GeckoTicker"
+          }
+        }
+      },
+      "title": "GeckoTickers",
+      "required": [
+        "tickers"
+      ]
+    },
     "IsWhitelisted": {
       "type": "object",
       "properties": {
@@ -5789,6 +6135,10 @@
         },
         "maker_fee": {
           "type": "string"
+        },
+        "transaction_time": {
+          "type": "integer",
+          "format": "int64"
         }
       },
       "title": "LiqTrade",
@@ -5796,7 +6146,8 @@
         "price",
         "size",
         "taker_fee",
-        "maker_fee"
+        "maker_fee",
+        "transaction_time"
       ]
     },
     "Liquidation": {
@@ -6146,6 +6497,11 @@
           "type": "integer",
           "format": "int64",
           "example": "1640995200"
+        },
+        "transaction_time": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1257894000000000"
         }
       },
       "title": "Order",
@@ -6182,7 +6538,8 @@
         "block_height",
         "timestamp",
         "created_at",
-        "updated_at"
+        "updated_at",
+        "transaction_time"
       ]
     },
     "OrderBook": {
@@ -6325,6 +6682,46 @@
         "nonce"
       ]
     },
+    "OrderBookDepthWithBeginNonce": {
+      "type": "object",
+      "properties": {
+        "asks": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/PriceLevel"
+          }
+        },
+        "bids": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/PriceLevel"
+          }
+        },
+        "offset": {
+          "type": "integer",
+          "format": "int64",
+          "example": "0"
+        },
+        "nonce": {
+          "type": "integer",
+          "format": "int64",
+          "example": "0"
+        },
+        "begin_nonce": {
+          "type": "integer",
+          "format": "int64",
+          "example": "0"
+        }
+      },
+      "title": "OrderBookDepthWithBeginNonce",
+      "required": [
+        "asks",
+        "bids",
+        "offset",
+        "nonce",
+        "begin_nonce"
+      ]
+    },
     "OrderBookDetails": {
       "type": "object",
       "properties": {
@@ -7124,6 +7521,11 @@
           "example": "3000"
         },
         "entry_usdc": {
+          "type": "string",
+          "example": "3000",
+          "description": " For public pools and insurance fund"
+        },
+        "principal_amount": {
           "type": "string",
           "example": "3000"
         }
@@ -7132,7 +7534,8 @@
       "required": [
         "public_pool_index",
         "shares_amount",
-        "entry_usdc"
+        "entry_usdc",
+        "principal_amount"
       ]
     },
     "ReferralCode": {
@@ -7778,6 +8181,56 @@
         "value"
       ]
     },
+    "ReqGetCandles": {
+      "type": "object",
+      "properties": {
+        "market_id": {
+          "type": "integer",
+          "format": "int16"
+        },
+        "resolution": {
+          "type": "string",
+          "enum": [
+            "1m",
+            "5m",
+            "15m",
+            "30m",
+            "1h",
+            "4h",
+            "12h",
+            "1d",
+            "1w"
+          ]
+        },
+        "start_timestamp": {
+          "type": "integer",
+          "format": "int64",
+          "maximum": 5000000000000
+        },
+        "end_timestamp": {
+          "type": "integer",
+          "format": "int64",
+          "maximum": 5000000000000
+        },
+        "count_back": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "set_timestamp_to_end": {
+          "type": "boolean",
+          "format": "boolean",
+          "default": "false"
+        }
+      },
+      "title": "ReqGetCandles",
+      "required": [
+        "market_id",
+        "resolution",
+        "start_timestamp",
+        "end_timestamp",
+        "count_back"
+      ]
+    },
     "ReqGetCandlesticks": {
       "type": "object",
       "properties": {
@@ -7935,6 +8388,10 @@
         "ticker_id"
       ]
     },
+    "ReqGetGeckoTickers": {
+      "type": "object",
+      "title": "ReqGetGeckoTickers"
+    },
     "ReqGetL1Metadata": {
       "type": "object",
       "properties": {
@@ -8165,7 +8622,8 @@
             "all",
             "user",
             "protocol",
-            "account_index"
+            "account_index",
+            "stake"
           ]
         },
         "index": {
@@ -9181,6 +9639,11 @@
           "type": "integer",
           "format": "int64",
           "example": "1640995200"
+        },
+        "transaction_time": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1257894000000000"
         }
       },
       "title": "SimpleOrder",
@@ -9191,7 +9654,8 @@
         "initial_base_amount",
         "remaining_base_amount",
         "price",
-        "order_expiry"
+        "order_expiry",
+        "transaction_time"
       ]
     },
     "SpotMarketStats": {
@@ -9624,6 +10088,11 @@
           "type": "boolean",
           "format": "boolean",
           "example": "true"
+        },
+        "transaction_time": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1257894000000000"
         }
       },
       "title": "Trade",
@@ -9651,7 +10120,8 @@
         "maker_position_size_before",
         "maker_entry_quote_before",
         "maker_initial_margin_fraction_before",
-        "maker_position_sign_changed"
+        "maker_position_sign_changed",
+        "transaction_time"
       ]
     },
     "Trades": {
@@ -9764,7 +10234,11 @@
             "L2BurnSharesOutflow",
             "L2MintSharesInflow",
             "L2MintSharesOutflow",
-            "L2SelfTransfer"
+            "L2SelfTransfer",
+            "L2StakeAssetInflow",
+            "L2StakeAssetOutflow",
+            "L2UnstakeAssetInflow",
+            "L2UnstakeAssetOutflow"
           ]
         },
         "from_l1_address": {
@@ -9900,6 +10374,11 @@
           "type": "integer",
           "format": "uint8",
           "example": "0"
+        },
+        "transaction_time": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1257894000000000"
         }
       },
       "title": "Tx",
@@ -9919,7 +10398,8 @@
         "executed_at",
         "sequence_index",
         "parent_hash",
-        "api_key_index"
+        "api_key_index",
+        "transaction_time"
       ]
     },
     "TxHash": {