diff --git a/artifacts/apidocs/schemas/aggregated_account_summary.md b/artifacts/apidocs/schemas/aggregated_account_summary.md index 91f4a10..e2a1f5c 100644 --- a/artifacts/apidocs/schemas/aggregated_account_summary.md +++ b/artifacts/apidocs/schemas/aggregated_account_summary.md @@ -32,5 +32,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/api_aggregated_account_summary_response.md b/artifacts/apidocs/schemas/api_aggregated_account_summary_response.md index dbe4d6d..11d8c3d 100644 --- a/artifacts/apidocs/schemas/api_aggregated_account_summary_response.md +++ b/artifacts/apidocs/schemas/api_aggregated_account_summary_response.md @@ -38,5 +38,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/api_cancel_all_orders_request.md b/artifacts/apidocs/schemas/api_cancel_all_orders_request.md index 7792003..34a70e6 100644 --- a/artifacts/apidocs/schemas/api_cancel_all_orders_request.md +++ b/artifacts/apidocs/schemas/api_cancel_all_orders_request.md @@ -38,8 +38,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Currency](/../../schemas/currency)" The list of Currencies that are supported on the GRVT exchange
@@ -62,5 +69,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/api_cancel_order_response.md b/artifacts/apidocs/schemas/api_cancel_order_response.md index 907c62b..5de6e3e 100644 --- a/artifacts/apidocs/schemas/api_cancel_order_response.md +++ b/artifacts/apidocs/schemas/api_cancel_order_response.md @@ -53,7 +53,7 @@ |-|-|-|-| |client_order_id
`co` |string|True|A unique identifier for the active order within a subaccount, specified by the client
This is used to identify the order in the client's system
This field can be used for order amendment/cancellation, but has no bearing on the smart contract layer
This field will not be propagated to the smart contract, and should not be signed by the client
This value must be unique for all active orders in a subaccount, or amendment/cancellation will not work as expected
Gravity UI will generate a random clientOrderID for each order in the range [0, 2^63 - 1]
To prevent any conflicts, client machines should generate a random clientOrderID in the range [2^63, 2^64 - 1]

When GRVT Backend receives an order with an overlapping clientOrderID, we will reject the order with rejectReason set to overlappingClientOrderId| |create_time
`ct` |string|False
`0`|[Filled by GRVT Backend] Time at which the order was received by GRVT in unix nanoseconds| - |trigger
`t` |TriggerOrderMetadata|True|Trigger fields are used to support any type of trigger order such as TP/SL| + |trigger
`t` |TriggerOrderMetadata|False
``|Trigger fields are used to support any type of trigger order such as TP/SL| |broker
`b` |BrokerTag|False
``|Specifies the broker who brokered the order| ??? info "[TriggerOrderMetadata](/../../schemas/trigger_order_metadata)" Contains metadata related to trigger orders, such as Take Profit (TP) or Stop Loss (SL).

Trigger orders are used to automatically execute an order when a predefined price condition is met, allowing traders to implement risk management strategies.


diff --git a/artifacts/apidocs/schemas/api_create_bulk_orders_request.md b/artifacts/apidocs/schemas/api_create_bulk_orders_request.md index 27c45a7..b0068e9 100644 --- a/artifacts/apidocs/schemas/api_create_bulk_orders_request.md +++ b/artifacts/apidocs/schemas/api_create_bulk_orders_request.md @@ -55,7 +55,7 @@ |-|-|-|-| |client_order_id
`co` |string|True|A unique identifier for the active order within a subaccount, specified by the client
This is used to identify the order in the client's system
This field can be used for order amendment/cancellation, but has no bearing on the smart contract layer
This field will not be propagated to the smart contract, and should not be signed by the client
This value must be unique for all active orders in a subaccount, or amendment/cancellation will not work as expected
Gravity UI will generate a random clientOrderID for each order in the range [0, 2^63 - 1]
To prevent any conflicts, client machines should generate a random clientOrderID in the range [2^63, 2^64 - 1]

When GRVT Backend receives an order with an overlapping clientOrderID, we will reject the order with rejectReason set to overlappingClientOrderId| |create_time
`ct` |string|False
`0`|[Filled by GRVT Backend] Time at which the order was received by GRVT in unix nanoseconds| - |trigger
`t` |TriggerOrderMetadata|True|Trigger fields are used to support any type of trigger order such as TP/SL| + |trigger
`t` |TriggerOrderMetadata|False
``|Trigger fields are used to support any type of trigger order such as TP/SL| |broker
`b` |BrokerTag|False
``|Specifies the broker who brokered the order| ??? info "[TriggerOrderMetadata](/../../schemas/trigger_order_metadata)" Contains metadata related to trigger orders, such as Take Profit (TP) or Stop Loss (SL).

Trigger orders are used to automatically execute an order when a predefined price condition is met, allowing traders to implement risk management strategies.


diff --git a/artifacts/apidocs/schemas/api_create_bulk_orders_response.md b/artifacts/apidocs/schemas/api_create_bulk_orders_response.md index 92826a1..64b7666 100644 --- a/artifacts/apidocs/schemas/api_create_bulk_orders_response.md +++ b/artifacts/apidocs/schemas/api_create_bulk_orders_response.md @@ -53,7 +53,7 @@ |-|-|-|-| |client_order_id
`co` |string|True|A unique identifier for the active order within a subaccount, specified by the client
This is used to identify the order in the client's system
This field can be used for order amendment/cancellation, but has no bearing on the smart contract layer
This field will not be propagated to the smart contract, and should not be signed by the client
This value must be unique for all active orders in a subaccount, or amendment/cancellation will not work as expected
Gravity UI will generate a random clientOrderID for each order in the range [0, 2^63 - 1]
To prevent any conflicts, client machines should generate a random clientOrderID in the range [2^63, 2^64 - 1]

When GRVT Backend receives an order with an overlapping clientOrderID, we will reject the order with rejectReason set to overlappingClientOrderId| |create_time
`ct` |string|False
`0`|[Filled by GRVT Backend] Time at which the order was received by GRVT in unix nanoseconds| - |trigger
`t` |TriggerOrderMetadata|True|Trigger fields are used to support any type of trigger order such as TP/SL| + |trigger
`t` |TriggerOrderMetadata|False
``|Trigger fields are used to support any type of trigger order such as TP/SL| |broker
`b` |BrokerTag|False
``|Specifies the broker who brokered the order| ??? info "[TriggerOrderMetadata](/../../schemas/trigger_order_metadata)" Contains metadata related to trigger orders, such as Take Profit (TP) or Stop Loss (SL).

Trigger orders are used to automatically execute an order when a predefined price condition is met, allowing traders to implement risk management strategies.


diff --git a/artifacts/apidocs/schemas/api_create_order_request.md b/artifacts/apidocs/schemas/api_create_order_request.md index d64700e..b31f672 100644 --- a/artifacts/apidocs/schemas/api_create_order_request.md +++ b/artifacts/apidocs/schemas/api_create_order_request.md @@ -55,7 +55,7 @@ |-|-|-|-| |client_order_id
`co` |string|True|A unique identifier for the active order within a subaccount, specified by the client
This is used to identify the order in the client's system
This field can be used for order amendment/cancellation, but has no bearing on the smart contract layer
This field will not be propagated to the smart contract, and should not be signed by the client
This value must be unique for all active orders in a subaccount, or amendment/cancellation will not work as expected
Gravity UI will generate a random clientOrderID for each order in the range [0, 2^63 - 1]
To prevent any conflicts, client machines should generate a random clientOrderID in the range [2^63, 2^64 - 1]

When GRVT Backend receives an order with an overlapping clientOrderID, we will reject the order with rejectReason set to overlappingClientOrderId| |create_time
`ct` |string|False
`0`|[Filled by GRVT Backend] Time at which the order was received by GRVT in unix nanoseconds| - |trigger
`t` |TriggerOrderMetadata|True|Trigger fields are used to support any type of trigger order such as TP/SL| + |trigger
`t` |TriggerOrderMetadata|False
``|Trigger fields are used to support any type of trigger order such as TP/SL| |broker
`b` |BrokerTag|False
``|Specifies the broker who brokered the order| ??? info "[TriggerOrderMetadata](/../../schemas/trigger_order_metadata)" Contains metadata related to trigger orders, such as Take Profit (TP) or Stop Loss (SL).

Trigger orders are used to automatically execute an order when a predefined price condition is met, allowing traders to implement risk management strategies.


diff --git a/artifacts/apidocs/schemas/api_create_order_response.md b/artifacts/apidocs/schemas/api_create_order_response.md index cf3ecf8..77d22fe 100644 --- a/artifacts/apidocs/schemas/api_create_order_response.md +++ b/artifacts/apidocs/schemas/api_create_order_response.md @@ -53,7 +53,7 @@ |-|-|-|-| |client_order_id
`co` |string|True|A unique identifier for the active order within a subaccount, specified by the client
This is used to identify the order in the client's system
This field can be used for order amendment/cancellation, but has no bearing on the smart contract layer
This field will not be propagated to the smart contract, and should not be signed by the client
This value must be unique for all active orders in a subaccount, or amendment/cancellation will not work as expected
Gravity UI will generate a random clientOrderID for each order in the range [0, 2^63 - 1]
To prevent any conflicts, client machines should generate a random clientOrderID in the range [2^63, 2^64 - 1]

When GRVT Backend receives an order with an overlapping clientOrderID, we will reject the order with rejectReason set to overlappingClientOrderId| |create_time
`ct` |string|False
`0`|[Filled by GRVT Backend] Time at which the order was received by GRVT in unix nanoseconds| - |trigger
`t` |TriggerOrderMetadata|True|Trigger fields are used to support any type of trigger order such as TP/SL| + |trigger
`t` |TriggerOrderMetadata|False
``|Trigger fields are used to support any type of trigger order such as TP/SL| |broker
`b` |BrokerTag|False
``|Specifies the broker who brokered the order| ??? info "[TriggerOrderMetadata](/../../schemas/trigger_order_metadata)" Contains metadata related to trigger orders, such as Take Profit (TP) or Stop Loss (SL).

Trigger orders are used to automatically execute an order when a predefined price condition is met, allowing traders to implement risk management strategies.


diff --git a/artifacts/apidocs/schemas/api_deposit_history_request.md b/artifacts/apidocs/schemas/api_deposit_history_request.md index 8dd39d9..0758a4d 100644 --- a/artifacts/apidocs/schemas/api_deposit_history_request.md +++ b/artifacts/apidocs/schemas/api_deposit_history_request.md @@ -8,6 +8,7 @@ |end_time
`et` |string|False
`now()`|The end time to query for in unix nanoseconds| |limit
`l` |integer|False
`500`|The limit to query for. Defaults to 500; Max 1000| |cursor
`c1` |string|False
`''`|The cursor to indicate when to start the next query from| + |main_account_id
`ma` |string|False
``|Main account ID being queried. By default, applies the requestor's main account ID.| ??? info "[Currency](/../../schemas/currency)" The list of Currencies that are supported on the GRVT exchange
@@ -30,5 +31,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/api_deposit_history_response.md b/artifacts/apidocs/schemas/api_deposit_history_response.md index b1e6a7e..0073f5a 100644 --- a/artifacts/apidocs/schemas/api_deposit_history_response.md +++ b/artifacts/apidocs/schemas/api_deposit_history_response.md @@ -36,5 +36,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/api_drop_client_ws_request.md b/artifacts/apidocs/schemas/api_drop_client_ws_request.md new file mode 100644 index 0000000..4fdfe35 --- /dev/null +++ b/artifacts/apidocs/schemas/api_drop_client_ws_request.md @@ -0,0 +1,4 @@ +!!! info "[ApiDropClientWsRequest](/../../schemas/api_drop_client_ws_request)" + |Name
`Lite`|Type|Required
`Default`| Description | + |-|-|-|-| + |main_account_id
`ma` |string|True|| diff --git a/artifacts/apidocs/schemas/api_drop_client_ws_response.md b/artifacts/apidocs/schemas/api_drop_client_ws_response.md new file mode 100644 index 0000000..8e7b4b5 --- /dev/null +++ b/artifacts/apidocs/schemas/api_drop_client_ws_response.md @@ -0,0 +1,4 @@ +!!! info "[ApiDropClientWsResponse](/../../schemas/api_drop_client_ws_response)" + |Name
`Lite`|Type|Required
`Default`| Description | + |-|-|-|-| + |num_dropped
`nd` |integer|True|| diff --git a/artifacts/apidocs/schemas/api_fill_history_request.md b/artifacts/apidocs/schemas/api_fill_history_request.md index bfb6b4e..57ebd43 100644 --- a/artifacts/apidocs/schemas/api_fill_history_request.md +++ b/artifacts/apidocs/schemas/api_fill_history_request.md @@ -42,8 +42,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Currency](/../../schemas/currency)" The list of Currencies that are supported on the GRVT exchange
@@ -66,5 +73,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/api_funding_account_summary_response.md b/artifacts/apidocs/schemas/api_funding_account_summary_response.md index 6fff816..8ec97c1 100644 --- a/artifacts/apidocs/schemas/api_funding_account_summary_response.md +++ b/artifacts/apidocs/schemas/api_funding_account_summary_response.md @@ -40,5 +40,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/api_funding_payment_history_response.md b/artifacts/apidocs/schemas/api_funding_payment_history_response.md index 00b1fa8..aba3976 100644 --- a/artifacts/apidocs/schemas/api_funding_payment_history_response.md +++ b/artifacts/apidocs/schemas/api_funding_payment_history_response.md @@ -34,5 +34,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/api_get_all_instruments_response.md b/artifacts/apidocs/schemas/api_get_all_instruments_response.md index 194a032..78cb95f 100644 --- a/artifacts/apidocs/schemas/api_get_all_instruments_response.md +++ b/artifacts/apidocs/schemas/api_get_all_instruments_response.md @@ -40,8 +40,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Currency](/../../schemas/currency)" The list of Currencies that are supported on the GRVT exchange
@@ -64,8 +71,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Kind](/../../schemas/kind)" The list of asset kinds that are supported on the GRVT exchange
diff --git a/artifacts/apidocs/schemas/api_get_ecosystem_leaderboard_response.md b/artifacts/apidocs/schemas/api_get_ecosystem_leaderboard_response.md index 670d5f9..32f12c8 100644 --- a/artifacts/apidocs/schemas/api_get_ecosystem_leaderboard_response.md +++ b/artifacts/apidocs/schemas/api_get_ecosystem_leaderboard_response.md @@ -20,3 +20,6 @@ |rank
`r` |integer|True|The rank of the account in the ecosystem| |epoch
`e` |integer|True|The epoch number of the ecosystem point| |brokered_trading_volume
`bt` |string|True|Brokered trading volume| + |brokered_trading_point
`bt1` |string|True|Brokered trading point| + |referee_kyc_point
`rk` |string|True|Referee KYC point| + |referrer_kyc_point
`rk1` |string|True|Referrer KYC point| diff --git a/artifacts/apidocs/schemas/api_get_filtered_instruments_request.md b/artifacts/apidocs/schemas/api_get_filtered_instruments_request.md index 91afdfb..bc108c7 100644 --- a/artifacts/apidocs/schemas/api_get_filtered_instruments_request.md +++ b/artifacts/apidocs/schemas/api_get_filtered_instruments_request.md @@ -39,8 +39,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Currency](/../../schemas/currency)" The list of Currencies that are supported on the GRVT exchange
@@ -63,5 +70,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/api_get_filtered_instruments_response.md b/artifacts/apidocs/schemas/api_get_filtered_instruments_response.md index 00eb893..906378d 100644 --- a/artifacts/apidocs/schemas/api_get_filtered_instruments_response.md +++ b/artifacts/apidocs/schemas/api_get_filtered_instruments_response.md @@ -40,8 +40,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Currency](/../../schemas/currency)" The list of Currencies that are supported on the GRVT exchange
@@ -64,8 +71,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Kind](/../../schemas/kind)" The list of asset kinds that are supported on the GRVT exchange
diff --git a/artifacts/apidocs/schemas/api_get_instrument_response.md b/artifacts/apidocs/schemas/api_get_instrument_response.md index c345b82..6217afa 100644 --- a/artifacts/apidocs/schemas/api_get_instrument_response.md +++ b/artifacts/apidocs/schemas/api_get_instrument_response.md @@ -40,8 +40,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Currency](/../../schemas/currency)" The list of Currencies that are supported on the GRVT exchange
@@ -64,8 +71,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Kind](/../../schemas/kind)" The list of asset kinds that are supported on the GRVT exchange
diff --git a/artifacts/apidocs/schemas/api_get_latest_lp_snapshot_request.md b/artifacts/apidocs/schemas/api_get_latest_lp_snapshot_request.md index d60c753..7862abb 100644 --- a/artifacts/apidocs/schemas/api_get_latest_lp_snapshot_request.md +++ b/artifacts/apidocs/schemas/api_get_latest_lp_snapshot_request.md @@ -34,5 +34,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/api_get_list_flat_referral_response.md b/artifacts/apidocs/schemas/api_get_list_flat_referral_response.md index 01d3d78..a8a914d 100644 --- a/artifacts/apidocs/schemas/api_get_list_flat_referral_response.md +++ b/artifacts/apidocs/schemas/api_get_list_flat_referral_response.md @@ -17,3 +17,4 @@ |is_kyc_completed
`ik` |boolean|True|The account is KYC verified or not| |kyc_completed_at
`kc` |string|True|The KYC completed time| |kyc_type
`kt` |string|True|The KYC type, can be 'individual' or 'business'| + |kyc_first_completed_at
`kf` |string|True|The first KYC completed time| diff --git a/artifacts/apidocs/schemas/api_get_lp_info_request.md b/artifacts/apidocs/schemas/api_get_lp_info_request.md index 3b014c4..5766137 100644 --- a/artifacts/apidocs/schemas/api_get_lp_info_request.md +++ b/artifacts/apidocs/schemas/api_get_lp_info_request.md @@ -34,5 +34,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/api_get_lp_leaderboard_request.md b/artifacts/apidocs/schemas/api_get_lp_leaderboard_request.md index a3f1c78..9d59aa7 100644 --- a/artifacts/apidocs/schemas/api_get_lp_leaderboard_request.md +++ b/artifacts/apidocs/schemas/api_get_lp_leaderboard_request.md @@ -36,5 +36,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/api_get_lp_point_request.md b/artifacts/apidocs/schemas/api_get_lp_point_request.md index 54116b6..03b57d7 100644 --- a/artifacts/apidocs/schemas/api_get_lp_point_request.md +++ b/artifacts/apidocs/schemas/api_get_lp_point_request.md @@ -35,5 +35,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/api_get_margin_tiers_response.md b/artifacts/apidocs/schemas/api_get_margin_tiers_response.md new file mode 100644 index 0000000..636c01e --- /dev/null +++ b/artifacts/apidocs/schemas/api_get_margin_tiers_response.md @@ -0,0 +1,14 @@ +!!! info "[ApiGetMarginTiersResponse](/../../schemas/api_get_margin_tiers_response)" + |Name
`Lite`|Type|Required
`Default`| Description | + |-|-|-|-| + |results
`r` |[AssetMarginTierResponse]|True|| + ??? info "[AssetMarginTierResponse](/../../schemas/asset_margin_tier_response)" + |Name
`Lite`|Type|Required
`Default`| Description | + |-|-|-|-| + |asset
`a` |string|True|| + |tiers
`t` |[MarginTierResponse]|True|| + ??? info "[MarginTierResponse](/../../schemas/margin_tier_response)" + |Name
`Lite`|Type|Required
`Default`| Description | + |-|-|-|-| + |lower_bound
`lb` |string|True|| + |rate
`r` |string|True|| diff --git a/artifacts/apidocs/schemas/api_get_order_response.md b/artifacts/apidocs/schemas/api_get_order_response.md index 1b2a078..8a2f97b 100644 --- a/artifacts/apidocs/schemas/api_get_order_response.md +++ b/artifacts/apidocs/schemas/api_get_order_response.md @@ -53,7 +53,7 @@ |-|-|-|-| |client_order_id
`co` |string|True|A unique identifier for the active order within a subaccount, specified by the client
This is used to identify the order in the client's system
This field can be used for order amendment/cancellation, but has no bearing on the smart contract layer
This field will not be propagated to the smart contract, and should not be signed by the client
This value must be unique for all active orders in a subaccount, or amendment/cancellation will not work as expected
Gravity UI will generate a random clientOrderID for each order in the range [0, 2^63 - 1]
To prevent any conflicts, client machines should generate a random clientOrderID in the range [2^63, 2^64 - 1]

