Skip to content

[RFC] Update API docs and specs #56

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

Open
thangnguyen-19 wants to merge 3 commits into
base: main
Choose a base branch
from
Open

[RFC] Update API docs and specs #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aea216e
[RFC] Update API docs and specs
thangnguyen-19 Feb 25, 2025
cd4f10d
[RFC] Update API docs and specs
thangnguyen-19 Feb 25, 2025
79d3aa3
[RFC] Update API docs and specs
thangnguyen-19 Feb 25, 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
9 changes: 9 additions & 0 deletions 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,6 +53,15 @@
|-|-|-|-|
|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|
|broker<br>`b` |BrokerTag|False<br>``|Specifies the broker who brokered the order|
??? info "[BrokerTag](/../../schemas/broker_tag)"
BrokerTag is a tag for the broker that the order is sent from.<br>

|Value| Description |
|-|-|
|`COIN_ROUTES` = 1|CoinRoutes|
|`ALERTATRON` = 2|Alertatron|
|`ORIGAMI` = 3|Origami|
??? info "[OrderState](/../../schemas/order_state)"
|Name<br>`Lite`|Type|Required<br>`Default`| Description |
|-|-|-|-|
Expand Down
9 changes: 9 additions & 0 deletions 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,6 +55,15 @@
|-|-|-|-|
|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|
|broker<br>`b` |BrokerTag|False<br>``|Specifies the broker who brokered the order|
??? info "[BrokerTag](/../../schemas/broker_tag)"
BrokerTag is a tag for the broker that the order is sent from.<br>

|Value| Description |
|-|-|
|`COIN_ROUTES` = 1|CoinRoutes|
|`ALERTATRON` = 2|Alertatron|
|`ORIGAMI` = 3|Origami|
??? info "[OrderState](/../../schemas/order_state)"
|Name<br>`Lite`|Type|Required<br>`Default`| Description |
|-|-|-|-|
Expand Down
9 changes: 9 additions & 0 deletions 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,6 +53,15 @@
|-|-|-|-|
|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|
|broker<br>`b` |BrokerTag|False<br>``|Specifies the broker who brokered the order|
??? info "[BrokerTag](/../../schemas/broker_tag)"
BrokerTag is a tag for the broker that the order is sent from.<br>

|Value| Description |
|-|-|
|`COIN_ROUTES` = 1|CoinRoutes|
|`ALERTATRON` = 2|Alertatron|
|`ORIGAMI` = 3|Origami|
??? info "[OrderState](/../../schemas/order_state)"
|Name<br>`Lite`|Type|Required<br>`Default`| Description |
|-|-|-|-|
Expand Down
9 changes: 9 additions & 0 deletions artifacts/apidocs/schemas/api_fill_history_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,19 @@
|venue<br>`v` |Venue|True|The venue where the trade occurred|
|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|
|signer<br>`s1` |string|True|The address (public key) of the wallet signing the payload|
|broker<br>`b` |BrokerTag|False<br>``|Specifies the broker who brokered the order|
??? info "[Venue](/../../schemas/venue)"
The list of Trading Venues that are supported on the GRVT exchange<br>

|Value| Description |
|-|-|
|`ORDERBOOK` = 1|the trade is cleared on the orderbook venue|
|`RFQ` = 2|the trade is cleared on the RFQ venue|
??? info "[BrokerTag](/../../schemas/broker_tag)"
BrokerTag is a tag for the broker that the order is sent from.<br>

|Value| Description |
|-|-|
|`COIN_ROUTES` = 1|CoinRoutes|
|`ALERTATRON` = 2|Alertatron|
|`ORIGAMI` = 3|Origami|
9 changes: 9 additions & 0 deletions artifacts/apidocs/schemas/api_get_order_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,15 @@
|-|-|-|-|
|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|
|broker<br>`b` |BrokerTag|False<br>``|Specifies the broker who brokered the order|
??? info "[BrokerTag](/../../schemas/broker_tag)"
BrokerTag is a tag for the broker that the order is sent from.<br>

|Value| Description |
|-|-|
|`COIN_ROUTES` = 1|CoinRoutes|
|`ALERTATRON` = 2|Alertatron|
|`ORIGAMI` = 3|Origami|
??? info "[OrderState](/../../schemas/order_state)"
|Name<br>`Lite`|Type|Required<br>`Default`| Description |
|-|-|-|-|
Expand Down
9 changes: 9 additions & 0 deletions artifacts/apidocs/schemas/api_open_orders_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,15 @@
|-|-|-|-|
|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|
|broker<br>`b` |BrokerTag|False<br>``|Specifies the broker who brokered the order|
??? info "[BrokerTag](/../../schemas/broker_tag)"
BrokerTag is a tag for the broker that the order is sent from.<br>

