Skip to content

[RFC] Update API docs and specs #65

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

Closed
Keithagy wants to merge 1 commit into from
Closed

[RFC] Update API docs and specs #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
33 changes: 1 addition & 32 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 @@ -7,37 +7,6 @@
??? info "[SpotBalance](/../../schemas/spot_balance)"
|Name<br>`Lite`|Type|Required<br>`Default`| Description |
|-|-|-|-|
|currency<br>`c` |Currency|True|The currency you hold a spot balance in|
|currency<br>`c` |string|True|The currency you hold a spot balance in|
|balance<br>`b` |string|True|This currency's balance in this trading account.|
|index_price<br>`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<br>

|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|
33 changes: 1 addition & 32 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 @@ -13,37 +13,6 @@
??? info "[SpotBalance](/../../schemas/spot_balance)"
|Name<br>`Lite`|Type|Required<br>`Default`| Description |
|-|-|-|-|
|currency<br>`c` |Currency|True|The currency you hold a spot balance in|
|currency<br>`c` |string|True|The currency you hold a spot balance in|
|balance<br>`b` |string|True|This currency's balance in this trading account.|
|index_price<br>`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<br>

|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|
66 changes: 2 additions & 64 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 @@ -5,8 +5,8 @@
|-|-|-|-|
|sub_account_id<br>`sa` |string|True|The subaccount ID cancelling all orders|
|kind<br>`k` |[Kind]|False<br>`all`|The kind filter to apply. If nil, this defaults to all kinds. Otherwise, only entries matching the filter will be cancelled|
|base<br>`b` |[Currency]|False<br>`all`|The base filter to apply. If nil, this defaults to all bases. Otherwise, only entries matching the filter will be cancelled|
|quote<br>`q` |[Currency]|False<br>`all`|The quote filter to apply. If nil, this defaults to all quotes. Otherwise, only entries matching the filter will be cancelled|
|base<br>`b` |[string]|False<br>`all`|The base filter to apply. If nil, this defaults to all bases. Otherwise, only entries matching the filter will be cancelled|
|quote<br>`q` |[string]|False<br>`all`|The quote filter to apply. If nil, this defaults to all quotes. Otherwise, only entries matching the filter will be cancelled|
??? info "[Kind](/../../schemas/kind)"
The list of asset kinds that are supported on the GRVT exchange<br>

Expand All @@ -16,65 +16,3 @@
|`FUTURE` = 2|the future asset kind|
|`CALL` = 3|the call option asset kind|
|`PUT` = 4|the put option asset kind|
??? info "[Currency](/../../schemas/currency)"
The list of Currencies that are supported on the GRVT exchange<br>

|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|
??? info "[Currency](/../../schemas/currency)"
The list of Currencies that are supported on the GRVT exchange<br>

|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|
5 changes: 5 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 @@ -151,3 +151,8 @@
|`OCO_COUNTER_PART_TRIGGERED` = 30|the OCO counter part order was triggered|
|`REDUCE_ONLY_LIMIT` = 31|the remaining order size was cancelled because it exceeded current position size|
|`CLIENT_REPLACE` = 32|the order was replaced by a client replace request|
|`DERISK_MUST_BE_IOC` = 33|the derisk order must be an IOC order|
|`DERISK_MUST_BE_REDUCE_ONLY` = 34|the derisk order must be a reduce-only order|
|`DERISK_NOT_SUPPORTED` = 35|derisk is not supported|
|`INVALID_ORDER_TYPE` = 36|the order type is invalid|
|`CURRENCY_NOT_DEFINED` = 37|the currency is not defined|
5 changes: 5 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 @@ -149,3 +149,8 @@
|`OCO_COUNTER_PART_TRIGGERED` = 30|the OCO counter part order was triggered|
|`REDUCE_ONLY_LIMIT` = 31|the remaining order size was cancelled because it exceeded current position size|
|`CLIENT_REPLACE` = 32|the order was replaced by a client replace request|
|`DERISK_MUST_BE_IOC` = 33|the derisk order must be an IOC order|
|`DERISK_MUST_BE_REDUCE_ONLY` = 34|the derisk order must be a reduce-only order|
|`DERISK_NOT_SUPPORTED` = 35|derisk is not supported|
|`INVALID_ORDER_TYPE` = 36|the order type is invalid|
|`CURRENCY_NOT_DEFINED` = 37|the currency is not defined|
33 changes: 1 addition & 32 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 @@ -3,40 +3,9 @@