When GRVT Backend receives an order with an overlapping clientOrderID, we will reject the order with rejectReason set to overlappingClientOrderId| |create_time
`ct` |string|False
`0`|[Filled by GRVT Backend] Time at which the order was received by GRVT in unix nanoseconds| - |trigger
`t` |TriggerOrderMetadata|True|Trigger fields are used to support any type of trigger order such as TP/SL| + |trigger
`t` |TriggerOrderMetadata|False
``|Trigger fields are used to support any type of trigger order such as TP/SL| |broker
`b` |BrokerTag|False
``|Specifies the broker who brokered the order| ??? info "[TriggerOrderMetadata](/../../schemas/trigger_order_metadata)" Contains metadata related to trigger orders, such as Take Profit (TP) or Stop Loss (SL).

Trigger orders are used to automatically execute an order when a predefined price condition is met, allowing traders to implement risk management strategies.


diff --git a/artifacts/apidocs/schemas/api_get_user_ecosystem_point_response.md b/artifacts/apidocs/schemas/api_get_user_ecosystem_point_response.md index 7261f56..69dc27e 100644 --- a/artifacts/apidocs/schemas/api_get_user_ecosystem_point_response.md +++ b/artifacts/apidocs/schemas/api_get_user_ecosystem_point_response.md @@ -20,3 +20,6 @@ |rank
`r` |integer|True|The rank of the account in the ecosystem| |epoch
`e` |integer|True|The epoch number of the ecosystem point| |brokered_trading_volume
`bt` |string|True|Brokered trading volume| + |brokered_trading_point
`bt1` |string|True|Brokered trading point| + |referee_kyc_point
`rk` |string|True|Referee KYC point| + |referrer_kyc_point
`rk1` |string|True|Referrer KYC point| diff --git a/artifacts/apidocs/schemas/api_latest_snap_sub_accounts_response.md b/artifacts/apidocs/schemas/api_latest_snap_sub_accounts_response.md index 735ee64..73f63ea 100644 --- a/artifacts/apidocs/schemas/api_latest_snap_sub_accounts_response.md +++ b/artifacts/apidocs/schemas/api_latest_snap_sub_accounts_response.md @@ -44,8 +44,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[SpotBalance](/../../schemas/spot_balance)" |Name
`Lite`|Type|Required
`Default`| Description | |-|-|-|-| @@ -74,8 +81,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Positions](/../../schemas/positions)" |Name
`Lite`|Type|Required
`Default`| Description | |-|-|-|-| diff --git a/artifacts/apidocs/schemas/api_list_aggregated_account_summary_response.md b/artifacts/apidocs/schemas/api_list_aggregated_account_summary_response.md index f05992f..3b09a9d 100644 --- a/artifacts/apidocs/schemas/api_list_aggregated_account_summary_response.md +++ b/artifacts/apidocs/schemas/api_list_aggregated_account_summary_response.md @@ -42,5 +42,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/api_open_orders_request.md b/artifacts/apidocs/schemas/api_open_orders_request.md index 0e76b77..282af89 100644 --- a/artifacts/apidocs/schemas/api_open_orders_request.md +++ b/artifacts/apidocs/schemas/api_open_orders_request.md @@ -36,8 +36,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Currency](/../../schemas/currency)" The list of Currencies that are supported on the GRVT exchange
@@ -60,5 +67,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/api_open_orders_response.md b/artifacts/apidocs/schemas/api_open_orders_response.md index 6c6e5e0..4655df8 100644 --- a/artifacts/apidocs/schemas/api_open_orders_response.md +++ b/artifacts/apidocs/schemas/api_open_orders_response.md @@ -55,7 +55,7 @@ |-|-|-|-| |client_order_id
`co` |string|True|A unique identifier for the active order within a subaccount, specified by the client
This is used to identify the order in the client's system
This field can be used for order amendment/cancellation, but has no bearing on the smart contract layer
This field will not be propagated to the smart contract, and should not be signed by the client
This value must be unique for all active orders in a subaccount, or amendment/cancellation will not work as expected
Gravity UI will generate a random clientOrderID for each order in the range [0, 2^63 - 1]
To prevent any conflicts, client machines should generate a random clientOrderID in the range [2^63, 2^64 - 1]

When GRVT Backend receives an order with an overlapping clientOrderID, we will reject the order with rejectReason set to overlappingClientOrderId| |create_time
`ct` |string|False
`0`|[Filled by GRVT Backend] Time at which the order was received by GRVT in unix nanoseconds| - |trigger
`t` |TriggerOrderMetadata|True|Trigger fields are used to support any type of trigger order such as TP/SL| + |trigger
`t` |TriggerOrderMetadata|False
``|Trigger fields are used to support any type of trigger order such as TP/SL| |broker
`b` |BrokerTag|False
``|Specifies the broker who brokered the order| ??? info "[TriggerOrderMetadata](/../../schemas/trigger_order_metadata)" Contains metadata related to trigger orders, such as Take Profit (TP) or Stop Loss (SL).

Trigger orders are used to automatically execute an order when a predefined price condition is met, allowing traders to implement risk management strategies.


diff --git a/artifacts/apidocs/schemas/api_order_history_request.md b/artifacts/apidocs/schemas/api_order_history_request.md index 8a47eb5..3c38deb 100644 --- a/artifacts/apidocs/schemas/api_order_history_request.md +++ b/artifacts/apidocs/schemas/api_order_history_request.md @@ -42,8 +42,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Currency](/../../schemas/currency)" The list of Currencies that are supported on the GRVT exchange
@@ -66,5 +73,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/api_order_history_response.md b/artifacts/apidocs/schemas/api_order_history_response.md index 261e27f..10f951d 100644 --- a/artifacts/apidocs/schemas/api_order_history_response.md +++ b/artifacts/apidocs/schemas/api_order_history_response.md @@ -54,7 +54,7 @@ |-|-|-|-| |client_order_id
`co` |string|True|A unique identifier for the active order within a subaccount, specified by the client
This is used to identify the order in the client's system
This field can be used for order amendment/cancellation, but has no bearing on the smart contract layer
This field will not be propagated to the smart contract, and should not be signed by the client
This value must be unique for all active orders in a subaccount, or amendment/cancellation will not work as expected
Gravity UI will generate a random clientOrderID for each order in the range [0, 2^63 - 1]
To prevent any conflicts, client machines should generate a random clientOrderID in the range [2^63, 2^64 - 1]

When GRVT Backend receives an order with an overlapping clientOrderID, we will reject the order with rejectReason set to overlappingClientOrderId| |create_time
`ct` |string|False
`0`|[Filled by GRVT Backend] Time at which the order was received by GRVT in unix nanoseconds| - |trigger
`t` |TriggerOrderMetadata|True|Trigger fields are used to support any type of trigger order such as TP/SL| + |trigger
`t` |TriggerOrderMetadata|False
``|Trigger fields are used to support any type of trigger order such as TP/SL| |broker
`b` |BrokerTag|False
``|Specifies the broker who brokered the order| ??? info "[TriggerOrderMetadata](/../../schemas/trigger_order_metadata)" Contains metadata related to trigger orders, such as Take Profit (TP) or Stop Loss (SL).

Trigger orders are used to automatically execute an order when a predefined price condition is met, allowing traders to implement risk management strategies.


diff --git a/artifacts/apidocs/schemas/api_positions_request.md b/artifacts/apidocs/schemas/api_positions_request.md index 1aa7fdb..2e20a3a 100644 --- a/artifacts/apidocs/schemas/api_positions_request.md +++ b/artifacts/apidocs/schemas/api_positions_request.md @@ -38,8 +38,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Currency](/../../schemas/currency)" The list of Currencies that are supported on the GRVT exchange
@@ -62,5 +69,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/api_pre_deposit_check_request.md b/artifacts/apidocs/schemas/api_pre_deposit_check_request.md index 0cb5a85..9b8471a 100644 --- a/artifacts/apidocs/schemas/api_pre_deposit_check_request.md +++ b/artifacts/apidocs/schemas/api_pre_deposit_check_request.md @@ -27,8 +27,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[BridgeType](/../../schemas/bridge_type)" |Value| Description | |-|-| diff --git a/artifacts/apidocs/schemas/api_pre_deposit_check_response.md b/artifacts/apidocs/schemas/api_pre_deposit_check_response.md index 1d679ce..5777522 100644 --- a/artifacts/apidocs/schemas/api_pre_deposit_check_response.md +++ b/artifacts/apidocs/schemas/api_pre_deposit_check_response.md @@ -25,5 +25,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/api_pre_order_check_request.md b/artifacts/apidocs/schemas/api_pre_order_check_request.md index e7bf320..48c8e75 100644 --- a/artifacts/apidocs/schemas/api_pre_order_check_request.md +++ b/artifacts/apidocs/schemas/api_pre_order_check_request.md @@ -56,7 +56,7 @@ |-|-|-|-| |client_order_id
`co` |string|True|A unique identifier for the active order within a subaccount, specified by the client
This is used to identify the order in the client's system
This field can be used for order amendment/cancellation, but has no bearing on the smart contract layer
This field will not be propagated to the smart contract, and should not be signed by the client
This value must be unique for all active orders in a subaccount, or amendment/cancellation will not work as expected
Gravity UI will generate a random clientOrderID for each order in the range [0, 2^63 - 1]
To prevent any conflicts, client machines should generate a random clientOrderID in the range [2^63, 2^64 - 1]

When GRVT Backend receives an order with an overlapping clientOrderID, we will reject the order with rejectReason set to overlappingClientOrderId| |create_time
`ct` |string|False
`0`|[Filled by GRVT Backend] Time at which the order was received by GRVT in unix nanoseconds| - |trigger
`t` |TriggerOrderMetadata|True|Trigger fields are used to support any type of trigger order such as TP/SL| + |trigger
`t` |TriggerOrderMetadata|False
``|Trigger fields are used to support any type of trigger order such as TP/SL| |broker
`b` |BrokerTag|False
``|Specifies the broker who brokered the order| ??? info "[TriggerOrderMetadata](/../../schemas/trigger_order_metadata)" Contains metadata related to trigger orders, such as Take Profit (TP) or Stop Loss (SL).

Trigger orders are used to automatically execute an order when a predefined price condition is met, allowing traders to implement risk management strategies.


