[RFC] Update API docs and specs

artifacts/apidocs/schemas/api_drop_client_ws_request.md

@@ -0,0 +1,4 @@
+!!! info "[ApiDropClientWsRequest](/../../schemas/api_drop_client_ws_request)"
+    |Name<br>`Lite`|Type|Required<br>`Default`| Description |
+    |-|-|-|-|
+    |main_account_id<br>`ma` |string|True||

artifacts/apidocs/schemas/api_drop_client_ws_response.md

@@ -0,0 +1,4 @@
+!!! info "[ApiDropClientWsResponse](/../../schemas/api_drop_client_ws_response)"
+    |Name<br>`Lite`|Type|Required<br>`Default`| Description |
+    |-|-|-|-|
+    |num_dropped<br>`nd` |integer|True||

artifacts/apidocs/schemas/api_get_ecosystem_leaderboard_response.md

@@ -20,3 +20,6 @@
         |rank<br>`r` |integer|True|The rank of the account in the ecosystem|
         |epoch<br>`e` |integer|True|The epoch number of the ecosystem point|
         |brokered_trading_volume<br>`bt` |string|True|Brokered trading volume|
+        |brokered_trading_point<br>`bt1` |string|True|Brokered trading point|
+        |referee_kyc_point<br>`rk` |string|True|Referee KYC point|
+        |referrer_kyc_point<br>`rk1` |string|True|Referrer KYC point|

artifacts/apidocs/schemas/api_get_list_flat_referral_response.md

@@ -17,3 +17,4 @@
         |is_kyc_completed<br>`ik` |boolean|True|The account is KYC verified or not|
         |kyc_completed_at<br>`kc` |string|True|The KYC completed time|
         |kyc_type<br>`kt` |string|True|The KYC type, can be 'individual' or 'business'|
+        |kyc_first_completed_at<br>`kf` |string|True|The first KYC completed time|

artifacts/apidocs/schemas/api_get_user_ecosystem_point_response.md

@@ -20,3 +20,6 @@
         |rank<br>`r` |integer|True|The rank of the account in the ecosystem|
         |epoch<br>`e` |integer|True|The epoch number of the ecosystem point|
         |brokered_trading_volume<br>`bt` |string|True|Brokered trading volume|
+        |brokered_trading_point<br>`bt1` |string|True|Brokered trading point|
+        |referee_kyc_point<br>`rk` |string|True|Referee KYC point|
+        |referrer_kyc_point<br>`rk1` |string|True|Referrer KYC point|

artifacts/apidocs/schemas/ecosystem_point.md

@@ -16,3 +16,6 @@
     |rank<br>`r` |integer|True|The rank of the account in the ecosystem|
     |epoch<br>`e` |integer|True|The epoch number of the ecosystem point|
     |brokered_trading_volume<br>`bt` |string|True|Brokered trading volume|
+    |brokered_trading_point<br>`bt1` |string|True|Brokered trading point|
+    |referee_kyc_point<br>`rk` |string|True|Referee KYC point|
+    |referrer_kyc_point<br>`rk1` |string|True|Referrer KYC point|

artifacts/apidocs/schemas/flat_referral.md

@@ -13,3 +13,4 @@
     |is_kyc_completed<br>`ik` |boolean|True|The account is KYC verified or not|
     |kyc_completed_at<br>`kc` |string|True|The KYC completed time|
     |kyc_type<br>`kt` |string|True|The KYC type, can be 'individual' or 'business'|
+    |kyc_first_completed_at<br>`kf` |string|True|The first KYC completed time|

artifacts/apidocs/schemas/ws_cancel_feed_data_v1.md

@@ -3,7 +3,7 @@
     |-|-|-|-|
     |stream<br>`s` |string|True|Stream name|
     |selector<br>`s1` |string|True|Primary selector|