|Name<br>`Lite`|Type|Required<br>`Default`| Description |
|-|-|-|-|
|currency<br>`c` |[Currency]|True|The token currency to query for, if nil or empty, return all deposits. Otherwise, only entries matching the filter will be returned|
|currency<br>`c` |[string]|True|The token currency to query for, if nil or empty, return all deposits. Otherwise, only entries matching the filter will be returned|
|start_time<br>`st` |string|False<br>`0`|The start time to query for in unix nanoseconds|
|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>

|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|
33 changes: 1 addition & 32 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 @@ -9,39 +9,8 @@
|l_1_hash<br>`l1` |string|True|The L1 txHash of the deposit|
|l_2_hash<br>`l2` |string|True|The L2 txHash of the deposit|
|to_account_id<br>`ta` |string|True|The account to deposit into|
|currency<br>`c` |Currency|True|The token currency to deposit|
|currency<br>`c` |string|True|The token currency to deposit|
|num_tokens<br>`nt` |string|True|The number of tokens to deposit|
|initiated_time<br>`it` |string|True|The timestamp when the deposit was initiated on L1 in unix nanoseconds|
|confirmed_time<br>`ct` |string|True|The timestamp when the deposit was confirmed on L2 in unix nanoseconds|
|from_address<br>`fa` |string|True|The address of the sender|
??? info "[Currency](/../../schemas/currency)"
The list of Currencies that are supported on the GRVT exchange<br>

|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|
66 changes: 2 additions & 64 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 @@ -5,8 +5,8 @@
|-|-|-|-|
|sub_account_id<br>`sa` |string|True|The sub account ID to request for|
|kind<br>`k` |[Kind]|False<br>`all`|The kind filter to apply. If nil, this defaults to all kinds. Otherwise, only entries matching the filter will be returned|
|base<br>`b` |[Currency]|False<br>`all`|The base filter to apply. If nil, this defaults to all bases. Otherwise, only entries matching the filter will be returned|
|quote<br>`q` |[Currency]|False<br>`all`|The quote filter to apply. If nil, this defaults to all quotes. Otherwise, only entries matching the filter will be returned|
|base<br>`b` |[string]|False<br>`all`|The base filter to apply. If nil, this defaults to all bases. Otherwise, only entries matching the filter will be returned|
|quote<br>`q` |[string]|False<br>`all`|The quote filter to apply. If nil, this defaults to all quotes. Otherwise, only entries matching the filter will be returned|
|start_time<br>`st` |string|False<br>`0`|The start time to apply in unix nanoseconds. If nil, this defaults to all start times. Otherwise, only entries matching the filter will be returned|
|end_time<br>`et` |string|False<br>`now()`|The end time to apply in unix nanoseconds. If nil, this defaults to all end times. Otherwise, only entries matching the filter will be returned|
|limit<br>`l` |integer|False<br>`500`|The limit to query for. Defaults to 500; Max 1000|
Expand All @@ -20,65 +20,3 @@
|`FUTURE` = 2|the future asset kind|
|`CALL` = 3|the call option asset kind|
|`PUT` = 4|the put option asset kind|
??? info "[Currency](/../../schemas/currency)"
The list of Currencies that are supported on the GRVT exchange<br>

|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|
??? info "[Currency](/../../schemas/currency)"
The list of Currencies that are supported on the GRVT exchange<br>

|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|
33 changes: 1 addition & 32 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 @@ -15,37 +15,6 @@
??? info "[SpotBalance](/../../schemas/spot_balance)"
|Name<br>`Lite`|Type|Required<br>`Default`| Description |
|-|-|-|-|
|currency<br>`c` |Currency|True|The currency you hold a spot balance in|
|currency<br>`c` |string|True|The currency you hold a spot balance in|
|balance<br>`b` |string|True|This currency's balance in this trading account.|
|index_price<br>`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<br>

|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|
Loading