diff --git a/artifacts/apidocs/schemas/api_pre_order_check_response.md b/artifacts/apidocs/schemas/api_pre_order_check_response.md index 5a56900..b4afa37 100644 --- a/artifacts/apidocs/schemas/api_pre_order_check_response.md +++ b/artifacts/apidocs/schemas/api_pre_order_check_response.md @@ -38,5 +38,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/api_query_trading_performance_request.md b/artifacts/apidocs/schemas/api_query_trading_performance_request.md new file mode 100644 index 0000000..33a192f --- /dev/null +++ b/artifacts/apidocs/schemas/api_query_trading_performance_request.md @@ -0,0 +1,7 @@ +!!! info "[ApiQueryTradingPerformanceRequest](/../../schemas/api_query_trading_performance_request)" + Request to retrieve the trading volume
+ + |Name
`Lite`|Type|Required
`Default`| Description | + |-|-|-|-| + |sub_account_id
`sa` |string|False
`all`|Optional: The subaccount ID to filter by| + |asset
`a` |unknown|True|The asset to filter by| diff --git a/artifacts/apidocs/schemas/api_query_trading_performance_response.md b/artifacts/apidocs/schemas/api_query_trading_performance_response.md new file mode 100644 index 0000000..7facd67 --- /dev/null +++ b/artifacts/apidocs/schemas/api_query_trading_performance_response.md @@ -0,0 +1,7 @@ +!!! info "[ApiQueryTradingPerformanceResponse](/../../schemas/api_query_trading_performance_response)" + Response to retrieve the trading volume
+ + |Name
`Lite`|Type|Required
`Default`| Description | + |-|-|-|-| + |trading_volume
`tv` |string|True|Trading volume in USDT| + |realized_pnl
`rp` |string|True|Realized PnL in USDT| diff --git a/artifacts/apidocs/schemas/api_settlement_price.md b/artifacts/apidocs/schemas/api_settlement_price.md index 60e0300..d71e4de 100644 --- a/artifacts/apidocs/schemas/api_settlement_price.md +++ b/artifacts/apidocs/schemas/api_settlement_price.md @@ -27,8 +27,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Currency](/../../schemas/currency)" The list of Currencies that are supported on the GRVT exchange
@@ -51,5 +58,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/api_settlement_price_request.md b/artifacts/apidocs/schemas/api_settlement_price_request.md index 9be5b8e..22a7633 100644 --- a/artifacts/apidocs/schemas/api_settlement_price_request.md +++ b/artifacts/apidocs/schemas/api_settlement_price_request.md @@ -31,8 +31,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Currency](/../../schemas/currency)" The list of Currencies that are supported on the GRVT exchange
@@ -55,5 +62,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/api_settlement_price_response.md b/artifacts/apidocs/schemas/api_settlement_price_response.md index 04990a9..f1628b9 100644 --- a/artifacts/apidocs/schemas/api_settlement_price_response.md +++ b/artifacts/apidocs/schemas/api_settlement_price_response.md @@ -32,8 +32,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Currency](/../../schemas/currency)" The list of Currencies that are supported on the GRVT exchange
@@ -56,5 +63,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/api_sub_account_history_response.md b/artifacts/apidocs/schemas/api_sub_account_history_response.md index 95bad3a..b2bf5c3 100644 --- a/artifacts/apidocs/schemas/api_sub_account_history_response.md +++ b/artifacts/apidocs/schemas/api_sub_account_history_response.md @@ -45,8 +45,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[SpotBalance](/../../schemas/spot_balance)" |Name
`Lite`|Type|Required
`Default`| Description | |-|-|-|-| @@ -75,8 +82,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Positions](/../../schemas/positions)" |Name
`Lite`|Type|Required
`Default`| Description | |-|-|-|-| diff --git a/artifacts/apidocs/schemas/api_sub_account_summary_response.md b/artifacts/apidocs/schemas/api_sub_account_summary_response.md index 042a944..978eda2 100644 --- a/artifacts/apidocs/schemas/api_sub_account_summary_response.md +++ b/artifacts/apidocs/schemas/api_sub_account_summary_response.md @@ -46,8 +46,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[SpotBalance](/../../schemas/spot_balance)" |Name
`Lite`|Type|Required
`Default`| Description | |-|-|-|-| @@ -76,8 +83,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Positions](/../../schemas/positions)" |Name
`Lite`|Type|Required
`Default`| Description | |-|-|-|-| diff --git a/artifacts/apidocs/schemas/api_sub_account_trade_aggregation_request.md b/artifacts/apidocs/schemas/api_sub_account_trade_aggregation_request.md index 5067d4d..e627924 100644 --- a/artifacts/apidocs/schemas/api_sub_account_trade_aggregation_request.md +++ b/artifacts/apidocs/schemas/api_sub_account_trade_aggregation_request.md @@ -19,3 +19,4 @@ |`SAT_1_MO` = 1|1 month| |`SAT_1_D` = 2|1 day| |`SAT_1_H` = 3|1 hour| + |`SAT_4_H` = 4|4 hour| diff --git a/artifacts/apidocs/schemas/api_sub_account_trade_aggregation_response.md b/artifacts/apidocs/schemas/api_sub_account_trade_aggregation_response.md index bcf19f4..afda476 100644 --- a/artifacts/apidocs/schemas/api_sub_account_trade_aggregation_response.md +++ b/artifacts/apidocs/schemas/api_sub_account_trade_aggregation_response.md @@ -14,3 +14,4 @@ |num_traded
`nt` |string|True|Number of trades| |positive_fee
`pf` |string|True|Total positive fee paid by user| |signer
`s` |string|True|The signer of the trade| + |realized_pnl
`rp` |string|True|Realized PnL| diff --git a/artifacts/apidocs/schemas/api_transfer_history_request.md b/artifacts/apidocs/schemas/api_transfer_history_request.md index c1fc682..7e5764d 100644 --- a/artifacts/apidocs/schemas/api_transfer_history_request.md +++ b/artifacts/apidocs/schemas/api_transfer_history_request.md @@ -9,6 +9,7 @@ |limit
`l` |integer|False
`500`|The limit to query for. Defaults to 500; Max 1000| |cursor
`c1` |string|False
`''`|The cursor to indicate when to start the next query from| |tx_id
`ti` |string|False
`0`|The transaction ID to query for| + |main_account_id
`ma` |string|False
``|Main account ID being queried. By default, applies the requestor's main account ID.| ??? info "[Currency](/../../schemas/currency)" The list of Currencies that are supported on the GRVT exchange
@@ -31,5 +32,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/api_transfer_history_response.md b/artifacts/apidocs/schemas/api_transfer_history_response.md index 0b2e6c0..cbdac79 100644 --- a/artifacts/apidocs/schemas/api_transfer_history_response.md +++ b/artifacts/apidocs/schemas/api_transfer_history_response.md @@ -39,8 +39,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Signature](/../../schemas/signature)" |Name
`Lite`|Type|Required
`Default`| Description | |-|-|-|-| diff --git a/artifacts/apidocs/schemas/api_transfer_request.md b/artifacts/apidocs/schemas/api_transfer_request.md index 3b125bf..836d0f6 100644 --- a/artifacts/apidocs/schemas/api_transfer_request.md +++ b/artifacts/apidocs/schemas/api_transfer_request.md @@ -34,8 +34,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Signature](/../../schemas/signature)" |Name
`Lite`|Type|Required
`Default`| Description | |-|-|-|-| diff --git a/artifacts/apidocs/schemas/api_withdrawal_history_request.md b/artifacts/apidocs/schemas/api_withdrawal_history_request.md index 30005f0..549928f 100644 --- a/artifacts/apidocs/schemas/api_withdrawal_history_request.md +++ b/artifacts/apidocs/schemas/api_withdrawal_history_request.md @@ -8,6 +8,7 @@ |end_time
`et` |string|False
`now()`|The end time to query for in unix nanoseconds| |limit
`l` |integer|False
`500`|The limit to query for. Defaults to 500; Max 1000| |cursor
`c1` |string|False
`''`|The cursor to indicate when to start the next query from| + |main_account_id
`ma` |string|False
``|Main account ID being queried. By default, applies the requestor's main account ID.| ??? info "[Currency](/../../schemas/currency)" The list of Currencies that are supported on the GRVT exchange
@@ -30,5 +31,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/api_withdrawal_history_response.md b/artifacts/apidocs/schemas/api_withdrawal_history_response.md index 7d38da5..6376519 100644 --- a/artifacts/apidocs/schemas/api_withdrawal_history_response.md +++ b/artifacts/apidocs/schemas/api_withdrawal_history_response.md @@ -35,8 +35,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Signature](/../../schemas/signature)" |Name
`Lite`|Type|Required
`Default`| Description | |-|-|-|-| diff --git a/artifacts/apidocs/schemas/api_withdrawal_request.md b/artifacts/apidocs/schemas/api_withdrawal_request.md index c79afd1..fe154bf 100644 --- a/artifacts/apidocs/schemas/api_withdrawal_request.md +++ b/artifacts/apidocs/schemas/api_withdrawal_request.md @@ -30,8 +30,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Signature](/../../schemas/signature)" |Name
`Lite`|Type|Required
`Default`| Description | |-|-|-|-| diff --git a/artifacts/apidocs/schemas/asset_margin_tier_response.md b/artifacts/apidocs/schemas/asset_margin_tier_response.md new file mode 100644 index 0000000..beb4d88 --- /dev/null +++ b/artifacts/apidocs/schemas/asset_margin_tier_response.md @@ -0,0 +1,10 @@ +!!! info "[AssetMarginTierResponse](/../../schemas/asset_margin_tier_response)" + |Name
`Lite`|Type|Required
`Default`| Description | + |-|-|-|-| + |asset
`a` |string|True|| + |tiers
`t` |[MarginTierResponse]|True|| + ??? info "[MarginTierResponse](/../../schemas/margin_tier_response)" + |Name
`Lite`|Type|Required
`Default`| Description | + |-|-|-|-| + |lower_bound
`lb` |string|True|| + |rate
`r` |string|True|| diff --git a/artifacts/apidocs/schemas/currency.md b/artifacts/apidocs/schemas/currency.md index 7b268f9..73bd283 100644 --- a/artifacts/apidocs/schemas/currency.md +++ b/artifacts/apidocs/schemas/currency.md @@ -20,5 +20,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/deposit.md b/artifacts/apidocs/schemas/deposit.md index 29d5e17..326521e 100644 --- a/artifacts/apidocs/schemas/deposit.md +++ b/artifacts/apidocs/schemas/deposit.md @@ -27,5 +27,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/deposit_history.md b/artifacts/apidocs/schemas/deposit_history.md index 95b2926..6ecbcdd 100644 --- a/artifacts/apidocs/schemas/deposit_history.md +++ b/artifacts/apidocs/schemas/deposit_history.md @@ -31,5 +31,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/ecosystem_point.md b/artifacts/apidocs/schemas/ecosystem_point.md index f8573eb..318f5f9 100644 --- a/artifacts/apidocs/schemas/ecosystem_point.md +++ b/artifacts/apidocs/schemas/ecosystem_point.md @@ -16,3 +16,6 @@ |rank
`r` |integer|True|The rank of the account in the ecosystem| |epoch
`e` |integer|True|The epoch number of the ecosystem point| |brokered_trading_volume
`bt` |string|True|Brokered trading volume| + |brokered_trading_point
`bt1` |string|True|Brokered trading point| + |referee_kyc_point
`rk` |string|True|Referee KYC point| + |referrer_kyc_point
`rk1` |string|True|Referrer KYC point| diff --git a/artifacts/apidocs/schemas/flat_referral.md b/artifacts/apidocs/schemas/flat_referral.md index 9e17431..e6fde20 100644 --- a/artifacts/apidocs/schemas/flat_referral.md +++ b/artifacts/apidocs/schemas/flat_referral.md @@ -13,3 +13,4 @@ |is_kyc_completed
`ik` |boolean|True|The account is KYC verified or not| |kyc_completed_at
`kc` |string|True|The KYC completed time| |kyc_type
`kt` |string|True|The KYC type, can be 'individual' or 'business'| + |kyc_first_completed_at
`kf` |string|True|The first KYC completed time| diff --git a/artifacts/apidocs/schemas/funding_account_summary.md b/artifacts/apidocs/schemas/funding_account_summary.md index 1ba48cc..1060184 100644 --- a/artifacts/apidocs/schemas/funding_account_summary.md +++ b/artifacts/apidocs/schemas/funding_account_summary.md @@ -34,5 +34,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/funding_payment.md b/artifacts/apidocs/schemas/funding_payment.md index 24f9d6c..9f2664b 100644 --- a/artifacts/apidocs/schemas/funding_payment.md +++ b/artifacts/apidocs/schemas/funding_payment.md @@ -29,5 +29,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/instrument.md b/artifacts/apidocs/schemas/instrument.md index 70c3b41..91f7cb0 100644 --- a/artifacts/apidocs/schemas/instrument.md +++ b/artifacts/apidocs/schemas/instrument.md @@ -36,8 +36,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Currency](/../../schemas/currency)" The list of Currencies that are supported on the GRVT exchange
@@ -60,8 +67,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Kind](/../../schemas/kind)" The list of asset kinds that are supported on the GRVT exchange
diff --git a/artifacts/apidocs/schemas/margin_tier_response.md b/artifacts/apidocs/schemas/margin_tier_response.md new file mode 100644 index 0000000..faceaa7 --- /dev/null +++ b/artifacts/apidocs/schemas/margin_tier_response.md @@ -0,0 +1,5 @@ +!!! info "[MarginTierResponse](/../../schemas/margin_tier_response)" + |Name
`Lite`|Type|Required
`Default`| Description | + |-|-|-|-| + |lower_bound
`lb` |string|True|| + |rate
`r` |string|True|| diff --git a/artifacts/apidocs/schemas/order.md b/artifacts/apidocs/schemas/order.md index 96b59e0..a6d43b2 100644 --- a/artifacts/apidocs/schemas/order.md +++ b/artifacts/apidocs/schemas/order.md @@ -49,7 +49,7 @@ |-|-|-|-| |client_order_id
`co` |string|True|A unique identifier for the active order within a subaccount, specified by the client
This is used to identify the order in the client's system
This field can be used for order amendment/cancellation, but has no bearing on the smart contract layer
This field will not be propagated to the smart contract, and should not be signed by the client
This value must be unique for all active orders in a subaccount, or amendment/cancellation will not work as expected
Gravity UI will generate a random clientOrderID for each order in the range [0, 2^63 - 1]
To prevent any conflicts, client machines should generate a random clientOrderID in the range [2^63, 2^64 - 1]

When GRVT Backend receives an order with an overlapping clientOrderID, we will reject the order with rejectReason set to overlappingClientOrderId| |create_time
`ct` |string|False
`0`|[Filled by GRVT Backend] Time at which the order was received by GRVT in unix nanoseconds| - |trigger
`t` |TriggerOrderMetadata|True|Trigger fields are used to support any type of trigger order such as TP/SL| + |trigger
`t` |TriggerOrderMetadata|False
``|Trigger fields are used to support any type of trigger order such as TP/SL| |broker
`b` |BrokerTag|False
``|Specifies the broker who brokered the order| ??? info "[TriggerOrderMetadata](/../../schemas/trigger_order_metadata)" Contains metadata related to trigger orders, such as Take Profit (TP) or Stop Loss (SL).

Trigger orders are used to automatically execute an order when a predefined price condition is met, allowing traders to implement risk management strategies.


diff --git a/artifacts/apidocs/schemas/order_metadata.md b/artifacts/apidocs/schemas/order_metadata.md index fa834f5..571cd2c 100644 --- a/artifacts/apidocs/schemas/order_metadata.md +++ b/artifacts/apidocs/schemas/order_metadata.md @@ -5,7 +5,7 @@ |-|-|-|-| |client_order_id
`co` |string|True|A unique identifier for the active order within a subaccount, specified by the client
This is used to identify the order in the client's system
This field can be used for order amendment/cancellation, but has no bearing on the smart contract layer
This field will not be propagated to the smart contract, and should not be signed by the client
This value must be unique for all active orders in a subaccount, or amendment/cancellation will not work as expected
Gravity UI will generate a random clientOrderID for each order in the range [0, 2^63 - 1]
To prevent any conflicts, client machines should generate a random clientOrderID in the range [2^63, 2^64 - 1]

When GRVT Backend receives an order with an overlapping clientOrderID, we will reject the order with rejectReason set to overlappingClientOrderId| |create_time
`ct` |string|False
`0`|[Filled by GRVT Backend] Time at which the order was received by GRVT in unix nanoseconds| - |trigger
`t` |TriggerOrderMetadata|True|Trigger fields are used to support any type of trigger order such as TP/SL| + |trigger
`t` |TriggerOrderMetadata|False
``|Trigger fields are used to support any type of trigger order such as TP/SL| |broker
`b` |BrokerTag|False
``|Specifies the broker who brokered the order| ??? info "[TriggerOrderMetadata](/../../schemas/trigger_order_metadata)" Contains metadata related to trigger orders, such as Take Profit (TP) or Stop Loss (SL).

Trigger orders are used to automatically execute an order when a predefined price condition is met, allowing traders to implement risk management strategies.


