zklighter-perps 1.0.187 → 1.0.189

package/openapi.json

@@ -462,7 +462,7 @@
           "200": {
             "description": "A successful response.",
             "schema": {
-              "$ref": "#/definitions/AirdropPercentages"
+              "$ref": "#/definitions/AirdropAllocations"
             }
           },
           "400": {
@@ -499,7 +499,7 @@
         "consumes": [
           "multipart/form-data"
         ],
-        "description": "Get airdrop percentages"
+        "description": "Get airdrop allocation"
       }
     },
     "/api/v1/airdrop/create": {
@@ -533,7 +533,7 @@
             "in": "body",
             "required": true,
             "schema": {
-              "$ref": "#/definitions/ReqCreateAirdropPercentages"
+              "$ref": "#/definitions/ReqCreateAirdropAllocations"
             }
           }
         ],
@@ -543,7 +543,7 @@
         "consumes": [
           "multipart/form-data"
         ],
-        "description": "Create airdrop percentages"
+        "description": "Create airdrop allocation"
       }
     },
     "/api/v1/announcement": {
@@ -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",
@@ -3512,6 +3598,11 @@
         "collateral": {
           "type": "string",
           "example": "46342"
+        },
+        "transaction_time": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1257894000000000"
         }
       },
       "title": "Account",
@@ -3526,7 +3617,8 @@
         "pending_order_count",
         "available_balance",
         "status",
-        "collateral"
+        "collateral",
+        "transaction_time"
       ]
     },
     "AccountApiKeys": {
@@ -4025,39 +4117,39 @@
         "total_volume"
       ]
     },
-    "AirdropPercentageItem": {
+    "AirdropAllocationItem": {
       "type": "object",
       "properties": {
         "l1_address": {
           "type": "string"
         },
-        "percentage": {
+        "allocation": {
           "type": "string"
         }
       },
-      "title": "AirdropPercentageItem",
+      "title": "AirdropAllocationItem",
       "required": [
         "l1_address",
-        "percentage"
+        "allocation"
       ]
     },
-    "AirdropPercentages": {
+    "AirdropAllocations": {
       "type": "object",
       "properties": {
         "l1_address": {
           "type": "string"
         },
-        "percentages": {
+        "allocations": {
           "type": "array",
           "items": {
-            "$ref": "#/definitions/AirdropPercentageItem"
+            "$ref": "#/definitions/AirdropAllocationItem"
           }
         }
       },
-      "title": "AirdropPercentages",
+      "title": "AirdropAllocations",
       "required": [
         "l1_address",
-        "percentages"
+        "allocations"
       ]
     },
     "Announcement": {
@@ -4130,6 +4222,11 @@
         },
         "public_key": {
           "type": "string"
+        },
+        "transaction_time": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1257894000000000"
         }
       },
       "title": "ApiKey",
@@ -4137,7 +4234,8 @@
         "account_index",
         "api_key_index",
         "nonce",
-        "public_key"
+        "public_key",
+        "transaction_time"
       ]
     },
     "ApiToken": {
@@ -4515,6 +4613,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 +4798,11 @@
           "type": "integer",
           "format": "int64",
           "example": "1"
+        },
+        "trade_count": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1503241"
         }
       },
       "title": "Candlestick",
@@ -4592,7 +4818,8 @@
         "close_raw",
         "volume0",
         "volume1",
-        "last_trade_id"
+        "last_trade_id",
+        "trade_count"
       ]
     },
     "Candlesticks": {
@@ -4926,6 +5153,11 @@
           "type": "string",
           "example": "46342"
         },
+        "transaction_time": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1257894000000000"
+        },
         "account_index": {
           "type": "integer",
           "format": "int64"
@@ -4988,6 +5220,7 @@
         "available_balance",
         "status",
         "collateral",
+        "transaction_time",
         "account_index",
         "name",
         "description",
@@ -5205,6 +5438,11 @@
           "format": "uint8",
           "example": "0"
         },