|Value| Description |
|-|-|
|`COIN_ROUTES` = 1|CoinRoutes|
|`ALERTATRON` = 2|Alertatron|
|`ORIGAMI` = 3|Origami|
??? info "[OrderState](/../../schemas/order_state)"
|Name<br>`Lite`|Type|Required<br>`Default`| Description |
|-|-|-|-|
Expand Down
9 changes: 9 additions & 0 deletions artifacts/apidocs/schemas/api_order_history_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,15 @@
|-|-|-|-|
|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|
|broker<br>`b` |BrokerTag|False<br>``|Specifies the broker who brokered the order|
??? info "[BrokerTag](/../../schemas/broker_tag)"
BrokerTag is a tag for the broker that the order is sent from.<br>

|Value| Description |
|-|-|
|`COIN_ROUTES` = 1|CoinRoutes|
|`ALERTATRON` = 2|Alertatron|
|`ORIGAMI` = 3|Origami|
??? info "[OrderState](/../../schemas/order_state)"
|Name<br>`Lite`|Type|Required<br>`Default`| Description |
|-|-|-|-|
Expand Down
9 changes: 9 additions & 0 deletions artifacts/apidocs/schemas/api_pre_order_check_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,15 @@
|-|-|-|-|
|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|
|broker<br>`b` |BrokerTag|False<br>``|Specifies the broker who brokered the order|
??? info "[BrokerTag](/../../schemas/broker_tag)"
BrokerTag is a tag for the broker that the order is sent from.<br>

|Value| Description |
|-|-|
|`COIN_ROUTES` = 1|CoinRoutes|
|`ALERTATRON` = 2|Alertatron|
|`ORIGAMI` = 3|Origami|
??? info "[OrderState](/../../schemas/order_state)"
|Name<br>`Lite`|Type|Required<br>`Default`| Description |
|-|-|-|-|
Expand Down
5 changes: 5 additions & 0 deletions artifacts/apidocs/schemas/broker_tag.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
!!! info "[BrokerTag](/../../schemas/broker_tag)"
BrokerTag is a tag for the broker that the order is sent from.<br>

|Value| Description |
|-|-|
|`COIN_ROUTES` = 1|CoinRoutes|
|`ALERTATRON` = 2|Alertatron|
|`ORIGAMI` = 3|Origami|
9 changes: 9 additions & 0 deletions artifacts/apidocs/schemas/fill.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,19 @@
|venue<br>`v` |Venue|True|The venue where the trade occurred|
|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|
|signer<br>`s1` |string|True|The address (public key) of the wallet signing the payload|
|broker<br>`b` |BrokerTag|False<br>``|Specifies the broker who brokered the order|
??? info "[Venue](/../../schemas/venue)"
The list of Trading Venues that are supported on the GRVT exchange<br>

|Value| Description |
|-|-|
|`ORDERBOOK` = 1|the trade is cleared on the orderbook venue|
|`RFQ` = 2|the trade is cleared on the RFQ venue|
??? info "[BrokerTag](/../../schemas/broker_tag)"
BrokerTag is a tag for the broker that the order is sent from.<br>

|Value| Description |
|-|-|
|`COIN_ROUTES` = 1|CoinRoutes|
|`ALERTATRON` = 2|Alertatron|
|`ORIGAMI` = 3|Origami|
9 changes: 9 additions & 0 deletions artifacts/apidocs/schemas/order.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,15 @@
|-|-|-|-|
|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|
|broker<br>`b` |BrokerTag|False<br>``|Specifies the broker who brokered the order|
??? info "[BrokerTag](/../../schemas/broker_tag)"
BrokerTag is a tag for the broker that the order is sent from.<br>

|Value| Description |
|-|-|
|`COIN_ROUTES` = 1|CoinRoutes|
|`ALERTATRON` = 2|Alertatron|
|`ORIGAMI` = 3|Origami|
??? info "[OrderState](/../../schemas/order_state)"
|Name<br>`Lite`|Type|Required<br>`Default`| Description |
|-|-|-|-|
Expand Down
9 changes: 9 additions & 0 deletions artifacts/apidocs/schemas/order_metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,12 @@
|-|-|-|-|
|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|
|broker<br>`b` |BrokerTag|False<br>``|Specifies the broker who brokered the order|
??? info "[BrokerTag](/../../schemas/broker_tag)"
BrokerTag is a tag for the broker that the order is sent from.<br>

|Value| Description |
|-|-|
|`COIN_ROUTES` = 1|CoinRoutes|
|`ALERTATRON` = 2|Alertatron|
|`ORIGAMI` = 3|Origami|
7 changes: 0 additions & 7 deletions artifacts/apidocs/schemas/tpsl_order_metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +0,0 @@
!!! info "[TPSLOrderMetadata](/../../schemas/tpsl_order_metadata)"
Contains metadata for Take Profit (TP) and Stop Loss (SL) trigger orders.<br><br>### Fields:<br>- **triggerBy**: Defines the price type that activates the order (e.g., index price).<br>- **triggerPrice**: The price at which the order is triggered, expressed in `9` decimal precision.<br><br><br>

|Name<br>`Lite`|Type|Required<br>`Default`| Description |
|-|-|-|-|
|trigger_by<br>`tb` |TriggerBy|True|Defines the price type that activates a Take Profit (TP) or Stop Loss (SL) order|
|trigger_price<br>`tp` |string|True|The Trigger Price of the order, expressed in `9` decimals.|
Loading
Loading