diff --git a/artifacts/apidocs/schemas/pre_order_check_result.md b/artifacts/apidocs/schemas/pre_order_check_result.md index a7185c4..a5c736a 100644 --- a/artifacts/apidocs/schemas/pre_order_check_result.md +++ b/artifacts/apidocs/schemas/pre_order_check_result.md @@ -34,5 +34,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/snap_funding_account_summary.md b/artifacts/apidocs/schemas/snap_funding_account_summary.md new file mode 100644 index 0000000..1cd7568 --- /dev/null +++ b/artifacts/apidocs/schemas/snap_funding_account_summary.md @@ -0,0 +1,46 @@ +!!! info "[SnapFundingAccountSummary](/../../schemas/snap_funding_account_summary)" + The funding account summary, that reports the total equity and spot balances of a funding (main) account
+ + |Name
`Lite`|Type|Required
`Default`| Description | + |-|-|-|-| + |event_time
`et` |string|True|Time at which the event was emitted in unix nanoseconds| + |main_account_id
`ma` |string|True|The main account ID of the account to which the summary belongs| + |total_equity
`te` |string|True|Total equity of the main account, denominated in USD| + |spot_balances
`sb` |[SpotBalance]|True|The list of spot assets owned by this main account, and their balances| + ??? info "[SpotBalance](/../../schemas/spot_balance)" + |Name
`Lite`|Type|Required
`Default`| Description | + |-|-|-|-| + |currency
`c` |Currency|True|The currency you hold a spot balance in| + |balance
`b` |string|True|This currency's balance in this trading account.| + |index_price
`ip` |string|True|The index price of this currency. (reported in `USD`)| + ??? info "[Currency](/../../schemas/currency)" + The list of Currencies that are supported on the GRVT exchange
+ + |Value| Description | + |-|-| + |`USD` = 1|the USD fiat currency| + |`USDC` = 2|the USDC token| + |`USDT` = 3|the USDT token| + |`ETH` = 4|the ETH token| + |`BTC` = 5|the BTC token| + |`SOL` = 6|the SOL token| + |`ARB` = 7|the ARB token| + |`BNB` = 8|the BNB token| + |`ZK` = 9|the ZK token| + |`POL` = 10|the POL token| + |`OP` = 11|the OP token| + |`ATOM` = 12|the ATOM token| + |`KPEPE` = 13|the 1000PEPE token| + |`TON` = 14|the TON token| + |`XRP` = 15|the XRP token| + |`TRUMP` = 20|the TRUMP token| + |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| + |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| + |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/spot_balance.md b/artifacts/apidocs/schemas/spot_balance.md index 4eae88d..4b4c1c6 100644 --- a/artifacts/apidocs/schemas/spot_balance.md +++ b/artifacts/apidocs/schemas/spot_balance.md @@ -26,5 +26,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/sub_account.md b/artifacts/apidocs/schemas/sub_account.md index c947b90..c5c0487 100644 --- a/artifacts/apidocs/schemas/sub_account.md +++ b/artifacts/apidocs/schemas/sub_account.md @@ -40,8 +40,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[SpotBalance](/../../schemas/spot_balance)" |Name
`Lite`|Type|Required
`Default`| Description | |-|-|-|-| @@ -70,8 +77,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Positions](/../../schemas/positions)" |Name
`Lite`|Type|Required
`Default`| Description | |-|-|-|-| diff --git a/artifacts/apidocs/schemas/sub_account_trade_aggregation.md b/artifacts/apidocs/schemas/sub_account_trade_aggregation.md index e6ab414..1658d88 100644 --- a/artifacts/apidocs/schemas/sub_account_trade_aggregation.md +++ b/artifacts/apidocs/schemas/sub_account_trade_aggregation.md @@ -9,3 +9,4 @@ |num_traded
`nt` |string|True|Number of trades| |positive_fee
`pf` |string|True|Total positive fee paid by user| |signer
`s` |string|True|The signer of the trade| + |realized_pnl
`rp` |string|True|Realized PnL| diff --git a/artifacts/apidocs/schemas/sub_account_trade_interval.md b/artifacts/apidocs/schemas/sub_account_trade_interval.md index da2a639..7765cb7 100644 --- a/artifacts/apidocs/schemas/sub_account_trade_interval.md +++ b/artifacts/apidocs/schemas/sub_account_trade_interval.md @@ -4,3 +4,4 @@ |`SAT_1_MO` = 1|1 month| |`SAT_1_D` = 2|1 day| |`SAT_1_H` = 3|1 hour| + |`SAT_4_H` = 4|4 hour| diff --git a/artifacts/apidocs/schemas/transfer_history.md b/artifacts/apidocs/schemas/transfer_history.md index 55adcbd..fa698b0 100644 --- a/artifacts/apidocs/schemas/transfer_history.md +++ b/artifacts/apidocs/schemas/transfer_history.md @@ -34,8 +34,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Signature](/../../schemas/signature)" |Name
`Lite`|Type|Required
`Default`| Description | |-|-|-|-| diff --git a/artifacts/apidocs/schemas/withdrawal.md b/artifacts/apidocs/schemas/withdrawal.md index 1f8271e..8cf5b8e 100644 --- a/artifacts/apidocs/schemas/withdrawal.md +++ b/artifacts/apidocs/schemas/withdrawal.md @@ -28,8 +28,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Signature](/../../schemas/signature)" |Name
`Lite`|Type|Required
`Default`| Description | |-|-|-|-| diff --git a/artifacts/apidocs/schemas/withdrawal_history.md b/artifacts/apidocs/schemas/withdrawal_history.md index 9b835e8..bfd2d31 100644 --- a/artifacts/apidocs/schemas/withdrawal_history.md +++ b/artifacts/apidocs/schemas/withdrawal_history.md @@ -30,8 +30,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Signature](/../../schemas/signature)" |Name
`Lite`|Type|Required
`Default`| Description | |-|-|-|-| diff --git a/artifacts/apidocs/schemas/ws_cancel_feed_data_v1.md b/artifacts/apidocs/schemas/ws_cancel_feed_data_v1.md index fb5a7d4..2924a18 100644 --- a/artifacts/apidocs/schemas/ws_cancel_feed_data_v1.md +++ b/artifacts/apidocs/schemas/ws_cancel_feed_data_v1.md @@ -3,7 +3,7 @@ |-|-|-|-| |stream
`s` |string|True|Stream name| |selector
`s1` |string|True|Primary selector| - |sequence_number
`sn` |string|True|A running sequence number that determines global message order within the specific stream| + |sequence_number
`sn` |string|True|A sequence number used to determine message order within a stream.
- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.
- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.
- A single cluster payload can be multiplexed into multiple stream payloads.
- To distinguish each stream payload, a `dedupCounter` is included.
- The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`.| |feed
`f` |CancelStatusFeed|True|Data relating to the status of the cancellation attempt| ??? info "[CancelStatusFeed](/../../schemas/cancel_status_feed)" |Name
`Lite`|Type|Required
`Default`| Description | diff --git a/artifacts/apidocs/schemas/ws_candlestick_feed_data_v1.md b/artifacts/apidocs/schemas/ws_candlestick_feed_data_v1.md index 253e439..72d1fd2 100644 --- a/artifacts/apidocs/schemas/ws_candlestick_feed_data_v1.md +++ b/artifacts/apidocs/schemas/ws_candlestick_feed_data_v1.md @@ -3,7 +3,7 @@ |-|-|-|-| |stream
`s` |string|True|Stream name| |selector
`s1` |string|True|Primary selector| - |sequence_number
`sn` |string|True|A running sequence number that determines global message order within the specific stream| + |sequence_number
`sn` |string|True|A sequence number used to determine message order within a stream.
- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.
- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.
- A single cluster payload can be multiplexed into multiple stream payloads.
- To distinguish each stream payload, a `dedupCounter` is included.
- The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`.| |feed
`f` |Candlestick|True|A candlestick entry matching the request filters| ??? info "[Candlestick](/../../schemas/candlestick)"
diff --git a/artifacts/apidocs/schemas/ws_deposit_feed_data_v1.md b/artifacts/apidocs/schemas/ws_deposit_feed_data_v1.md index 6217458..09370cc 100644 --- a/artifacts/apidocs/schemas/ws_deposit_feed_data_v1.md +++ b/artifacts/apidocs/schemas/ws_deposit_feed_data_v1.md @@ -5,7 +5,7 @@ |-|-|-|-| |stream
`s` |string|True|The websocket channel to which the response is sent| |selector
`s1` |string|True|Primary selector| - |sequence_number
`sn` |string|True|A running sequence number that determines global message order within the specific stream| + |sequence_number
`sn` |string|True|A sequence number used to determine message order within a stream.
- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.
- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.
- A single cluster payload can be multiplexed into multiple stream payloads.
- To distinguish each stream payload, a `dedupCounter` is included.
- The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`.| |feed
`f` |Deposit|True|The Deposit object| ??? info "[Deposit](/../../schemas/deposit)" |Name
`Lite`|Type|Required
`Default`| Description | @@ -36,5 +36,12 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| diff --git a/artifacts/apidocs/schemas/ws_fill_feed_data_v1.md b/artifacts/apidocs/schemas/ws_fill_feed_data_v1.md index 69e7b68..d78ab8c 100644 --- a/artifacts/apidocs/schemas/ws_fill_feed_data_v1.md +++ b/artifacts/apidocs/schemas/ws_fill_feed_data_v1.md @@ -3,7 +3,7 @@ |-|-|-|-| |stream
`s` |string|True|The websocket channel to which the response is sent| |selector
`s1` |string|True|Primary selector| - |sequence_number
`sn` |string|True|A running sequence number that determines global message order within the specific stream| + |sequence_number
`sn` |string|True|A sequence number used to determine message order within a stream.
- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.
- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.
- A single cluster payload can be multiplexed into multiple stream payloads.
- To distinguish each stream payload, a `dedupCounter` is included.
- The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`.| |feed
`f` |Fill|True|A private trade matching the request filter| ??? info "[Fill](/../../schemas/fill)" |Name
`Lite`|Type|Required
`Default`| Description | diff --git a/artifacts/apidocs/schemas/ws_mini_ticker_feed_data_v1.md b/artifacts/apidocs/schemas/ws_mini_ticker_feed_data_v1.md index b04fa9c..5aae76f 100644 --- a/artifacts/apidocs/schemas/ws_mini_ticker_feed_data_v1.md +++ b/artifacts/apidocs/schemas/ws_mini_ticker_feed_data_v1.md @@ -3,7 +3,7 @@ |-|-|-|-| |stream
`s` |string|True|Stream name| |selector
`s1` |string|True|Primary selector| - |sequence_number
`sn` |string|True|A running sequence number that determines global message order within the specific stream| + |sequence_number
`sn` |string|True|A sequence number used to determine message order within a stream.
- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.
- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.
- A single cluster payload can be multiplexed into multiple stream payloads.
- To distinguish each stream payload, a `dedupCounter` is included.
- The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`.| |feed
`f` |MiniTicker|True|A mini ticker matching the request filter| ??? info "[MiniTicker](/../../schemas/mini_ticker)" |Name
`Lite`|Type|Required
`Default`| Description | diff --git a/artifacts/apidocs/schemas/ws_order_feed_data_v1.md b/artifacts/apidocs/schemas/ws_order_feed_data_v1.md index 758591d..60a656b 100644 --- a/artifacts/apidocs/schemas/ws_order_feed_data_v1.md +++ b/artifacts/apidocs/schemas/ws_order_feed_data_v1.md @@ -3,7 +3,7 @@ |-|-|-|-| |stream
`s` |string|True|Stream name| |selector
`s1` |string|True|Primary selector| - |sequence_number
`sn` |string|True|A running sequence number that determines global message order within the specific stream| + |sequence_number
`sn` |string|True|A sequence number used to determine message order within a stream.
- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.
- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.
- A single cluster payload can be multiplexed into multiple stream payloads.
- To distinguish each stream payload, a `dedupCounter` is included.
- The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`.| |feed
`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.
GRVT orders are capable of expressing both single-legged, and multi-legged orders by default.
This increases the learning curve slightly but reduces overall integration load, since the order payload is used across all GRVT trading venues.
Given GRVT's trustless settlement model, the Order payload also carries the signature, required to trade the order on our ZKSync Hyperchain.

All fields in the Order payload (except `id`, `metadata`, and `state`) are trustlessly enforced on our Hyperchain.
This minimizes the amount of trust users have to offer to GRVT
@@ -56,7 +56,7 @@ |-|-|-|-| |client_order_id
`co` |string|True|A unique identifier for the active order within a subaccount, specified by the client
This is used to identify the order in the client's system
This field can be used for order amendment/cancellation, but has no bearing on the smart contract layer
This field will not be propagated to the smart contract, and should not be signed by the client
This value must be unique for all active orders in a subaccount, or amendment/cancellation will not work as expected
Gravity UI will generate a random clientOrderID for each order in the range [0, 2^63 - 1]
To prevent any conflicts, client machines should generate a random clientOrderID in the range [2^63, 2^64 - 1]

When GRVT Backend receives an order with an overlapping clientOrderID, we will reject the order with rejectReason set to overlappingClientOrderId| |create_time
`ct` |string|False
`0`|[Filled by GRVT Backend] Time at which the order was received by GRVT in unix nanoseconds| - |trigger
`t` |TriggerOrderMetadata|True|Trigger fields are used to support any type of trigger order such as TP/SL| + |trigger
`t` |TriggerOrderMetadata|False
``|Trigger fields are used to support any type of trigger order such as TP/SL| |broker
`b` |BrokerTag|False
``|Specifies the broker who brokered the order| ??? info "[TriggerOrderMetadata](/../../schemas/trigger_order_metadata)" Contains metadata related to trigger orders, such as Take Profit (TP) or Stop Loss (SL).

Trigger orders are used to automatically execute an order when a predefined price condition is met, allowing traders to implement risk management strategies.


diff --git a/artifacts/apidocs/schemas/ws_order_group_feed_data_v1.md b/artifacts/apidocs/schemas/ws_order_group_feed_data_v1.md index 447a395..469e03f 100644 --- a/artifacts/apidocs/schemas/ws_order_group_feed_data_v1.md +++ b/artifacts/apidocs/schemas/ws_order_group_feed_data_v1.md @@ -3,7 +3,7 @@ |-|-|-|-| |stream
`s` |string|True|Stream name| |selector
`s1` |string|True|Primary selector| - |sequence_number
`sn` |string|True|A running sequence number that determines global message order within the specific stream| + |sequence_number
`sn` |string|True|A sequence number used to determine message order within a stream.
- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.
- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.
- A single cluster payload can be multiplexed into multiple stream payloads.
- To distinguish each stream payload, a `dedupCounter` is included.
- The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`.| |feed
`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.

This is used to define TP/SL pairs or other order groupings after loading the list of Open Orders.
diff --git a/artifacts/apidocs/schemas/ws_order_state_feed_data_v1.md b/artifacts/apidocs/schemas/ws_order_state_feed_data_v1.md index c2165cf..e371c6c 100644 --- a/artifacts/apidocs/schemas/ws_order_state_feed_data_v1.md +++ b/artifacts/apidocs/schemas/ws_order_state_feed_data_v1.md @@ -3,7 +3,7 @@ |-|-|-|-| |stream
`s` |string|True|Stream name| |selector
`s1` |string|True|Primary selector| - |sequence_number
`sn` |string|True|A running sequence number that determines global message order within the specific stream| + |sequence_number
`sn` |string|True|A sequence number used to determine message order within a stream.
- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.
- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.
- A single cluster payload can be multiplexed into multiple stream payloads.
- To distinguish each stream payload, a `dedupCounter` is included.
- The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`.| |feed
`f` |OrderStateFeed|True|The Order State Feed| ??? info "[OrderStateFeed](/../../schemas/order_state_feed)" |Name
`Lite`|Type|Required
`Default`| Description | diff --git a/artifacts/apidocs/schemas/ws_orderbook_levels_feed_data_v1.md b/artifacts/apidocs/schemas/ws_orderbook_levels_feed_data_v1.md index 74587a0..e37a0ed 100644 --- a/artifacts/apidocs/schemas/ws_orderbook_levels_feed_data_v1.md +++ b/artifacts/apidocs/schemas/ws_orderbook_levels_feed_data_v1.md @@ -3,7 +3,7 @@ |-|-|-|-| |stream
`s` |string|True|Stream name| |selector
`s1` |string|True|Primary selector| - |sequence_number
`sn` |string|True|A running sequence number that determines global message order within the specific stream| + |sequence_number
`sn` |string|True|A sequence number used to determine message order within a stream.
- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.
- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.
- A single cluster payload can be multiplexed into multiple stream payloads.
- To distinguish each stream payload, a `dedupCounter` is included.
- The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`.| |feed
`f` |OrderbookLevels|True|An orderbook levels object matching the request filter| ??? info "[OrderbookLevels](/../../schemas/orderbook_levels)" |Name
`Lite`|Type|Required
`Default`| Description | diff --git a/artifacts/apidocs/schemas/ws_positions_feed_data_v1.md b/artifacts/apidocs/schemas/ws_positions_feed_data_v1.md index a090b94..c4cbcda 100644 --- a/artifacts/apidocs/schemas/ws_positions_feed_data_v1.md +++ b/artifacts/apidocs/schemas/ws_positions_feed_data_v1.md @@ -3,7 +3,7 @@ |-|-|-|-| |stream
`s` |string|True|Stream name| |selector
`s1` |string|True|Primary selector| - |sequence_number
`sn` |string|True|A running sequence number that determines global message order within the specific stream| + |sequence_number
`sn` |string|True|A sequence number used to determine message order within a stream.
- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.
- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.
- A single cluster payload can be multiplexed into multiple stream payloads.
- To distinguish each stream payload, a `dedupCounter` is included.
- The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`.| |feed
`f` |Positions|True|A Position being created or updated matching the request filter| ??? info "[Positions](/../../schemas/positions)" |Name
`Lite`|Type|Required
`Default`| Description | diff --git a/artifacts/apidocs/schemas/ws_subscribe_params.md b/artifacts/apidocs/schemas/ws_subscribe_params.md index 7c9c059..896bfaa 100644 --- a/artifacts/apidocs/schemas/ws_subscribe_params.md +++ b/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.
When subscribing to the same primary selector again, the previous secondary selector will be replaced. See `Overview` page for more details.
+ All V1 Websocket Subscription Requests are housed in this wrapper. You may specify a stream and a list of feeds to subscribe to.
When subscribing to the same primary selector again, the previous secondary selector will be replaced. See `Overview` page for more details.
Sequence numbers can be either gateway-specific or global:
- **Gateway Unique Sequence Number**: Increments by one per stream, resets to 0 on gateway restart.
- **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.
Set `useGlobalSequenceNumber = true` if you need a persistent, unique identifier across all streams or ordering across multiple feeds.
|Name
`Lite`|Type|Required
`Default`| Description | |-|-|-|-| diff --git a/artifacts/apidocs/schemas/ws_ticker_feed_data_v1.md b/artifacts/apidocs/schemas/ws_ticker_feed_data_v1.md index b821c89..e9dacdc 100644 --- a/artifacts/apidocs/schemas/ws_ticker_feed_data_v1.md +++ b/artifacts/apidocs/schemas/ws_ticker_feed_data_v1.md @@ -3,7 +3,7 @@ |-|-|-|-| |stream
`s` |string|True|Stream name| |selector
`s1` |string|True|Primary selector| - |sequence_number
`sn` |string|True|A running sequence number that determines global message order within the specific stream| + |sequence_number
`sn` |string|True|A sequence number used to determine message order within a stream.
- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.
- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.
- A single cluster payload can be multiplexed into multiple stream payloads.
- To distinguish each stream payload, a `dedupCounter` is included.
- The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`.| |feed
`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:
- 24 hour volume (`buyVolume + sellVolume`)
- 24 hour taker buy/sell ratio (`buyVolume / sellVolume`)
- 24 hour average trade price (`volumeQ / volumeU`)
- 24 hour average trade volume (`volume / trades`)
- 24 hour percentage change (`24hStatChange / 24hStat`)
- 48 hour statistics (`2 * 24hStat - 24hStatChange`)

