Skip to content

Change default api enum #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thangnguyen-19 merged 4 commits into from
Apr 9, 2025
Merged

Change default api enum #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
98c0f82
[RFC] Update API docs and specs
thangnguyen-19 Apr 9, 2025
1e2e203
[RFC] Update API docs and specs
thangnguyen-19 Apr 9, 2025
c89f229
[RFC] Update API docs and specs
thangnguyen-19 Apr 9, 2025
9c3a8a5
[RFC] Update API docs and specs
thangnguyen-19 Apr 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions artifacts/apidocs/schemas/aggregated_account_summary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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|
7 changes: 7 additions & 0 deletions artifacts/apidocs/schemas/api_aggregated_account_summary_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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|
14 changes: 14 additions & 0 deletions artifacts/apidocs/schemas/api_cancel_all_orders_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<br>

Expand All @@ -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|
2 changes: 1 addition & 1 deletion artifacts/apidocs/schemas/api_cancel_order_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
|-|-|-|-|
|client_order_id<br>`co` |string|True|A unique identifier for the active order within a subaccount, specified by the client<br>This is used to identify the order in the client's system<br>This field can be used for order amendment/cancellation, but has no bearing on the smart contract layer<br>This field will not be propagated to the smart contract, and should not be signed by the client<br>This value must be unique for all active orders in a subaccount, or amendment/cancellation will not work as expected<br>Gravity UI will generate a random clientOrderID for each order in the range [0, 2^63 - 1]<br>To prevent any conflicts, client machines should generate a random clientOrderID in the range [2^63, 2^64 - 1]<br><br>When GRVT Backend receives an order with an overlapping clientOrderID, we will reject the order with rejectReason set to overlappingClientOrderId|
|create_time<br>`ct` |string|False<br>`0`|[Filled by GRVT Backend] Time at which the order was received by GRVT in unix nanoseconds|
|trigger<br>`t` |TriggerOrderMetadata|True|Trigger fields are used to support any type of trigger order such as TP/SL|
|trigger<br>`t` |TriggerOrderMetadata|False<br>``|Trigger fields are used to support any type of trigger order such as TP/SL|
|broker<br>`b` |BrokerTag|False<br>``|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).<br><br>Trigger orders are used to automatically execute an order when a predefined price condition is met, allowing traders to implement risk management strategies.<br><br><br>
Expand Down
2 changes: 1 addition & 1 deletion artifacts/apidocs/schemas/api_create_bulk_orders_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
|-|-|-|-|
|client_order_id<br>`co` |string|True|A unique identifier for the active order within a subaccount, specified by the client<br>This is used to identify the order in the client's system<br>This field can be used for order amendment/cancellation, but has no bearing on the smart contract layer<br>This field will not be propagated to the smart contract, and should not be signed by the client<br>This value must be unique for all active orders in a subaccount, or amendment/cancellation will not work as expected<br>Gravity UI will generate a random clientOrderID for each order in the range [0, 2^63 - 1]<br>To prevent any conflicts, client machines should generate a random clientOrderID in the range [2^63, 2^64 - 1]<br><br>When GRVT Backend receives an order with an overlapping clientOrderID, we will reject the order with rejectReason set to overlappingClientOrderId|
|create_time<br>`ct` |string|False<br>`0`|[Filled by GRVT Backend] Time at which the order was received by GRVT in unix nanoseconds|
|trigger<br>`t` |TriggerOrderMetadata|True|Trigger fields are used to support any type of trigger order such as TP/SL|
|trigger<br>`t` |TriggerOrderMetadata|False<br>``|Trigger fields are used to support any type of trigger order such as TP/SL|
|broker<br>`b` |BrokerTag|False<br>``|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).<br><br>Trigger orders are used to automatically execute an order when a predefined price condition is met, allowing traders to implement risk management strategies.<br><br><br>
Expand Down
2 changes: 1 addition & 1 deletion artifacts/apidocs/schemas/api_create_bulk_orders_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
|-|-|-|-|
|client_order_id<br>`co` |string|True|A unique identifier for the active order within a subaccount, specified by the client<br>This is used to identify the order in the client's system<br>This field can be used for order amendment/cancellation, but has no bearing on the smart contract layer<br>This field will not be propagated to the smart contract, and should not be signed by the client<br>This value must be unique for all active orders in a subaccount, or amendment/cancellation will not work as expected<br>Gravity UI will generate a random clientOrderID for each order in the range [0, 2^63 - 1]<br>To prevent any conflicts, client machines should generate a random clientOrderID in the range [2^63, 2^64 - 1]<br><br>When GRVT Backend receives an order with an overlapping clientOrderID, we will reject the order with rejectReason set to overlappingClientOrderId|
|create_time<br>`ct` |string|False<br>`0`|[Filled by GRVT Backend] Time at which the order was received by GRVT in unix nanoseconds|
|trigger<br>`t` |TriggerOrderMetadata|True|Trigger fields are used to support any type of trigger order such as TP/SL|
|trigger<br>`t` |TriggerOrderMetadata|False<br>``|Trigger fields are used to support any type of trigger order such as TP/SL|
|broker<br>`b` |BrokerTag|False<br>``|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).<br><br>Trigger orders are used to automatically execute an order when a predefined price condition is met, allowing traders to implement risk management strategies.<br><br><br>
Expand Down
2 changes: 1 addition & 1 deletion artifacts/apidocs/schemas/api_create_order_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
|-|-|-|-|
|client_order_id<br>`co` |string|True|A unique identifier for the active order within a subaccount, specified by the client<br>This is used to identify the order in the client's system<br>This field can be used for order amendment/cancellation, but has no bearing on the smart contract layer<br>This field will not be propagated to the smart contract, and should not be signed by the client<br>This value must be unique for all active orders in a subaccount, or amendment/cancellation will not work as expected<br>Gravity UI will generate a random clientOrderID for each order in the range [0, 2^63 - 1]<br>To prevent any conflicts, client machines should generate a random clientOrderID in the range [2^63, 2^64 - 1]<br><br>When GRVT Backend receives an order with an overlapping clientOrderID, we will reject the order with rejectReason set to overlappingClientOrderId|
|create_time<br>`ct` |string|False<br>`0`|[Filled by GRVT Backend] Time at which the order was received by GRVT in unix nanoseconds|
|trigger<br>`t` |TriggerOrderMetadata|True|Trigger fields are used to support any type of trigger order such as TP/SL|
|trigger<br>`t` |TriggerOrderMetadata|False<br>``|Trigger fields are used to support any type of trigger order such as TP/SL|
|broker<br>`b` |BrokerTag|False<br>``|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).<br><br>Trigger orders are used to automatically execute an order when a predefined price condition is met, allowing traders to implement risk management strategies.<br><br><br>
Expand Down
2 changes: 1 addition & 1 deletion artifacts/apidocs/schemas/api_create_order_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
|-|-|-|-|
|client_order_id<br>`co` |string|True|A unique identifier for the active order within a subaccount, specified by the client<br>This is used to identify the order in the client's system<br>This field can be used for order amendment/cancellation, but has no bearing on the smart contract layer<br>This field will not be propagated to the smart contract, and should not be signed by the client<br>This value must be unique for all active orders in a subaccount, or amendment/cancellation will not work as expected<br>Gravity UI will generate a random clientOrderID for each order in the range [0, 2^63 - 1]<br>To prevent any conflicts, client machines should generate a random clientOrderID in the range [2^63, 2^64 - 1]<br><br>When GRVT Backend receives an order with an overlapping clientOrderID, we will reject the order with rejectReason set to overlappingClientOrderId|
|create_time<br>`ct` |string|False<br>`0`|[Filled by GRVT Backend] Time at which the order was received by GRVT in unix nanoseconds|
|trigger<br>`t` |TriggerOrderMetadata|True|Trigger fields are used to support any type of trigger order such as TP/SL|
|trigger<br>`t` |TriggerOrderMetadata|False<br>``|Trigger fields are used to support any type of trigger order such as TP/SL|
|broker<br>`b` |BrokerTag|False<br>``|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).<br><br>Trigger orders are used to automatically execute an order when a predefined price condition is met, allowing traders to implement risk management strategies.<br><br><br>
Expand Down
8 changes: 8 additions & 0 deletions artifacts/apidocs/schemas/api_deposit_history_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
|end_time<br>`et` |string|False<br>`now()`|The end time to query for in unix nanoseconds|
|limit<br>`l` |integer|False<br>`500`|The limit to query for. Defaults to 500; Max 1000|
|cursor<br>`c1` |string|False<br>`''`|The cursor to indicate when to start the next query from|
|main_account_id<br>`ma` |string|False<br>``|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<br>