-    |sequence_number<br>`sn` |string|True|A running sequence number that determines global message order within the specific stream|
+    |sequence_number<br>`sn` |string|True|A sequence number used to determine message order within a stream.<br>- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.<br>- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.<br>  - A single cluster payload can be multiplexed into multiple stream payloads.<br>  - To distinguish each stream payload, a `dedupCounter` is included.<br>  - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`.|
     |feed<br>`f` |CancelStatusFeed|True|Data relating to the status of the cancellation attempt|
     ??? info "[CancelStatusFeed](/../../schemas/cancel_status_feed)"
         |Name<br>`Lite`|Type|Required<br>`Default`| Description |

artifacts/apidocs/schemas/ws_candlestick_feed_data_v1.md

@@ -3,7 +3,7 @@
     |-|-|-|-|
     |stream<br>`s` |string|True|Stream name|
     |selector<br>`s1` |string|True|Primary selector|
-    |sequence_number<br>`sn` |string|True|A running sequence number that determines global message order within the specific stream|
+    |sequence_number<br>`sn` |string|True|A sequence number used to determine message order within a stream.<br>- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.<br>- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.<br>  - A single cluster payload can be multiplexed into multiple stream payloads.<br>  - To distinguish each stream payload, a `dedupCounter` is included.<br>  - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`.|
     |feed<br>`f` |Candlestick|True|A candlestick entry matching the request filters|
     ??? info "[Candlestick](/../../schemas/candlestick)"
         <br>

artifacts/apidocs/schemas/ws_deposit_feed_data_v1.md

@@ -5,7 +5,7 @@
     |-|-|-|-|
     |stream<br>`s` |string|True|The websocket channel to which the response is sent|
     |selector<br>`s1` |string|True|Primary selector|
-    |sequence_number<br>`sn` |string|True|A running sequence number that determines global message order within the specific stream|
+    |sequence_number<br>`sn` |string|True|A sequence number used to determine message order within a stream.<br>- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.<br>- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.<br>  - A single cluster payload can be multiplexed into multiple stream payloads.<br>  - To distinguish each stream payload, a `dedupCounter` is included.<br>  - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`.|
     |feed<br>`f` |Deposit|True|The Deposit object|
     ??? info "[Deposit](/../../schemas/deposit)"
         |Name<br>`Lite`|Type|Required<br>`Default`| Description |

artifacts/apidocs/schemas/ws_fill_feed_data_v1.md

@@ -3,7 +3,7 @@
     |-|-|-|-|
     |stream<br>`s` |string|True|The websocket channel to which the response is sent|
     |selector<br>`s1` |string|True|Primary selector|
-    |sequence_number<br>`sn` |string|True|A running sequence number that determines global message order within the specific stream|
+    |sequence_number<br>`sn` |string|True|A sequence number used to determine message order within a stream.<br>- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.<br>- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.<br>  - A single cluster payload can be multiplexed into multiple stream payloads.<br>  - To distinguish each stream payload, a `dedupCounter` is included.<br>  - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`.|
     |feed<br>`f` |Fill|True|A private trade matching the request filter|
     ??? info "[Fill](/../../schemas/fill)"
         |Name<br>`Lite`|Type|Required<br>`Default`| Description |

artifacts/apidocs/schemas/ws_mini_ticker_feed_data_v1.md

@@ -3,7 +3,7 @@
     |-|-|-|-|
     |stream<br>`s` |string|True|Stream name|
     |selector<br>`s1` |string|True|Primary selector|
-    |sequence_number<br>`sn` |string|True|A running sequence number that determines global message order within the specific stream|
+    |sequence_number<br>`sn` |string|True|A sequence number used to determine message order within a stream.<br>- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.<br>- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.<br>  - A single cluster payload can be multiplexed into multiple stream payloads.<br>  - To distinguish each stream payload, a `dedupCounter` is included.<br>  - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`.|
     |feed<br>`f` |MiniTicker|True|A mini ticker matching the request filter|
     ??? info "[MiniTicker](/../../schemas/mini_ticker)"
         |Name<br>`Lite`|Type|Required<br>`Default`| Description |

artifacts/apidocs/schemas/ws_order_feed_data_v1.md

@@ -3,7 +3,7 @@
     |-|-|-|-|
     |stream<br>`s` |string|True|Stream name|
     |selector<br>`s1` |string|True|Primary selector|
-    |sequence_number<br>`sn` |string|True|A running sequence number that determines global message order within the specific stream|
+    |sequence_number<br>`sn` |string|True|A sequence number used to determine message order within a stream.<br>- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.<br>- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.<br>  - A single cluster payload can be multiplexed into multiple stream payloads.<br>  - To distinguish each stream payload, a `dedupCounter` is included.<br>  - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`.|
     |feed<br>`f` |Order|True|The order object being created or updated|
     ??? info "[Order](/../../schemas/order)"
         Order is a typed payload used throughout the GRVT platform to express all orderbook, RFQ, and liquidation orders.<br>GRVT orders are capable of expressing both single-legged, and multi-legged orders by default.<br>This increases the learning curve slightly but reduces overall integration load, since the order payload is used across all GRVT trading venues.<br>Given GRVT's trustless settlement model, the Order payload also carries the signature, required to trade the order on our ZKSync Hyperchain.<br><br>All fields in the Order payload (except `id`, `metadata`, and `state`) are trustlessly enforced on our Hyperchain.<br>This minimizes the amount of trust users have to offer to GRVT<br>