To query for an extended ticker payload, leverage the `greeks` and the `derived` flags.
Ticker extensions are currently under design to offer you more convenience.
These flags are only supported on the `Ticker Snapshot` WS endpoint, and on the `Ticker` API endpoint.

diff --git a/artifacts/apidocs/schemas/ws_trade_feed_data_v1.md b/artifacts/apidocs/schemas/ws_trade_feed_data_v1.md index a2e0ce6..8328e51 100644 --- a/artifacts/apidocs/schemas/ws_trade_feed_data_v1.md +++ b/artifacts/apidocs/schemas/ws_trade_feed_data_v1.md @@ -3,7 +3,7 @@ |-|-|-|-| |stream
`s` |string|True|Stream name| |selector
`s1` |string|True|Primary selector| - |sequence_number
`sn` |string|True|A running sequence number that determines global message order within the specific stream| + |sequence_number
`sn` |string|True|A sequence number used to determine message order within a stream.
- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.
- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.
- A single cluster payload can be multiplexed into multiple stream payloads.
- To distinguish each stream payload, a `dedupCounter` is included.
- The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`.| |feed
`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
diff --git a/artifacts/apidocs/schemas/ws_transfer_feed_data_v1.md b/artifacts/apidocs/schemas/ws_transfer_feed_data_v1.md index b1f56f0..0f2328b 100644 --- a/artifacts/apidocs/schemas/ws_transfer_feed_data_v1.md +++ b/artifacts/apidocs/schemas/ws_transfer_feed_data_v1.md @@ -5,7 +5,7 @@ |-|-|-|-| |stream
`s` |string|True|The websocket channel to which the response is sent| |selector
`s1` |string|True|Primary selector| - |sequence_number
`sn` |string|True|A running sequence number that determines global message order within the specific stream| + |sequence_number
`sn` |string|True|A sequence number used to determine message order within a stream.
- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.
- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.
- A single cluster payload can be multiplexed into multiple stream payloads.
- To distinguish each stream payload, a `dedupCounter` is included.
- The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`.| |feed
`f` |TransferHistory|True|The transfer history matching the requested filters| ??? info "[TransferHistory](/../../schemas/transfer_history)" |Name
`Lite`|Type|Required
`Default`| Description | @@ -43,8 +43,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Signature](/../../schemas/signature)" |Name
`Lite`|Type|Required
`Default`| Description | |-|-|-|-| diff --git a/artifacts/apidocs/schemas/ws_unsubscribe_params.md b/artifacts/apidocs/schemas/ws_unsubscribe_params.md index 7fcaa6b..5914171 100644 --- a/artifacts/apidocs/schemas/ws_unsubscribe_params.md +++ b/artifacts/apidocs/schemas/ws_unsubscribe_params.md @@ -1,5 +1,5 @@ !!! info "[WSUnsubscribeParams](/../../schemas/ws_unsubscribe_params)" - All V1 Websocket Unsubscription Requests are housed in this wrapper. You may specify a stream, and a list of feeds to unsubscribe from.
+ All V1 Websocket Unsubscription Requests are housed in this wrapper. You may specify a stream, a list of feeds and whether those feeds use global sequence numbers to unsubscribe from.
|Name
`Lite`|Type|Required
`Default`| Description | |-|-|-|-| diff --git a/artifacts/apidocs/schemas/ws_withdrawal_feed_data_v1.md b/artifacts/apidocs/schemas/ws_withdrawal_feed_data_v1.md index 373591c..54f0895 100644 --- a/artifacts/apidocs/schemas/ws_withdrawal_feed_data_v1.md +++ b/artifacts/apidocs/schemas/ws_withdrawal_feed_data_v1.md @@ -5,7 +5,7 @@ |-|-|-|-| |stream
`s` |string|True|The websocket channel to which the response is sent| |selector
`s1` |string|True|Primary selector| - |sequence_number
`sn` |string|True|A running sequence number that determines global message order within the specific stream| + |sequence_number
`sn` |string|True|A sequence number used to determine message order within a stream.
- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.
- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.
- A single cluster payload can be multiplexed into multiple stream payloads.
- To distinguish each stream payload, a `dedupCounter` is included.
- The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`.| |feed
`f` |Withdrawal|True|The Withdrawal object| ??? info "[Withdrawal](/../../schemas/withdrawal)" |Name
`Lite`|Type|Required
`Default`| Description | @@ -37,8 +37,15 @@ |`XRP` = 15|the XRP token| |`TRUMP` = 20|the TRUMP token| |`SUI` = 21|the SUI token| + |`LINK` = 25|the LINK token| + |`JUP` = 27|the JUP token| |`FARTCOIN` = 28|the FARTCOIN token| + |`ENA` = 29|the ENA token| + |`DOGE` = 30|the DOGE token| + |`ADA` = 33|the ADA token| + |`AAVE` = 34|the AAVE token| |`BERA` = 35|the BERA token| + |`IP` = 40|the IP token| ??? info "[Signature](/../../schemas/signature)" |Name
`Lite`|Type|Required
`Default`| Description | |-|-|-|-| diff --git a/artifacts/apidocs/trading_api.md b/artifacts/apidocs/trading_api.md index bcaf21c..7aa74d7 100644 --- a/artifacts/apidocs/trading_api.md +++ b/artifacts/apidocs/trading_api.md @@ -41,13 +41,13 @@ LITE ENDPOINT: lite/v1/create_order "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" } } } @@ -79,13 +79,13 @@ LITE ENDPOINT: lite/v1/create_order "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" } } } @@ -125,13 +125,13 @@ LITE ENDPOINT: lite/v1/create_order "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" }, "state": { "status": "PENDING", @@ -172,13 +172,13 @@ LITE ENDPOINT: lite/v1/create_order "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" }, "s1": { "s": "PENDING", @@ -302,13 +302,13 @@ LITE ENDPOINT: lite/v1/create_order "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" } } } @@ -348,13 +348,13 @@ LITE ENDPOINT: lite/v1/create_order "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" } } }, @@ -394,13 +394,13 @@ LITE ENDPOINT: lite/v1/create_order "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" } } } @@ -440,13 +440,13 @@ LITE ENDPOINT: lite/v1/create_order "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" } } }, @@ -487,13 +487,13 @@ LITE ENDPOINT: lite/v1/create_order "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" } } } @@ -533,13 +533,13 @@ LITE ENDPOINT: lite/v1/create_order "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" } } }, @@ -579,13 +579,13 @@ LITE ENDPOINT: lite/v1/create_order "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" } } } @@ -625,13 +625,13 @@ LITE ENDPOINT: lite/v1/create_order "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" } } }, @@ -672,13 +672,13 @@ LITE ENDPOINT: lite/v1/create_order "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" } } } @@ -718,13 +718,13 @@ LITE ENDPOINT: lite/v1/create_order "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" } } }, @@ -764,13 +764,13 @@ LITE ENDPOINT: lite/v1/create_order "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" } } } @@ -810,13 +810,13 @@ LITE ENDPOINT: lite/v1/create_order "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" } } }, @@ -857,13 +857,13 @@ LITE ENDPOINT: lite/v1/create_order "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" } } } @@ -903,13 +903,13 @@ LITE ENDPOINT: lite/v1/create_order "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" } } }, @@ -949,13 +949,13 @@ LITE ENDPOINT: lite/v1/create_order "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" } } } @@ -995,13 +995,13 @@ LITE ENDPOINT: lite/v1/create_order "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" } } }, @@ -1809,13 +1809,13 @@ LITE ENDPOINT: lite/v1/order "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" }, "state": { "status": "PENDING", @@ -1856,13 +1856,13 @@ LITE ENDPOINT: lite/v1/order "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" }, "s1": { "s": "PENDING", @@ -2239,13 +2239,13 @@ LITE ENDPOINT: lite/v1/open_orders "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" }, "state": { "status": "PENDING", @@ -2286,13 +2286,13 @@ LITE ENDPOINT: lite/v1/open_orders "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" }, "s1": { "s": "PENDING", @@ -2691,13 +2691,13 @@ LITE ENDPOINT: lite/v1/order_history "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" }, "state": { "status": "PENDING", @@ -2739,13 +2739,13 @@ LITE ENDPOINT: lite/v1/order_history "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" }, "s1": { "s": "PENDING", @@ -3177,13 +3177,13 @@ LITE ENDPOINT: lite/v1/pre_order_check "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" }, "state": { "status": "PENDING", @@ -3225,13 +3225,13 @@ LITE ENDPOINT: lite/v1/pre_order_check "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" }, "s1": { "s": "PENDING", @@ -3356,13 +3356,13 @@ LITE ENDPOINT: lite/v1/pre_order_check "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" }, "state": { "status": "PENDING", @@ -3412,13 +3412,13 @@ LITE ENDPOINT: lite/v1/pre_order_check "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" }, "state": { "status": "PENDING", @@ -3468,13 +3468,13 @@ LITE ENDPOINT: lite/v1/pre_order_check "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" }, "s1": { "s": "PENDING", @@ -3524,13 +3524,13 @@ LITE ENDPOINT: lite/v1/pre_order_check "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" }, "s1": { "s": "PENDING", @@ -3581,13 +3581,13 @@ LITE ENDPOINT: lite/v1/pre_order_check "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" }, "state": { "status": "PENDING", @@ -3637,13 +3637,13 @@ LITE ENDPOINT: lite/v1/pre_order_check "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" }, "state": { "status": "PENDING", @@ -3693,13 +3693,13 @@ LITE ENDPOINT: lite/v1/pre_order_check "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" }, "s1": { "s": "PENDING", @@ -3749,13 +3749,13 @@ LITE ENDPOINT: lite/v1/pre_order_check "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" }, "s1": { "s": "PENDING", @@ -3806,13 +3806,13 @@ LITE ENDPOINT: lite/v1/pre_order_check "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" }, "state": { "status": "PENDING", @@ -3862,13 +3862,13 @@ LITE ENDPOINT: lite/v1/pre_order_check "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" }, "state": { "status": "PENDING", @@ -3918,13 +3918,13 @@ LITE ENDPOINT: lite/v1/pre_order_check "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" }, "s1": { "s": "PENDING", @@ -3974,13 +3974,13 @@ LITE ENDPOINT: lite/v1/pre_order_check "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" }, "s1": { "s": "PENDING", @@ -4031,13 +4031,13 @@ LITE ENDPOINT: lite/v1/pre_order_check "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" }, "state": { "status": "PENDING", @@ -4087,13 +4087,13 @@ LITE ENDPOINT: lite/v1/pre_order_check "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" }, "state": { "status": "PENDING", @@ -4143,13 +4143,13 @@ LITE ENDPOINT: lite/v1/pre_order_check "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" }, "s1": { "s": "PENDING", @@ -4199,13 +4199,13 @@ LITE ENDPOINT: lite/v1/pre_order_check "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" }, "s1": { "s": "PENDING", @@ -4594,13 +4594,13 @@ LITE ENDPOINT: lite/v1/create_bulk_orders "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" }, "state": { "status": "PENDING", @@ -4641,13 +4641,13 @@ LITE ENDPOINT: lite/v1/create_bulk_orders "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" }, "s1": { "s": "PENDING", @@ -4695,13 +4695,13 @@ LITE ENDPOINT: lite/v1/create_bulk_orders "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" }, "state": { "status": "PENDING", @@ -4742,13 +4742,13 @@ LITE ENDPOINT: lite/v1/create_bulk_orders "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" }, "s1": { "s": "PENDING", @@ -4877,13 +4877,13 @@ LITE ENDPOINT: lite/v1/create_bulk_orders "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" }, "state": { "status": "PENDING", @@ -4932,13 +4932,13 @@ LITE ENDPOINT: lite/v1/create_bulk_orders "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" }, "state": { "status": "PENDING", @@ -4987,13 +4987,13 @@ LITE ENDPOINT: lite/v1/create_bulk_orders "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" }, "s1": { "s": "PENDING", @@ -5042,13 +5042,13 @@ LITE ENDPOINT: lite/v1/create_bulk_orders "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" }, "s1": { "s": "PENDING", @@ -5098,13 +5098,13 @@ LITE ENDPOINT: lite/v1/create_bulk_orders "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" }, "state": { "status": "PENDING", @@ -5153,13 +5153,13 @@ LITE ENDPOINT: lite/v1/create_bulk_orders "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" }, "state": { "status": "PENDING", @@ -5208,13 +5208,13 @@ LITE ENDPOINT: lite/v1/create_bulk_orders "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" }, "s1": { "s": "PENDING", @@ -5263,13 +5263,13 @@ LITE ENDPOINT: lite/v1/create_bulk_orders "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" }, "s1": { "s": "PENDING", @@ -5319,13 +5319,13 @@ LITE ENDPOINT: lite/v1/create_bulk_orders "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" }, "state": { "status": "PENDING", @@ -5374,13 +5374,13 @@ LITE ENDPOINT: lite/v1/create_bulk_orders "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" }, "state": { "status": "PENDING", @@ -5429,13 +5429,13 @@ LITE ENDPOINT: lite/v1/create_bulk_orders "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" }, "s1": { "s": "PENDING", @@ -5484,13 +5484,13 @@ LITE ENDPOINT: lite/v1/create_bulk_orders "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" }, "s1": { "s": "PENDING", @@ -5540,13 +5540,13 @@ LITE ENDPOINT: lite/v1/create_bulk_orders "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" }, "state": { "status": "PENDING", @@ -5595,13 +5595,13 @@ LITE ENDPOINT: lite/v1/create_bulk_orders "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" }, "state": { "status": "PENDING", @@ -5650,13 +5650,13 @@ LITE ENDPOINT: lite/v1/create_bulk_orders "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" }, "s1": { "s": "PENDING", @@ -5705,13 +5705,13 @@ LITE ENDPOINT: lite/v1/create_bulk_orders "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" }, "s1": { "s": "PENDING", @@ -7353,7 +7353,8 @@ LITE ENDPOINT: lite/v1/deposit_history "start_time": "1697788800000000000", "end_time": "1697788800000000000", "limit": 500, - "cursor": "" + "cursor": "", + "main_account_id": null } ``` **Lite Request** @@ -7363,7 +7364,8 @@ LITE ENDPOINT: lite/v1/deposit_history "st": "1697788800000000000", "et": "1697788800000000000", "l": 500, - "c1": "" + "c1": "", + "ma": null } ``` @@ -7453,7 +7455,8 @@ LITE ENDPOINT: lite/v1/deposit_history "start_time": "1697788800000000000", "end_time": "1697788800000000000", "limit": 500, - "cursor": "" + "cursor": "", + "main_account_id": null } ' ``` @@ -7471,7 +7474,8 @@ LITE ENDPOINT: lite/v1/deposit_history "start_time": "1697788800000000000", "end_time": "1697788800000000000", "limit": 500, - "cursor": "" + "cursor": "", + "main_account_id": null }, "id": 123 } @@ -7489,7 +7493,8 @@ LITE ENDPOINT: lite/v1/deposit_history "st": "1697788800000000000", "et": "1697788800000000000", "l": 500, - "c1": "" + "c1": "", + "ma": null } ' ``` @@ -7507,7 +7512,8 @@ LITE ENDPOINT: lite/v1/deposit_history "st": "1697788800000000000", "et": "1697788800000000000", "l": 500, - "c1": "" + "c1": "", + "ma": null }, "i": 123 } @@ -7526,7 +7532,8 @@ LITE ENDPOINT: lite/v1/deposit_history "start_time": "1697788800000000000", "end_time": "1697788800000000000", "limit": 500, - "cursor": "" + "cursor": "", + "main_account_id": null } ' ``` @@ -7544,7 +7551,8 @@ LITE ENDPOINT: lite/v1/deposit_history "start_time": "1697788800000000000", "end_time": "1697788800000000000", "limit": 500, - "cursor": "" + "cursor": "", + "main_account_id": null }, "id": 123 } @@ -7562,7 +7570,8 @@ LITE ENDPOINT: lite/v1/deposit_history "st": "1697788800000000000", "et": "1697788800000000000", "l": 500, - "c1": "" + "c1": "", + "ma": null } ' ``` @@ -7580,7 +7589,8 @@ LITE ENDPOINT: lite/v1/deposit_history "st": "1697788800000000000", "et": "1697788800000000000", "l": 500, - "c1": "" + "c1": "", + "ma": null }, "i": 123 } @@ -7599,7 +7609,8 @@ LITE ENDPOINT: lite/v1/deposit_history "start_time": "1697788800000000000", "end_time": "1697788800000000000", "limit": 500, - "cursor": "" + "cursor": "", + "main_account_id": null } ' ``` @@ -7617,7 +7628,8 @@ LITE ENDPOINT: lite/v1/deposit_history "start_time": "1697788800000000000", "end_time": "1697788800000000000", "limit": 500, - "cursor": "" + "cursor": "", + "main_account_id": null }, "id": 123 } @@ -7635,7 +7647,8 @@ LITE ENDPOINT: lite/v1/deposit_history "st": "1697788800000000000", "et": "1697788800000000000", "l": 500, - "c1": "" + "c1": "", + "ma": null } ' ``` @@ -7653,7 +7666,8 @@ LITE ENDPOINT: lite/v1/deposit_history "st": "1697788800000000000", "et": "1697788800000000000", "l": 500, - "c1": "" + "c1": "", + "ma": null }, "i": 123 } @@ -7672,7 +7686,8 @@ LITE ENDPOINT: lite/v1/deposit_history "start_time": "1697788800000000000", "end_time": "1697788800000000000", "limit": 500, - "cursor": "" + "cursor": "", + "main_account_id": null } ' ``` @@ -7690,7 +7705,8 @@ LITE ENDPOINT: lite/v1/deposit_history "start_time": "1697788800000000000", "end_time": "1697788800000000000", "limit": 500, - "cursor": "" + "cursor": "", + "main_account_id": null }, "id": 123 } @@ -7708,7 +7724,8 @@ LITE ENDPOINT: lite/v1/deposit_history "st": "1697788800000000000", "et": "1697788800000000000", "l": 500, - "c1": "" + "c1": "", + "ma": null } ' ``` @@ -7726,7 +7743,8 @@ LITE ENDPOINT: lite/v1/deposit_history "st": "1697788800000000000", "et": "1697788800000000000", "l": 500, - "c1": "" + "c1": "", + "ma": null }, "i": 123 } @@ -8342,7 +8360,8 @@ LITE ENDPOINT: lite/v1/transfer_history "end_time": "1697788800000000000", "limit": 500, "cursor": "", - "tx_id": "1028403" + "tx_id": "1028403", + "main_account_id": null } ``` **Lite Request** @@ -8353,7 +8372,8 @@ LITE ENDPOINT: lite/v1/transfer_history "et": "1697788800000000000", "l": 500, "c1": "", - "ti": "1028403" + "ti": "1028403", + "ma": null } ``` @@ -8464,7 +8484,8 @@ LITE ENDPOINT: lite/v1/transfer_history "end_time": "1697788800000000000", "limit": 500, "cursor": "", - "tx_id": "1028403" + "tx_id": "1028403", + "main_account_id": null } ' ``` @@ -8483,7 +8504,8 @@ LITE ENDPOINT: lite/v1/transfer_history "end_time": "1697788800000000000", "limit": 500, "cursor": "", - "tx_id": "1028403" + "tx_id": "1028403", + "main_account_id": null }, "id": 123 } @@ -8502,7 +8524,8 @@ LITE ENDPOINT: lite/v1/transfer_history "et": "1697788800000000000", "l": 500, "c1": "", - "ti": "1028403" + "ti": "1028403", + "ma": null } ' ``` @@ -8521,7 +8544,8 @@ LITE ENDPOINT: lite/v1/transfer_history "et": "1697788800000000000", "l": 500, "c1": "", - "ti": "1028403" + "ti": "1028403", + "ma": null }, "i": 123 } @@ -8541,7 +8565,8 @@ LITE ENDPOINT: lite/v1/transfer_history "end_time": "1697788800000000000", "limit": 500, "cursor": "", - "tx_id": "1028403" + "tx_id": "1028403", + "main_account_id": null } ' ``` @@ -8560,7 +8585,8 @@ LITE ENDPOINT: lite/v1/transfer_history "end_time": "1697788800000000000", "limit": 500, "cursor": "", - "tx_id": "1028403" + "tx_id": "1028403", + "main_account_id": null }, "id": 123 } @@ -8579,7 +8605,8 @@ LITE ENDPOINT: lite/v1/transfer_history "et": "1697788800000000000", "l": 500, "c1": "", - "ti": "1028403" + "ti": "1028403", + "ma": null } ' ``` @@ -8598,7 +8625,8 @@ LITE ENDPOINT: lite/v1/transfer_history "et": "1697788800000000000", "l": 500, "c1": "", - "ti": "1028403" + "ti": "1028403", + "ma": null }, "i": 123 } @@ -8618,7 +8646,8 @@ LITE ENDPOINT: lite/v1/transfer_history "end_time": "1697788800000000000", "limit": 500, "cursor": "", - "tx_id": "1028403" + "tx_id": "1028403", + "main_account_id": null } ' ``` @@ -8637,7 +8666,8 @@ LITE ENDPOINT: lite/v1/transfer_history "end_time": "1697788800000000000", "limit": 500, "cursor": "", - "tx_id": "1028403" + "tx_id": "1028403", + "main_account_id": null }, "id": 123 } @@ -8656,7 +8686,8 @@ LITE ENDPOINT: lite/v1/transfer_history "et": "1697788800000000000", "l": 500, "c1": "", - "ti": "1028403" + "ti": "1028403", + "ma": null } ' ``` @@ -8675,7 +8706,8 @@ LITE ENDPOINT: lite/v1/transfer_history "et": "1697788800000000000", "l": 500, "c1": "", - "ti": "1028403" + "ti": "1028403", + "ma": null }, "i": 123 } @@ -8695,7 +8727,8 @@ LITE ENDPOINT: lite/v1/transfer_history "end_time": "1697788800000000000", "limit": 500, "cursor": "", - "tx_id": "1028403" + "tx_id": "1028403", + "main_account_id": null } ' ``` @@ -8714,7 +8747,8 @@ LITE ENDPOINT: lite/v1/transfer_history "end_time": "1697788800000000000", "limit": 500, "cursor": "", - "tx_id": "1028403" + "tx_id": "1028403", + "main_account_id": null }, "id": 123 } @@ -8733,7 +8767,8 @@ LITE ENDPOINT: lite/v1/transfer_history "et": "1697788800000000000", "l": 500, "c1": "", - "ti": "1028403" + "ti": "1028403", + "ma": null } ' ``` @@ -8752,7 +8787,8 @@ LITE ENDPOINT: lite/v1/transfer_history "et": "1697788800000000000", "l": 500, "c1": "", - "ti": "1028403" + "ti": "1028403", + "ma": null }, "i": 123 } @@ -9290,7 +9326,8 @@ LITE ENDPOINT: lite/v1/withdrawal_history "start_time": "1697788800000000000", "end_time": "1697788800000000000", "limit": 500, - "cursor": "" + "cursor": "", + "main_account_id": null } ``` **Lite Request** @@ -9300,7 +9337,8 @@ LITE ENDPOINT: lite/v1/withdrawal_history "st": "1697788800000000000", "et": "1697788800000000000", "l": 500, - "c1": "" + "c1": "", + "ma": null } ``` @@ -9402,7 +9440,8 @@ LITE ENDPOINT: lite/v1/withdrawal_history "start_time": "1697788800000000000", "end_time": "1697788800000000000", "limit": 500, - "cursor": "" + "cursor": "", + "main_account_id": null } ' ``` @@ -9420,7 +9459,8 @@ LITE ENDPOINT: lite/v1/withdrawal_history "start_time": "1697788800000000000", "end_time": "1697788800000000000", "limit": 500, - "cursor": "" + "cursor": "", + "main_account_id": null }, "id": 123 } @@ -9438,7 +9478,8 @@ LITE ENDPOINT: lite/v1/withdrawal_history "st": "1697788800000000000", "et": "1697788800000000000", "l": 500, - "c1": "" + "c1": "", + "ma": null } ' ``` @@ -9456,7 +9497,8 @@ LITE ENDPOINT: lite/v1/withdrawal_history "st": "1697788800000000000", "et": "1697788800000000000", "l": 500, - "c1": "" + "c1": "", + "ma": null }, "i": 123 } @@ -9475,7 +9517,8 @@ LITE ENDPOINT: lite/v1/withdrawal_history "start_time": "1697788800000000000", "end_time": "1697788800000000000", "limit": 500, - "cursor": "" + "cursor": "", + "main_account_id": null } ' ``` @@ -9493,7 +9536,8 @@ LITE ENDPOINT: lite/v1/withdrawal_history "start_time": "1697788800000000000", "end_time": "1697788800000000000", "limit": 500, - "cursor": "" + "cursor": "", + "main_account_id": null }, "id": 123 } @@ -9511,7 +9555,8 @@ LITE ENDPOINT: lite/v1/withdrawal_history "st": "1697788800000000000", "et": "1697788800000000000", "l": 500, - "c1": "" + "c1": "", + "ma": null } ' ``` @@ -9529,7 +9574,8 @@ LITE ENDPOINT: lite/v1/withdrawal_history "st": "1697788800000000000", "et": "1697788800000000000", "l": 500, - "c1": "" + "c1": "", + "ma": null }, "i": 123 } @@ -9548,7 +9594,8 @@ LITE ENDPOINT: lite/v1/withdrawal_history "start_time": "1697788800000000000", "end_time": "1697788800000000000", "limit": 500, - "cursor": "" + "cursor": "", + "main_account_id": null } ' ``` @@ -9566,7 +9613,8 @@ LITE ENDPOINT: lite/v1/withdrawal_history "start_time": "1697788800000000000", "end_time": "1697788800000000000", "limit": 500, - "cursor": "" + "cursor": "", + "main_account_id": null }, "id": 123 } @@ -9584,7 +9632,8 @@ LITE ENDPOINT: lite/v1/withdrawal_history "st": "1697788800000000000", "et": "1697788800000000000", "l": 500, - "c1": "" + "c1": "", + "ma": null } ' ``` @@ -9602,7 +9651,8 @@ LITE ENDPOINT: lite/v1/withdrawal_history "st": "1697788800000000000", "et": "1697788800000000000", "l": 500, - "c1": "" + "c1": "", + "ma": null }, "i": 123 } @@ -9621,7 +9671,8 @@ LITE ENDPOINT: lite/v1/withdrawal_history "start_time": "1697788800000000000", "end_time": "1697788800000000000", "limit": 500, - "cursor": "" + "cursor": "", + "main_account_id": null } ' ``` @@ -9639,7 +9690,8 @@ LITE ENDPOINT: lite/v1/withdrawal_history "start_time": "1697788800000000000", "end_time": "1697788800000000000", "limit": 500, - "cursor": "" + "cursor": "", + "main_account_id": null }, "id": 123 } @@ -9657,7 +9709,8 @@ LITE ENDPOINT: lite/v1/withdrawal_history "st": "1697788800000000000", "et": "1697788800000000000", "l": 500, - "c1": "" + "c1": "", + "ma": null } ' ``` @@ -9675,7 +9728,8 @@ LITE ENDPOINT: lite/v1/withdrawal_history "st": "1697788800000000000", "et": "1697788800000000000", "l": 500, - "c1": "" + "c1": "", + "ma": null }, "i": 123 } diff --git a/artifacts/apidocs/trading_streams.md b/artifacts/apidocs/trading_streams.md index 3e596f7..3ea5d86 100644 --- a/artifacts/apidocs/trading_streams.md +++ b/artifacts/apidocs/trading_streams.md @@ -133,13 +133,13 @@ STREAM: v1.order "client_order_id": "23042", "create_time": "1697788800000000000", "trigger": { - "trigger_type": "UNSPECIFIED", + "trigger_type": "TAKE_PROFIT", "tpsl": { - "trigger_by": "UNSPECIFIED", + "trigger_by": "LAST", "trigger_price": "65038.10" } }, - "broker": "UNSPECIFIED" + "broker": "BROKER_CODE" }, "state": { "status": "PENDING", @@ -183,13 +183,13 @@ STREAM: v1.order "co": "23042", "ct": "1697788800000000000", "t": { - "tt": "UNSPECIFIED", + "tt": "TAKE_PROFIT", "t": { - "tb": "UNSPECIFIED", + "tb": "LAST", "tp": "65038.10" } }, - "b": "UNSPECIFIED" + "b": "BROKER_CODE" }, "s1": { "s": "PENDING", diff --git a/artifacts/pysdk/grvt_raw_async.py b/artifacts/pysdk/grvt_raw_async.py index c9e3194..c9b143a 100644 --- a/artifacts/pysdk/grvt_raw_async.py +++ b/artifacts/pysdk/grvt_raw_async.py @@ -96,6 +96,14 @@ async def funding_rate_v1( return GrvtError(**resp) return from_dict(types.ApiFundingRateResponse, resp, Config(cast=[Enum])) + async def drop_client_ws( + self, req: types.ApiDropClientWsRequest + ) -> types.ApiDropClientWsResponse | GrvtError: + resp = await self._post(True, self.td_rpc + "/full/v1/drop_client_ws", req) + if resp.get("code"): + return GrvtError(**resp) + return from_dict(types.ApiDropClientWsResponse, resp, Config(cast=[Enum])) + async def create_order_v1( self, req: types.ApiCreateOrderRequest ) -> types.ApiCreateOrderResponse | GrvtError: @@ -329,3 +337,21 @@ async def set_initial_leverage_v1( if resp.get("code"): return GrvtError(**resp) return from_dict(types.ApiSetInitialLeverageResponse, resp, Config(cast=[Enum])) + + async def get_margin_tiers_v1( + self, req: types.EmptyRequest + ) -> types.ApiGetMarginTiersResponse | GrvtError: + resp = await self._post(True, self.td_rpc + "/full/v1/get_margin_tiers", req) + if resp.get("code"): + return GrvtError(**resp) + return from_dict(types.ApiGetMarginTiersResponse, resp, Config(cast=[Enum])) + + async def query_trading_performance_v1( + self, req: types.ApiQueryTradingPerformanceRequest + ) -> types.ApiQueryTradingPerformanceResponse | GrvtError: + resp = await self._post(True, self.td_rpc + "/full/v1/trading_performance", req) + if resp.get("code"): + return GrvtError(**resp) + return from_dict( + types.ApiQueryTradingPerformanceResponse, resp, Config(cast=[Enum]) + ) diff --git a/artifacts/pysdk/grvt_raw_sync.py b/artifacts/pysdk/grvt_raw_sync.py index 60b090d..7d078f3 100644 --- a/artifacts/pysdk/grvt_raw_sync.py +++ b/artifacts/pysdk/grvt_raw_sync.py @@ -94,6 +94,14 @@ def funding_rate_v1( return GrvtError(**resp) return from_dict(types.ApiFundingRateResponse, resp, Config(cast=[Enum])) + def drop_client_ws( + self, req: types.ApiDropClientWsRequest + ) -> types.ApiDropClientWsResponse | GrvtError: + resp = self._post(True, self.td_rpc + "/full/v1/drop_client_ws", req) + if resp.get("code"): + return GrvtError(**resp) + return from_dict(types.ApiDropClientWsResponse, resp, Config(cast=[Enum])) + def create_order_v1( self, req: types.ApiCreateOrderRequest ) -> types.ApiCreateOrderResponse | GrvtError: @@ -315,3 +323,21 @@ def set_initial_leverage_v1( if resp.get("code"): return GrvtError(**resp) return from_dict(types.ApiSetInitialLeverageResponse, resp, Config(cast=[Enum])) + + def get_margin_tiers_v1( + self, req: types.EmptyRequest + ) -> types.ApiGetMarginTiersResponse | GrvtError: + resp = self._post(True, self.td_rpc + "/full/v1/get_margin_tiers", req) + if resp.get("code"): + return GrvtError(**resp) + return from_dict(types.ApiGetMarginTiersResponse, resp, Config(cast=[Enum])) + + def query_trading_performance_v1( + self, req: types.ApiQueryTradingPerformanceRequest + ) -> types.ApiQueryTradingPerformanceResponse | GrvtError: + resp = self._post(True, self.td_rpc + "/full/v1/trading_performance", req) + if resp.get("code"): + return GrvtError(**resp) + return from_dict( + types.ApiQueryTradingPerformanceResponse, resp, Config(cast=[Enum]) + ) diff --git a/artifacts/pysdk/grvt_raw_types.py b/artifacts/pysdk/grvt_raw_types.py index 7e12c08..a04c9a6 100644 --- a/artifacts/pysdk/grvt_raw_types.py +++ b/artifacts/pysdk/grvt_raw_types.py @@ -323,6 +323,8 @@ class SubAccountTradeInterval(Enum): SAT_1_D = "SAT_1_D" # 1 hour SAT_1_H = "SAT_1_H" + # 4 hour + SAT_4_H = "SAT_4_H" class TimeInForce(Enum): @@ -1303,8 +1305,12 @@ class JSONRPCResponse: @dataclass class WSSubscribeParams: """ - All V1 Websocket Subscription Requests are housed in this wrapper. You may specify a stream, and a list of feeds to subscribe to. + All V1 Websocket Subscription Requests are housed in this wrapper. You may specify a stream and a list of feeds to subscribe to. When subscribing to the same primary selector again, the previous secondary selector will be replaced. See `Overview` page for more details. + Sequence numbers can be either gateway-specific or global: + - **Gateway Unique Sequence Number**: Increments by one per stream, resets to 0 on gateway restart. + - **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. + Set `useGlobalSequenceNumber = true` if you need a persistent, unique identifier across all streams or ordering across multiple feeds. """ # The channel to subscribe to (eg: ticker.s / ticker.d) @@ -1440,11 +1446,18 @@ class WSOrderbookLevelsFeedDataV1: stream: str # Primary selector selector: str - # A running sequence number that determines global message order within the specific stream + """ + A sequence number used to determine message order within a stream. + - If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts. + - If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster. + - A single cluster payload can be multiplexed into multiple stream payloads. + - To distinguish each stream payload, a `dedupCounter` is included. + - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`. + """ sequence_number: str # An orderbook levels object matching the request filter feed: OrderbookLevels - # The previous sequence number that determines global message order within the specific stream + # The previous sequence number that determines the message order prev_sequence_number: str @@ -1475,11 +1488,18 @@ class WSMiniTickerFeedDataV1: stream: str # Primary selector selector: str - # A running sequence number that determines global message order within the specific stream + """ + A sequence number used to determine message order within a stream. + - If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts. + - If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster. + - A single cluster payload can be multiplexed into multiple stream payloads. + - To distinguish each stream payload, a `dedupCounter` is included. + - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`. + """ sequence_number: str # A mini ticker matching the request filter feed: MiniTicker - # The previous sequence number that determines global message order within the specific stream + # The previous sequence number that determines the message order prev_sequence_number: str @@ -1510,11 +1530,18 @@ class WSTickerFeedDataV1: stream: str # Primary selector selector: str - # A running sequence number that determines global message order within the specific stream + """ + A sequence number used to determine message order within a stream. + - If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts. + - If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster. + - A single cluster payload can be multiplexed into multiple stream payloads. + - To distinguish each stream payload, a `dedupCounter` is included. + - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`. + """ sequence_number: str # A ticker matching the request filter feed: Ticker - # The previous sequence number that determines global message order within the specific stream + # The previous sequence number that determines the message order prev_sequence_number: str @@ -1538,11 +1565,18 @@ class WSTradeFeedDataV1: stream: str # Primary selector selector: str - # A running sequence number that determines global message order within the specific stream + """ + A sequence number used to determine message order within a stream. + - If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts. + - If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster. + - A single cluster payload can be multiplexed into multiple stream payloads. + - To distinguish each stream payload, a `dedupCounter` is included. + - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`. + """ sequence_number: str # A public trade matching the request filter feed: Trade - # The previous sequence number that determines global message order within the specific stream + # The previous sequence number that determines the message order prev_sequence_number: str @@ -1567,11 +1601,18 @@ class WSCandlestickFeedDataV1: stream: str # Primary selector selector: str - # A running sequence number that determines global message order within the specific stream + """ + A sequence number used to determine message order within a stream. + - If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts. + - If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster. + - A single cluster payload can be multiplexed into multiple stream payloads. + - To distinguish each stream payload, a `dedupCounter` is included. + - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`. + """ sequence_number: str # A candlestick entry matching the request filters feed: Candlestick - # The previous sequence number that determines global message order within the specific stream + # The previous sequence number that determines the message order prev_sequence_number: str @@ -1617,6 +1658,34 @@ class ApiGetAllInstrumentsResponse: result: list[Instrument] +@dataclass +class SnapFundingAccountSummary: + # Time at which the event was emitted in unix nanoseconds + event_time: str + # The main account ID of the account to which the summary belongs + main_account_id: str + # Total equity of the main account, denominated in USD + total_equity: str + # The list of spot assets owned by this main account, and their balances + spot_balances: list[SpotBalance] + + +@dataclass +class ApiQueryTradingPerformanceRequest: + # The asset to filter by + asset: bytes + # Optional: The subaccount ID to filter by + sub_account_id: str | None = None + + +@dataclass +class ApiQueryTradingPerformanceResponse: + # Trading volume in USDT + trading_volume: str + # Realized PnL in USDT + realized_pnl: str + + @dataclass class OrderLeg: # The instrument to trade in this leg @@ -1711,10 +1780,10 @@ class OrderMetadata: When GRVT Backend receives an order with an overlapping clientOrderID, we will reject the order with rejectReason set to overlappingClientOrderId """ client_order_id: str - # Trigger fields are used to support any type of trigger order such as TP/SL - trigger: TriggerOrderMetadata # [Filled by GRVT Backend] Time at which the order was received by GRVT in unix nanoseconds create_time: str | None = None + # Trigger fields are used to support any type of trigger order such as TP/SL + trigger: TriggerOrderMetadata | None = None # Specifies the broker who brokered the order broker: BrokerTag | None = None @@ -2149,6 +2218,12 @@ class EcosystemPoint: epoch: int # Brokered trading volume brokered_trading_volume: str + # Brokered trading point + brokered_trading_point: str + # Referee KYC point + referee_kyc_point: str + # Referrer KYC point + referrer_kyc_point: str @dataclass @@ -2441,6 +2516,8 @@ class FlatReferral: kyc_completed_at: str # The KYC type, can be 'individual' or 'business' kyc_type: str + # The first KYC completed time + kyc_first_completed_at: str @dataclass @@ -2663,6 +2740,8 @@ class SubAccountTradeAggregation: positive_fee: str # The signer of the trade signer: str + # Realized PnL + realized_pnl: str @dataclass @@ -2738,11 +2817,18 @@ class WSOrderFeedDataV1: stream: str # Primary selector selector: str - # A running sequence number that determines global message order within the specific stream + """ + A sequence number used to determine message order within a stream. + - If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts. + - If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster. + - A single cluster payload can be multiplexed into multiple stream payloads. + - To distinguish each stream payload, a `dedupCounter` is included. + - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`. + """ sequence_number: str # The order object being created or updated feed: Order - # The previous sequence number that determines global message order within the specific stream + # The previous sequence number that determines the message order prev_sequence_number: str @@ -2778,11 +2864,18 @@ class WSOrderStateFeedDataV1: stream: str # Primary selector selector: str - # A running sequence number that determines global message order within the specific stream + """ + A sequence number used to determine message order within a stream. + - If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts. + - If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster. + - A single cluster payload can be multiplexed into multiple stream payloads. + - To distinguish each stream payload, a `dedupCounter` is included. + - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`. + """ sequence_number: str # The Order State Feed feed: OrderStateFeed - # The previous sequence number that determines global message order within the specific stream + # The previous sequence number that determines the message order prev_sequence_number: str @@ -2806,11 +2899,18 @@ class WSPositionsFeedDataV1: stream: str # Primary selector selector: str - # A running sequence number that determines global message order within the specific stream + """ + A sequence number used to determine message order within a stream. + - If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts. + - If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster. + - A single cluster payload can be multiplexed into multiple stream payloads. + - To distinguish each stream payload, a `dedupCounter` is included. + - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`. + """ sequence_number: str # A Position being created or updated matching the request filter feed: Positions - # The previous sequence number that determines global message order within the specific stream + # The previous sequence number that determines the message order prev_sequence_number: str @@ -2834,11 +2934,18 @@ class WSFillFeedDataV1: stream: str # Primary selector selector: str - # A running sequence number that determines global message order within the specific stream + """ + A sequence number used to determine message order within a stream. + - If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts. + - If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster. + - A single cluster payload can be multiplexed into multiple stream payloads. + - To distinguish each stream payload, a `dedupCounter` is included. + - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`. + """ sequence_number: str # A private trade matching the request filter feed: Fill - # The previous sequence number that determines global message order within the specific stream + # The previous sequence number that determines the message order prev_sequence_number: str @@ -2888,11 +2995,18 @@ class WSTransferFeedDataV1: stream: str # Primary selector selector: str - # A running sequence number that determines global message order within the specific stream + """ + A sequence number used to determine message order within a stream. + - If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts. + - If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster. + - A single cluster payload can be multiplexed into multiple stream payloads. + - To distinguish each stream payload, a `dedupCounter` is included. + - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`. + """ sequence_number: str # The transfer history matching the requested filters feed: TransferHistory - # The previous sequence number that determines global message order within the specific stream + # The previous sequence number that determines the message order prev_sequence_number: str @@ -2925,11 +3039,18 @@ class WSDepositFeedDataV1: stream: str # Primary selector selector: str - # A running sequence number that determines global message order within the specific stream + """ + A sequence number used to determine message order within a stream. + - If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts. + - If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster. + - A single cluster payload can be multiplexed into multiple stream payloads. + - To distinguish each stream payload, a `dedupCounter` is included. + - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`. + """ sequence_number: str # The Deposit object feed: Deposit - # The previous sequence number that determines global message order within the specific stream + # The previous sequence number that determines the message order prev_sequence_number: str @@ -2964,11 +3085,18 @@ class WSWithdrawalFeedDataV1: stream: str # Primary selector selector: str - # A running sequence number that determines global message order within the specific stream + """ + A sequence number used to determine message order within a stream. + - If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts. + - If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster. + - A single cluster payload can be multiplexed into multiple stream payloads. + - To distinguish each stream payload, a `dedupCounter` is included. + - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`. + """ sequence_number: str # The Withdrawal object feed: Withdrawal - # The previous sequence number that determines global message order within the specific stream + # The previous sequence number that determines the message order prev_sequence_number: str @@ -2994,11 +3122,18 @@ class WSCancelFeedDataV1: stream: str # Primary selector selector: str - # A running sequence number that determines global message order within the specific stream + """ + A sequence number used to determine message order within a stream. + - If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts. + - If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster. + - A single cluster payload can be multiplexed into multiple stream payloads. + - To distinguish each stream payload, a `dedupCounter` is included. + - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`. + """ sequence_number: str # Data relating to the status of the cancellation attempt feed: CancelStatusFeed - # The previous sequence number that determines global message order within the specific stream + # The previous sequence number that determines the message order prev_sequence_number: str @@ -3034,14 +3169,48 @@ class WSOrderGroupFeedDataV1: stream: str # Primary selector selector: str - # A running sequence number that determines global message order within the specific stream + """ + A sequence number used to determine message order within a stream. + - If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts. + - If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster. + - A single cluster payload can be multiplexed into multiple stream payloads. + - To distinguish each stream payload, a `dedupCounter` is included. + - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`. + """ sequence_number: str # The order object being created or updated feed: ClientOrderIDsByGroup - # The previous sequence number that determines global message order within the specific stream + # The previous sequence number that determines the message order prev_sequence_number: str +@dataclass +class ApiDropClientWsRequest: + main_account_id: str + + +@dataclass +class ApiDropClientWsResponse: + num_dropped: int + + +@dataclass +class MarginTierResponse: + lower_bound: str + rate: str + + +@dataclass +class AssetMarginTierResponse: + asset: str + tiers: list[MarginTierResponse] + + +@dataclass +class ApiGetMarginTiersResponse: + results: list[AssetMarginTierResponse] + + @dataclass class ApiWithdrawalRequest: """ @@ -3119,6 +3288,8 @@ class ApiDepositHistoryRequest: limit: int | None = None # The cursor to indicate when to start the next query from cursor: str | None = None + # Main account ID being queried. By default, applies the requestor's main account ID. + main_account_id: str | None = None @dataclass @@ -3170,6 +3341,8 @@ class ApiTransferHistoryRequest: cursor: str | None = None # The transaction ID to query for tx_id: str | None = None + # Main account ID being queried. By default, applies the requestor's main account ID. + main_account_id: str | None = None @dataclass @@ -3199,6 +3372,8 @@ class ApiWithdrawalHistoryRequest: limit: int | None = None # The cursor to indicate when to start the next query from cursor: str | None = None + # Main account ID being queried. By default, applies the requestor's main account ID. + main_account_id: str | None = None @dataclass diff --git a/src/codegen/apidocs/apidocs.py b/src/codegen/apidocs/apidocs.py index 5c89c27..6f5d525 100644 --- a/src/codegen/apidocs/apidocs.py +++ b/src/codegen/apidocs/apidocs.py @@ -36,6 +36,9 @@ IGNORE_RPCS: list[str] = [ "RPCDedustPositionV1", + "RPCDropClientWS", + "RPCGetMarginTiersV1", + "RPCQueryTradingPerformanceV1", ] IGNORE_ENUM_VALUES: dict[str, list[str]] = { @@ -47,20 +50,13 @@ "KSHIB", "POPCAT", "PENGU", - "LINK", "KBONK", - "JUP", - "ENA", - "DOGE", "AIXBT", "AI_16_Z", - "ADA", - "AAVE", "VINE", "PENDLE", "UXLINK", "KAITO", - "IP", ], } diff --git a/src/codegen/apispec.json b/src/codegen/apispec.json index 29232cf..fd1de76 100644 --- a/src/codegen/apispec.json +++ b/src/codegen/apispec.json @@ -701,6 +701,47 @@ } ], "rpcs": [ + { + "namespace": "Admin", + "name": "RPCDropClientWS", + "version": 1, + "route": "/drop_client_ws", + "auth_required": true, + "request": "ApiDropClientWsRequest", + "response": "ApiDropClientWsResponse", + "on_request_errors": [ + { + "code": 1000, + "message": "You need to authenticate prior to using this functionality", + "status": 401 + }, + { + "code": 1001, + "message": "You are not authorized to access this functionality", + "status": 403 + }, + { + "code": 1002, + "message": "Internal Server Error", + "status": 500 + }, + { + "code": 1003, + "message": "Request could not be processed due to malformed syntax", + "status": 400 + }, + { + "code": 1006, + "message": "You have surpassed the allocated rate limit for your tier", + "status": 429 + }, + { + "code": 1008, + "message": "Your IP has not been whitelisted for access", + "status": 401 + } + ] + }, { "namespace": "Order", "name": "RPCCreateOrderV1", @@ -2512,6 +2553,78 @@ "status": 400 } ] + }, + { + "namespace": "Margin", + "name": "RPCGetMarginTiersV1", + "version": 1, + "route": "/get_margin_tiers", + "auth_required": true, + "request": "EmptyRequest", + "response": "ApiGetMarginTiersResponse", + "on_request_errors": [ + { + "code": 1002, + "message": "Internal Server Error", + "status": 500 + }, + { + "code": 1003, + "message": "Request could not be processed due to malformed syntax", + "status": 400 + }, + { + "code": 1006, + "message": "You have surpassed the allocated rate limit for your tier", + "status": 429 + }, + { + "code": 1008, + "message": "Your IP has not been whitelisted for access", + "status": 401 + } + ] + }, + { + "namespace": "Order", + "name": "RPCQueryTradingPerformanceV1", + "version": 1, + "route": "/trading_performance", + "auth_required": true, + "request": "ApiQueryTradingPerformanceRequest", + "response": "ApiQueryTradingPerformanceResponse", + "on_request_errors": [ + { + "code": 1000, + "message": "You need to authenticate prior to using this functionality", + "status": 401 + }, + { + "code": 1001, + "message": "You are not authorized to access this functionality", + "status": 403 + }, + { + "code": 1002, + "message": "Internal Server Error", + "status": 500 + }, + { + "code": 1003, + "message": "Request could not be processed due to malformed syntax", + "status": 400 + }, + { + "code": 1006, + "message": "You have surpassed the allocated rate limit for your tier", + "status": 429 + }, + { + "code": 1008, + "message": "Your IP has not been whitelisted for access", + "status": 401 + } + ] } ], "streams": [ @@ -6895,8 +7008,12 @@ } ], "comment": [ - "All V1 Websocket Subscription Requests are housed in this wrapper. You may specify a stream, and a list of feeds to subscribe to.", - "When subscribing to the same primary selector again, the previous secondary selector will be replaced. See `Overview` page for more details." + "All V1 Websocket Subscription Requests are housed in this wrapper. You may specify a stream and a list of feeds to subscribe to.", + "When subscribing to the same primary selector again, the previous secondary selector will be replaced. See `Overview` page for more details.", + "Sequence numbers can be either gateway-specific or global:", + "- **Gateway Unique Sequence Number**: Increments by one per stream, resets to 0 on gateway restart.", + "- **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.", + "Set `useGlobalSequenceNumber = true` if you need a persistent, unique identifier across all streams or ordering across multiple feeds." ] }, { @@ -7033,7 +7150,7 @@ } ], "comment": [ - "All V1 Websocket Unsubscription Requests are housed in this wrapper. You may specify a stream, and a list of feeds to unsubscribe from." + "All V1 Websocket Unsubscription Requests are housed in this wrapper. You may specify a stream, a list of feeds and whether those feeds use global sequence numbers to unsubscribe from." ] }, { @@ -7358,7 +7475,12 @@ "optional": false, "example": "'872634876'", "comment": [ - "A running sequence number that determines global message order within the specific stream" + "A sequence number used to determine message order within a stream.", + "- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.", + "- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.", + " - A single cluster payload can be multiplexed into multiple stream payloads.", + " - To distinguish each stream payload, a `dedupCounter` is included.", + " - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`." ] }, { @@ -7383,7 +7505,7 @@ "optional": false, "example": "'872634875'", "comment": [ - "The previous sequence number that determines global message order within the specific stream" + "The previous sequence number that determines the message order" ] } ], @@ -7473,7 +7595,12 @@ "optional": false, "example": "'872634876'", "comment": [ - "A running sequence number that determines global message order within the specific stream" + "A sequence number used to determine message order within a stream.", + "- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.", + "- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.", + " - A single cluster payload can be multiplexed into multiple stream payloads.", + " - To distinguish each stream payload, a `dedupCounter` is included.", + " - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`." ] }, { @@ -7498,7 +7625,7 @@ "optional": false, "example": "'872634875'", "comment": [ - "The previous sequence number that determines global message order within the specific stream" + "The previous sequence number that determines the message order" ] } ], @@ -7588,7 +7715,12 @@ "optional": false, "example": "'872634876'", "comment": [ - "A running sequence number that determines global message order within the specific stream" + "A sequence number used to determine message order within a stream.", + "- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.", + "- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.", + " - A single cluster payload can be multiplexed into multiple stream payloads.", + " - To distinguish each stream payload, a `dedupCounter` is included.", + " - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`." ] }, { @@ -7613,7 +7745,7 @@ "optional": false, "example": "'872634875'", "comment": [ - "The previous sequence number that determines global message order within the specific stream" + "The previous sequence number that determines the message order" ] } ], @@ -7715,7 +7847,12 @@ "optional": false, "example": "'872634876'", "comment": [ - "A running sequence number that determines global message order within the specific stream" + "A sequence number used to determine message order within a stream.", + "- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.", + "- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.", + " - A single cluster payload can be multiplexed into multiple stream payloads.", + " - To distinguish each stream payload, a `dedupCounter` is included.", + " - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`." ] }, { @@ -7740,7 +7877,7 @@ "optional": false, "example": "'872634875'", "comment": [ - "The previous sequence number that determines global message order within the specific stream" + "The previous sequence number that determines the message order" ] } ], @@ -7836,7 +7973,12 @@ "optional": false, "example": "'872634876'", "comment": [ - "A running sequence number that determines global message order within the specific stream" + "A sequence number used to determine message order within a stream.", + "- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.", + "- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.", + " - A single cluster payload can be multiplexed into multiple stream payloads.", + " - To distinguish each stream payload, a `dedupCounter` is included.", + " - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`." ] }, { @@ -7861,7 +8003,7 @@ "optional": false, "example": "'872634875'", "comment": [ - "The previous sequence number that determines global message order within the specific stream" + "The previous sequence number that determines the message order" ] } ], @@ -8000,6 +8142,137 @@ ], "comment": [] }, + { + "name": "SnapFundingAccountSummary", + "is_root": true, + "fields": [ + { + "name": "event_time", + "lite_name": "et", + "semantic_type": "timestamp", + "json_type": "string", + "index": 0, + "array_depth": 0, + "optional": false, + "example": "'1697788800000000000'", + "comment": [ + "Time at which the event was emitted in unix nanoseconds" + ] + }, + { + "name": "main_account_id", + "lite_name": "ma", + "semantic_type": "address", + "json_type": "string", + "index": 1, + "array_depth": 0, + "optional": false, + "example": "'0xc73c0c2538fd9b833d20933ccc88fdaa74fcb0d0'", + "comment": [ + "The main account ID of the account to which the summary belongs" + ] + }, + { + "name": "total_equity", + "lite_name": "te", + "semantic_type": "string", + "json_type": "string", + "index": 2, + "array_depth": 0, + "optional": false, + "example": "'3945034.23'", + "comment": [ + "Total equity of the main account, denominated in USD" + ] + }, + { + "name": "spot_balances", + "lite_name": "sb", + "semantic_type": "SpotBalance", + "json_type": "SpotBalance", + "index": 3, + "array_depth": 1, + "optional": false, + "comment": [ + "The list of spot assets owned by this main account, and their balances" + ] + } + ], + "comment": [ + "The funding account summary, that reports the total equity and spot balances of a funding (main) account" + ] + }, + { + "name": "ApiQueryTradingPerformanceRequest", + "is_root": true, + "fields": [ + { + "name": "sub_account_id", + "lite_name": "sa", + "semantic_type": "uint64", + "json_type": "string", + "index": 0, + "array_depth": 0, + "optional": true, + "default": "all", + "example": "'$GRVT_SUB_ACCOUNT_ID'", + "comment": [ + "Optional: The subaccount ID to filter by" + ] + }, + { + "name": "asset", + "lite_name": "a", + "semantic_type": "[]byte", + "json_type": "unknown", + "index": 1, + "array_depth": 0, + "optional": false, + "example": "'BTC_USDT_Perp'", + "comment": [ + "The asset to filter by" + ] + } + ], + "comment": [ + "Request to retrieve the trading volume" + ] + }, + { + "name": "ApiQueryTradingPerformanceResponse", + "is_root": true, + "fields": [ + { + "name": "trading_volume", + "lite_name": "tv", + "semantic_type": "uint64", + "json_type": "string", + "index": 0, + "array_depth": 0, + "optional": false, + "example": "'3456.78'", + "comment": [ + "Trading volume in USDT" + ] + }, + { + "name": "realized_pnl", + "lite_name": "rp", + "semantic_type": "string", + "json_type": "string", + "index": 1, + "array_depth": 0, + "optional": false, + "example": "'9.75'", + "comment": [ + "Realized PnL in USDT" + ] + } + ], + "comment": [ + "Response to retrieve the trading volume" + ] + }, { "name": "OrderLeg", "is_root": false, @@ -8162,6 +8435,7 @@ "index": 0, "array_depth": 0, "optional": false, + "example": "'LAST'", "comment": [ "Defines the price type that activates a Take Profit (TP) or Stop Loss (SL) order" ] @@ -8202,6 +8476,7 @@ "index": 0, "array_depth": 0, "optional": false, + "example": "'TAKE_PROFIT'", "comment": [ "Type of the trigger order. eg: Take Profit, Stop Loss, etc" ] @@ -8275,7 +8550,8 @@ "json_type": "TriggerOrderMetadata", "index": 2, "array_depth": 0, - "optional": false, + "optional": true, + "default": "", "comment": [ "Trigger fields are used to support any type of trigger order such as TP/SL" ] @@ -8289,6 +8565,7 @@ "array_depth": 0, "optional": true, "default": "", + "example": "'BROKER_CODE'", "comment": [ "Specifies the broker who brokered the order" ] @@ -9872,6 +10149,45 @@ "comment": [ "Brokered trading volume" ] + }, + { + "name": "brokered_trading_point", + "lite_name": "bt1", + "semantic_type": "uint64", + "json_type": "string", + "index": 13, + "array_depth": 0, + "optional": false, + "example": "'1000'", + "comment": [ + "Brokered trading point" + ] + }, + { + "name": "referee_kyc_point", + "lite_name": "rk", + "semantic_type": "uint64", + "json_type": "string", + "index": 14, + "array_depth": 0, + "optional": false, + "example": "'1000'", + "comment": [ + "Referee KYC point" + ] + }, + { + "name": "referrer_kyc_point", + "lite_name": "rk1", + "semantic_type": "uint64", + "json_type": "string", + "index": 15, + "array_depth": 0, + "optional": false, + "example": "'1000'", + "comment": [ + "Referrer KYC point" + ] } ], "comment": [ @@ -11250,6 +11566,19 @@ "comment": [ "The KYC type, can be 'individual' or 'business'" ] + }, + { + "name": "kyc_first_completed_at", + "lite_name": "kf", + "semantic_type": "timestamp", + "json_type": "string", + "index": 10, + "array_depth": 0, + "optional": false, + "example": "'1697788800000000000'", + "comment": [ + "The first KYC completed time" + ] } ], "comment": [ @@ -12319,6 +12648,19 @@ "comment": [ "The signer of the trade" ] + }, + { + "name": "realized_pnl", + "lite_name": "rp", + "semantic_type": "int64", + "json_type": "string", + "index": 6, + "array_depth": 0, + "optional": false, + "example": "'10000101000203040506'", + "comment": [ + "Realized PnL" + ] } ], "comment": [ @@ -12628,7 +12970,12 @@ "optional": false, "example": "'872634876'", "comment": [ - "A running sequence number that determines global message order within the specific stream" + "A sequence number used to determine message order within a stream.", + "- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.", + "- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.", + " - A single cluster payload can be multiplexed into multiple stream payloads.", + " - To distinguish each stream payload, a `dedupCounter` is included.", + " - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`." ] }, { @@ -12653,7 +13000,7 @@ "optional": false, "example": "'872634875'", "comment": [ - "The previous sequence number that determines global message order within the specific stream" + "The previous sequence number that determines the message order" ] } ], @@ -12786,7 +13133,12 @@ "optional": false, "example": "'872634876'", "comment": [ - "A running sequence number that determines global message order within the specific stream" + "A sequence number used to determine message order within a stream.", + "- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.", + "- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.", + " - A single cluster payload can be multiplexed into multiple stream payloads.", + " - To distinguish each stream payload, a `dedupCounter` is included.", + " - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`." ] }, { @@ -12811,7 +13163,7 @@ "optional": false, "example": "'872634875'", "comment": [ - "The previous sequence number that determines global message order within the specific stream" + "The previous sequence number that determines the message order" ] } ], @@ -12897,7 +13249,12 @@ "optional": false, "example": "'872634876'", "comment": [ - "A running sequence number that determines global message order within the specific stream" + "A sequence number used to determine message order within a stream.", + "- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.", + "- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.", + " - A single cluster payload can be multiplexed into multiple stream payloads.", + " - To distinguish each stream payload, a `dedupCounter` is included.", + " - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`." ] }, { @@ -12922,7 +13279,7 @@ "optional": false, "example": "'872634875'", "comment": [ - "The previous sequence number that determines global message order within the specific stream" + "The previous sequence number that determines the message order" ] } ], @@ -13008,7 +13365,12 @@ "optional": false, "example": "'872634876'", "comment": [ - "A running sequence number that determines global message order within the specific stream" + "A sequence number used to determine message order within a stream.", + "- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.", + "- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.", + " - A single cluster payload can be multiplexed into multiple stream payloads.", + " - To distinguish each stream payload, a `dedupCounter` is included.", + " - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`." ] }, { @@ -13033,7 +13395,7 @@ "optional": false, "example": "'872634875'", "comment": [ - "The previous sequence number that determines global message order within the specific stream" + "The previous sequence number that determines the message order" ] } ], @@ -13266,7 +13628,12 @@ "optional": false, "example": "'872634876'", "comment": [ - "A running sequence number that determines global message order within the specific stream" + "A sequence number used to determine message order within a stream.", + "- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.", + "- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.", + " - A single cluster payload can be multiplexed into multiple stream payloads.", + " - To distinguish each stream payload, a `dedupCounter` is included.", + " - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`." ] }, { @@ -13291,7 +13658,7 @@ "optional": false, "example": "'872634875'", "comment": [ - "The previous sequence number that determines global message order within the specific stream" + "The previous sequence number that determines the message order" ] } ], @@ -13422,7 +13789,12 @@ "optional": false, "example": "'872634876'", "comment": [ - "A running sequence number that determines global message order within the specific stream" + "A sequence number used to determine message order within a stream.", + "- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.", + "- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.", + " - A single cluster payload can be multiplexed into multiple stream payloads.", + " - To distinguish each stream payload, a `dedupCounter` is included.", + " - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`." ] }, { @@ -13447,7 +13819,7 @@ "optional": false, "example": "'872634875'", "comment": [ - "The previous sequence number that determines global message order within the specific stream" + "The previous sequence number that determines the message order" ] } ], @@ -13590,7 +13962,12 @@ "optional": false, "example": "'872634876'", "comment": [ - "A running sequence number that determines global message order within the specific stream" + "A sequence number used to determine message order within a stream.", + "- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.", + "- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.", + " - A single cluster payload can be multiplexed into multiple stream payloads.", + " - To distinguish each stream payload, a `dedupCounter` is included.", + " - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`." ] }, { @@ -13615,7 +13992,7 @@ "optional": false, "example": "'872634875'", "comment": [ - "The previous sequence number that determines global message order within the specific stream" + "The previous sequence number that determines the message order" ] } ], @@ -13747,7 +14124,12 @@ "optional": false, "example": "'872634876'", "comment": [ - "A running sequence number that determines global message order within the specific stream" + "A sequence number used to determine message order within a stream.", + "- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.", + "- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.", + " - A single cluster payload can be multiplexed into multiple stream payloads.", + " - To distinguish each stream payload, a `dedupCounter` is included.", + " - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`." ] }, { @@ -13772,7 +14154,7 @@ "optional": false, "example": "'872634875'", "comment": [ - "The previous sequence number that determines global message order within the specific stream" + "The previous sequence number that determines the message order" ] } ], @@ -13870,7 +14252,12 @@ "optional": false, "example": "'872634876'", "comment": [ - "A running sequence number that determines global message order within the specific stream" + "A sequence number used to determine message order within a stream.", + "- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.", + "- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.", + " - A single cluster payload can be multiplexed into multiple stream payloads.", + " - To distinguish each stream payload, a `dedupCounter` is included.", + " - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`." ] }, { @@ -13895,12 +14282,117 @@ "optional": false, "example": "'872634875'", "comment": [ - "The previous sequence number that determines global message order within the specific stream" + "The previous sequence number that determines the message order" ] } ], "comment": [] }, + { + "name": "ApiDropClientWsRequest", + "is_root": true, + "fields": [ + { + "name": "main_account_id", + "lite_name": "ma", + "semantic_type": "address", + "json_type": "string", + "index": 0, + "array_depth": 0, + "optional": false, + "comment": [] + } + ], + "comment": [] + }, + { + "name": "ApiDropClientWsResponse", + "is_root": true, + "fields": [ + { + "name": "num_dropped", + "lite_name": "nd", + "semantic_type": "int32", + "json_type": "integer", + "index": 0, + "array_depth": 0, + "optional": false, + "comment": [] + } + ], + "comment": [] + }, + { + "name": "MarginTierResponse", + "is_root": true, + "fields": [ + { + "name": "lower_bound", + "lite_name": "lb", + "semantic_type": "string", + "json_type": "string", + "index": 0, + "array_depth": 0, + "optional": false, + "comment": [] + }, + { + "name": "rate", + "lite_name": "r", + "semantic_type": "string", + "json_type": "string", + "index": 1, + "array_depth": 0, + "optional": false, + "comment": [] + } + ], + "comment": [] + }, + { + "name": "AssetMarginTierResponse", + "is_root": true, + "fields": [ + { + "name": "asset", + "lite_name": "a", + "semantic_type": "asset", + "json_type": "string", + "index": 0, + "array_depth": 0, + "optional": false, + "comment": [] + }, + { + "name": "tiers", + "lite_name": "t", + "semantic_type": "MarginTierResponse", + "json_type": "MarginTierResponse", + "index": 1, + "array_depth": 1, + "optional": false, + "comment": [] + } + ], + "comment": [] + }, + { + "name": "ApiGetMarginTiersResponse", + "is_root": true, + "fields": [ + { + "name": "results", + "lite_name": "r", + "semantic_type": "AssetMarginTierResponse", + "json_type": "AssetMarginTierResponse", + "index": 0, + "array_depth": 1, + "optional": false, + "comment": [] + } + ], + "comment": [] + }, { "name": "ApiWithdrawalRequest", "is_root": true, @@ -14184,6 +14676,20 @@ "comment": [ "The cursor to indicate when to start the next query from" ] + }, + { + "name": "main_account_id", + "lite_name": "ma", + "semantic_type": "address", + "json_type": "string", + "index": 5, + "array_depth": 0, + "optional": true, + "default": "", + "example": "", + "comment": [ + "Main account ID being queried. By default, applies the requestor's main account ID." + ] } ], "comment": [ @@ -14423,6 +14929,20 @@ "comment": [ "The transaction ID to query for" ] + }, + { + "name": "main_account_id", + "lite_name": "ma", + "semantic_type": "address", + "json_type": "string", + "index": 6, + "array_depth": 0, + "optional": true, + "default": "", + "example": "", + "comment": [ + "Main account ID being queried. By default, applies the requestor's main account ID." + ] } ], "comment": [ @@ -14537,6 +15057,20 @@ "comment": [ "The cursor to indicate when to start the next query from" ] + }, + { + "name": "main_account_id", + "lite_name": "ma", + "semantic_type": "address", + "json_type": "string", + "index": 5, + "array_depth": 0, + "optional": true, + "default": "", + "example": "", + "comment": [ + "Main account ID being queried. By default, applies the requestor's main account ID." + ] } ], "comment": [ @@ -15721,6 +16255,13 @@ "comment": [ "1 hour" ] + }, + { + "name": "SAT_4_H", + "value": 4, + "comment": [ + "4 hour" + ] } ], "comment": []