+        "transaction_time": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1257894000000000"
+        },
         "committed_at": {
           "type": "integer",
           "format": "int64",
@@ -5235,6 +5473,7 @@
         "sequence_index",
         "parent_hash",
         "api_key_index",
+        "transaction_time",
         "committed_at",
         "verified_at"
       ]
@@ -5789,6 +6028,10 @@
         },
         "maker_fee": {
           "type": "string"
+        },
+        "transaction_time": {
+          "type": "integer",
+          "format": "int64"
         }
       },
       "title": "LiqTrade",
@@ -5796,7 +6039,8 @@
         "price",
         "size",
         "taker_fee",
-        "maker_fee"
+        "maker_fee",
+        "transaction_time"
       ]
     },
     "Liquidation": {
@@ -6146,6 +6390,11 @@
           "type": "integer",
           "format": "int64",
           "example": "1640995200"
+        },
+        "transaction_time": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1257894000000000"
         }
       },
       "title": "Order",
@@ -6182,7 +6431,8 @@
         "block_height",
         "timestamp",
         "created_at",
-        "updated_at"
+        "updated_at",
+        "transaction_time"
       ]
     },
     "OrderBook": {
@@ -6325,6 +6575,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": {
@@ -7291,27 +7581,15 @@
         "new_tier"
       ]
     },
-    "ReqCreateAirdropPercentages": {
+    "ReqCreateAirdropAllocations": {
       "type": "object",
       "properties": {
         "l1_address": {
           "type": "string"
         },
-        "percentages": {
+        "allocations": {
           "type": "string"
         },
-        "nonce": {
-          "type": "integer",
-          "format": "int64"
-        },
-        "account_index": {
-          "type": "integer",
-          "format": "int64"
-        },
-        "api_key_index": {
-          "type": "integer",
-          "format": "uint8"
-        },
         "signature": {
           "type": "string"
         },
@@ -7319,10 +7597,10 @@
           "type": "string"
         }
       },
-      "title": "ReqCreateAirdropPercentages",
+      "title": "ReqCreateAirdropAllocations",
       "required": [
         "l1_address",
-        "percentages",
+        "allocations",
         "signature"
       ]
     },
@@ -7680,7 +7958,7 @@
       },
       "title": "ReqGetAccountTxs"
     },
-    "ReqGetAirdropPercentages": {
+    "ReqGetAirdropAllocations": {
       "type": "object",
       "properties": {
         "l1_address": {
@@ -7690,7 +7968,7 @@
           "type": "string"
         }
       },
-      "title": "ReqGetAirdropPercentages",
+      "title": "ReqGetAirdropAllocations",
       "required": [
         "l1_address"
       ]
@@ -7790,6 +8068,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": {
@@ -9193,6 +9521,11 @@
           "type": "integer",
           "format": "int64",
           "example": "1640995200"
+        },
+        "transaction_time": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1257894000000000"
         }
       },
       "title": "SimpleOrder",
@@ -9203,7 +9536,8 @@
         "initial_base_amount",
         "remaining_base_amount",
         "price",
-        "order_expiry"
+        "order_expiry",
+        "transaction_time"
       ]
     },
     "SpotMarketStats": {
@@ -9636,6 +9970,11 @@
           "type": "boolean",
           "format": "boolean",
           "example": "true"
+        },
+        "transaction_time": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1257894000000000"
         }
       },
       "title": "Trade",
@@ -9663,7 +10002,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": {
@@ -9912,6 +10252,11 @@
           "type": "integer",
           "format": "uint8",
           "example": "0"
+        },
+        "transaction_time": {
+          "type": "integer",
+          "format": "int64",
+          "example": "1257894000000000"
         }
       },
       "title": "Tx",
@@ -9931,7 +10276,8 @@
         "executed_at",
         "sequence_index",
         "parent_hash",
-        "api_key_index"
+        "api_key_index",
+        "transaction_time"
       ]
     },
     "TxHash": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zklighter-perps",
-  "version": "1.0.187",
+  "version": "1.0.189",
   "description": "zkLighter Perps SDK",
   "main": "index.ts",
   "directories": {