artifacts/apidocs/schemas/ws_order_group_feed_data_v1.md

@@ -3,7 +3,7 @@
     |-|-|-|-|
     |stream<br>`s` |string|True|Stream name|
     |selector<br>`s1` |string|True|Primary selector|
-    |sequence_number<br>`sn` |string|True|A running sequence number that determines global message order within the specific stream|
+    |sequence_number<br>`sn` |string|True|A sequence number used to determine message order within a stream.<br>- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.<br>- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.<br>  - A single cluster payload can be multiplexed into multiple stream payloads.<br>  - To distinguish each stream payload, a `dedupCounter` is included.<br>  - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`.|
     |feed<br>`f` |ClientOrderIDsByGroup|True|The order object being created or updated|
     ??? info "[ClientOrderIDsByGroup](/../../schemas/client_order_i_ds_by_group)"
         Grouping for the client order id and their associated groups.<br><br>This is used to define TP/SL pairs or other order groupings after loading the list of Open Orders.<br>

artifacts/apidocs/schemas/ws_order_state_feed_data_v1.md

@@ -3,7 +3,7 @@
     |-|-|-|-|
     |stream<br>`s` |string|True|Stream name|
     |selector<br>`s1` |string|True|Primary selector|
-    |sequence_number<br>`sn` |string|True|A running sequence number that determines global message order within the specific stream|
+    |sequence_number<br>`sn` |string|True|A sequence number used to determine message order within a stream.<br>- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.<br>- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.<br>  - A single cluster payload can be multiplexed into multiple stream payloads.<br>  - To distinguish each stream payload, a `dedupCounter` is included.<br>  - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`.|
     |feed<br>`f` |OrderStateFeed|True|The Order State Feed|
     ??? info "[OrderStateFeed](/../../schemas/order_state_feed)"
         |Name<br>`Lite`|Type|Required<br>`Default`| Description |

artifacts/apidocs/schemas/ws_orderbook_levels_feed_data_v1.md

@@ -3,7 +3,7 @@
     |-|-|-|-|
     |stream<br>`s` |string|True|Stream name|
     |selector<br>`s1` |string|True|Primary selector|
-    |sequence_number<br>`sn` |string|True|A running sequence number that determines global message order within the specific stream|
+    |sequence_number<br>`sn` |string|True|A sequence number used to determine message order within a stream.<br>- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.<br>- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.<br>  - A single cluster payload can be multiplexed into multiple stream payloads.<br>  - To distinguish each stream payload, a `dedupCounter` is included.<br>  - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`.|
     |feed<br>`f` |OrderbookLevels|True|An orderbook levels object matching the request filter|
     ??? info "[OrderbookLevels](/../../schemas/orderbook_levels)"
         |Name<br>`Lite`|Type|Required<br>`Default`| Description |

artifacts/apidocs/schemas/ws_positions_feed_data_v1.md

@@ -3,7 +3,7 @@
     |-|-|-|-|
     |stream<br>`s` |string|True|Stream name|
     |selector<br>`s1` |string|True|Primary selector|
-    |sequence_number<br>`sn` |string|True|A running sequence number that determines global message order within the specific stream|
+    |sequence_number<br>`sn` |string|True|A sequence number used to determine message order within a stream.<br>- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.<br>- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.<br>  - A single cluster payload can be multiplexed into multiple stream payloads.<br>  - To distinguish each stream payload, a `dedupCounter` is included.<br>  - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`.|
     |feed<br>`f` |Positions|True|A Position being created or updated matching the request filter|
     ??? info "[Positions](/../../schemas/positions)"
         |Name<br>`Lite`|Type|Required<br>`Default`| Description |

artifacts/apidocs/schemas/ws_subscribe_params.md

@@ -1,5 +1,5 @@
 !!! info "[WSSubscribeParams](/../../schemas/ws_subscribe_params)"