Expand All @@ -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|
7 changes: 7 additions & 0 deletions artifacts/apidocs/schemas/api_deposit_history_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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|
4 changes: 4 additions & 0 deletions artifacts/apidocs/schemas/api_drop_client_ws_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
!!! info "[ApiDropClientWsRequest](/../../schemas/api_drop_client_ws_request)"
|Name<br>`Lite`|Type|Required<br>`Default`| Description |
|-|-|-|-|
|main_account_id<br>`ma` |string|True||
4 changes: 4 additions & 0 deletions artifacts/apidocs/schemas/api_drop_client_ws_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
!!! info "[ApiDropClientWsResponse](/../../schemas/api_drop_client_ws_response)"
|Name<br>`Lite`|Type|Required<br>`Default`| Description |
|-|-|-|-|
|num_dropped<br>`nd` |integer|True||
14 changes: 14 additions & 0 deletions artifacts/apidocs/schemas/api_fill_history_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<br>

Expand All @@ -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|
7 changes: 7 additions & 0 deletions artifacts/apidocs/schemas/api_funding_account_summary_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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|
7 changes: 7 additions & 0 deletions artifacts/apidocs/schemas/api_funding_payment_history_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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|
14 changes: 14 additions & 0 deletions artifacts/apidocs/schemas/api_get_all_instruments_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<br>

Expand All @@ -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<br>

Expand Down
3 changes: 3 additions & 0 deletions artifacts/apidocs/schemas/api_get_ecosystem_leaderboard_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,6 @@
|rank<br>`r` |integer|True|The rank of the account in the ecosystem|
|epoch<br>`e` |integer|True|The epoch number of the ecosystem point|
|brokered_trading_volume<br>`bt` |string|True|Brokered trading volume|
|brokered_trading_point<br>`bt1` |string|True|Brokered trading point|
|referee_kyc_point<br>`rk` |string|True|Referee KYC point|
|referrer_kyc_point<br>`rk1` |string|True|Referrer KYC point|
14 changes: 14 additions & 0 deletions artifacts/apidocs/schemas/api_get_filtered_instruments_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<br>

Expand All @@ -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|
14 changes: 14 additions & 0 deletions artifacts/apidocs/schemas/api_get_filtered_instruments_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<br>

Expand All @@ -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<br>

Expand Down
Loading
Loading