-    All V1 Websocket Subscription Requests are housed in this wrapper. You may specify a stream, and a list of feeds to subscribe to.<br>When subscribing to the same primary selector again, the previous secondary selector will be replaced. See `Overview` page for more details.<br>
+    All V1 Websocket Subscription Requests are housed in this wrapper. You may specify a stream and a list of feeds to subscribe to.<br>When subscribing to the same primary selector again, the previous secondary selector will be replaced. See `Overview` page for more details.<br>Sequence numbers can be either gateway-specific or global:<br>- **Gateway Unique Sequence Number**: Increments by one per stream, resets to 0 on gateway restart.<br>- **Global Unique Sequence Number**: A cluster-wide unique number assigned to each cluster payload, does not reset on gateway restarts, and can be used to track and identify message order across streams using `sequence_number` and `prev_sequence_number` in the feed response.<br>Set `useGlobalSequenceNumber = true` if you need a persistent, unique identifier across all streams or ordering across multiple feeds.<br>
 
     |Name<br>`Lite`|Type|Required<br>`Default`| Description |
     |-|-|-|-|

artifacts/apidocs/schemas/ws_ticker_feed_data_v1.md

@@ -3,7 +3,7 @@
     |-|-|-|-|
     |stream<br>`s` |string|True|Stream name|
     |selector<br>`s1` |string|True|Primary selector|
-    |sequence_number<br>`sn` |string|True|A running sequence number that determines global message order within the specific stream|
+    |sequence_number<br>`sn` |string|True|A sequence number used to determine message order within a stream.<br>- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.<br>- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.<br>  - A single cluster payload can be multiplexed into multiple stream payloads.<br>  - To distinguish each stream payload, a `dedupCounter` is included.<br>  - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`.|
     |feed<br>`f` |Ticker|True|A ticker matching the request filter|
     ??? info "[Ticker](/../../schemas/ticker)"
         Derived data such as the below, will not be included by default:<br>  - 24 hour volume (`buyVolume + sellVolume`)<br>  - 24 hour taker buy/sell ratio (`buyVolume / sellVolume`)<br>  - 24 hour average trade price (`volumeQ / volumeU`)<br>  - 24 hour average trade volume (`volume / trades`)<br>  - 24 hour percentage change (`24hStatChange / 24hStat`)<br>  - 48 hour statistics (`2 * 24hStat - 24hStatChange`)<br><br>To query for an extended ticker payload, leverage the `greeks` and the `derived` flags.<br>Ticker extensions are currently under design to offer you more convenience.<br>These flags are only supported on the `Ticker Snapshot` WS endpoint, and on the `Ticker` API endpoint.<br><br>

artifacts/apidocs/schemas/ws_trade_feed_data_v1.md

@@ -3,7 +3,7 @@
     |-|-|-|-|
     |stream<br>`s` |string|True|Stream name|
     |selector<br>`s1` |string|True|Primary selector|
-    |sequence_number<br>`sn` |string|True|A running sequence number that determines global message order within the specific stream|
+    |sequence_number<br>`sn` |string|True|A sequence number used to determine message order within a stream.<br>- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.<br>- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.<br>  - A single cluster payload can be multiplexed into multiple stream payloads.<br>  - To distinguish each stream payload, a `dedupCounter` is included.<br>  - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`.|
     |feed<br>`f` |Trade|True|A public trade matching the request filter|
     ??? info "[Trade](/../../schemas/trade)"
         All private RFQs and Private AXEs will be filtered out from the responses<br>

artifacts/apidocs/schemas/ws_transfer_feed_data_v1.md

@@ -5,7 +5,7 @@
     |-|-|-|-|
     |stream<br>`s` |string|True|The websocket channel to which the response is sent|
     |selector<br>`s1` |string|True|Primary selector|
-    |sequence_number<br>`sn` |string|True|A running sequence number that determines global message order within the specific stream|
+    |sequence_number<br>`sn` |string|True|A sequence number used to determine message order within a stream.<br>- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.<br>- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.<br>  - A single cluster payload can be multiplexed into multiple stream payloads.<br>  - To distinguish each stream payload, a `dedupCounter` is included.<br>  - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`.|
     |feed<br>`f` |TransferHistory|True|The transfer history matching the requested filters|
     ??? info "[TransferHistory](/../../schemas/transfer_history)"
         |Name<br>`Lite`|Type|Required<br>`Default`| Description |