Skip to content

[RFC] Update API docs and specs #74

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
Keithagy merged 1 commit into from
Oct 15, 2025
Merged

[RFC] Update API docs and specs #74

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
38 changes: 30 additions & 8 deletions artifacts/apidocs/market_data_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,10 @@ LITE ENDPOINT: lite/v1/instrument
"tick_size": "0.01",
"min_size": "0.01",
"create_time": "1697788800000000000",
"max_position_size": "100.0"
"max_position_size": "100.0",
"funding_interval_hours": null,
"adjusted_funding_rate_cap": 2.5,
"adjusted_funding_rate_floor": -2.5
}
}
```
Expand All @@ -69,7 +72,10 @@ LITE ENDPOINT: lite/v1/instrument
"ts": "0.01",
"ms": "0.01",
"ct": "1697788800000000000",
"mp": "100.0"
"mp": "100.0",
"fi": null,
"af": 2.5,
"af1": -2.5
}
}
```
Expand Down Expand Up @@ -350,7 +356,10 @@ LITE ENDPOINT: lite/v1/all_instruments
"tick_size": "0.01",
"min_size": "0.01",
"create_time": "1697788800000000000",
"max_position_size": "100.0"
"max_position_size": "100.0",
"funding_interval_hours": null,
"adjusted_funding_rate_cap": 2.5,
"adjusted_funding_rate_floor": -2.5
}]
}
```
Expand All @@ -370,7 +379,10 @@ LITE ENDPOINT: lite/v1/all_instruments
"ts": "0.01",
"ms": "0.01",
"ct": "1697788800000000000",
"mp": "100.0"
"mp": "100.0",
"fi": null,
"af": 2.5,
"af1": -2.5
}]
}
```
Expand Down Expand Up @@ -658,7 +670,10 @@ LITE ENDPOINT: lite/v1/instruments
"tick_size": "0.01",
"min_size": "0.01",
"create_time": "1697788800000000000",
"max_position_size": "100.0"
"max_position_size": "100.0",
"funding_interval_hours": null,
"adjusted_funding_rate_cap": 2.5,
"adjusted_funding_rate_floor": -2.5
}]
}
```
Expand All @@ -678,7 +693,10 @@ LITE ENDPOINT: lite/v1/instruments
"ts": "0.01",
"ms": "0.01",
"ct": "1697788800000000000",
"mp": "100.0"
"mp": "100.0",
"fi": null,
"af": 2.5,
"af1": -2.5
}]
}
```
Expand Down Expand Up @@ -1596,7 +1614,9 @@ LITE ENDPOINT: lite/v1/ticker
"low_price": "65038.01",
"open_price": "65038.01",
"open_interest": "123456.78",
"long_short_ratio": "0.5"
"long_short_ratio": "0.5",
"funding_rate": 0.0003,
"next_funding_time": "1697788800000000000"
}
}
```
Expand Down Expand Up @@ -1627,7 +1647,9 @@ LITE ENDPOINT: lite/v1/ticker
"lp1": "65038.01",
"op": "65038.01",
"oi": "123456.78",
"ls1": "0.5"
"ls1": "0.5",
"fr2": 0.0003,
"nf": "1697788800000000000"
}
}
```
Expand Down
16 changes: 12 additions & 4 deletions artifacts/apidocs/market_data_streams.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1250,7 +1250,9 @@ STREAM: v1.ticker.s
"low_price": "65038.01",
"open_price": "65038.01",
"open_interest": "123456.78",
"long_short_ratio": "0.5"
"long_short_ratio": "0.5",
"funding_rate": 0.0003,
"next_funding_time": "1697788800000000000"
}
}
```
Expand Down Expand Up @@ -1284,7 +1286,9 @@ STREAM: v1.ticker.s
"lp1": "65038.01",
"op": "65038.01",
"oi": "123456.78",
"ls1": "0.5"
"ls1": "0.5",
"fr2": 0.0003,
"nf": "1697788800000000000"
}
}
```
Expand Down Expand Up @@ -1835,7 +1839,9 @@ STREAM: v1.ticker.d
"low_price": "65038.01",
"open_price": "65038.01",
"open_interest": "123456.78",
"long_short_ratio": "0.5"
"long_short_ratio": "0.5",
"funding_rate": 0.0003,
"next_funding_time": "1697788800000000000"
}
}
```
Expand Down Expand Up @@ -1869,7 +1875,9 @@ STREAM: v1.ticker.d
"lp1": "65038.01",
"op": "65038.01",
"oi": "123456.78",
"ls1": "0.5"
"ls1": "0.5",
"fr2": 0.0003,
"nf": "1697788800000000000"
}
}
```
Expand Down
1 change: 1 addition & 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 @@ -5,6 +5,7 @@
|total_equity<br>`te` |string|True|Total equity of the main (+ sub) account, denominated in USD|
|spot_balances<br>`sb` |[SpotBalance]|True|The list of spot assets owned by this main (+ sub) account, and their balances|
|vault_investments<br>`vi` |[VaultInvestment]|True|The list of vault investments held by this main account|
|total_sub_account_balance<br>`ts` |string|True|Total balance of the sub accounts, denominated in USD|
??? info "[SpotBalance](/../../schemas/spot_balance)"
|Name<br>`Lite`|Type|Required<br>`Default`| Description |
|-|-|-|-|
Expand Down
1 change: 1 addition & 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 @@ -11,6 +11,7 @@
|total_equity<br>`te` |string|True|Total equity of the main (+ sub) account, denominated in USD|
|spot_balances<br>`sb` |[SpotBalance]|True|The list of spot assets owned by this main (+ sub) account, and their balances|
|vault_investments<br>`vi` |[VaultInvestment]|True|The list of vault investments held by this main account|
|total_sub_account_balance<br>`ts` |string|True|Total balance of the sub accounts, denominated in USD|
??? info "[SpotBalance](/../../schemas/spot_balance)"
|Name<br>`Lite`|Type|Required<br>`Default`| Description |
|-|-|-|-|
Expand Down
3 changes: 3 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 @@ -49,6 +49,7 @@
|v<br>`v` |integer|True|Signature V|
|expiration<br>`e` |string|True|Timestamp after which this signature expires, expressed in unix nanoseconds. Must be capped at 30 days|
|nonce<br>`n` |integer|True|Users can randomly generate this value, used as a signature deconflicting key.<br>ie. You can send the same exact instruction twice with different nonces.<br>When the same nonce is used, the same payload will generate the same signature.<br>Our system will consider the payload a duplicate, and ignore it.|
|chain_id<br>`ci` |string|True|Chain ID used in EIP-712 domain. Zero value fallbacks to GRVT Chain ID.|
??? info "[OrderMetadata](/../../schemas/order_metadata)"
Metadata fields are used to support Backend only operations. These operations are not trustless by nature.<br>Hence, fields in here are never signed, and is never transmitted to the smart contract.<br>

Expand All @@ -58,6 +59,7 @@
|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|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|
|allow_crossing<br>`ac` |boolean|False<br>`false`|Specifies if post only order is allowed to cross the orderbook|
??? 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 Expand Up @@ -158,3 +160,4 @@
|`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|
|`INVALID_CHAIN_ID` = 38|the chain ID is invalid|
3 changes: 3 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 @@ -47,6 +47,7 @@
|v<br>`v` |integer|True|Signature V|
|expiration<br>`e` |string|True|Timestamp after which this signature expires, expressed in unix nanoseconds. Must be capped at 30 days|
|nonce<br>`n` |integer|True|Users can randomly generate this value, used as a signature deconflicting key.<br>ie. You can send the same exact instruction twice with different nonces.<br>When the same nonce is used, the same payload will generate the same signature.<br>Our system will consider the payload a duplicate, and ignore it.|
|chain_id<br>`ci` |string|True|Chain ID used in EIP-712 domain. Zero value fallbacks to GRVT Chain ID.|
??? info "[OrderMetadata](/../../schemas/order_metadata)"
Metadata fields are used to support Backend only operations. These operations are not trustless by nature.<br>Hence, fields in here are never signed, and is never transmitted to the smart contract.<br>

Expand All @@ -56,6 +57,7 @@
|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|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|
|allow_crossing<br>`ac` |boolean|False<br>`false`|Specifies if post only order is allowed to cross the orderbook|
??? 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 Expand Up @@ -156,3 +158,4 @@
|`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|
|`INVALID_CHAIN_ID` = 38|the chain ID is invalid|
7 changes: 5 additions & 2 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
@@ -1,8 +1,8 @@
!!! info "[ApiGetAllInstrumentsResponse](/../../schemas/api_get_all_instruments_response)"
|Name<br>`Lite`|Type|Required<br>`Default`| Description |
|-|-|-|-|
|result<br>`r` |[Instrument]|True|List of instruments|
??? info "[Instrument](/../../schemas/instrument)"
|result<br>`r` |[InstrumentDisplay]|True|List of instruments|
??? info "[InstrumentDisplay](/../../schemas/instrument_display)"
|Name<br>`Lite`|Type|Required<br>`Default`| Description |
|-|-|-|-|
|instrument<br>`i` |string|True|The readable instrument name:<ul><li>Perpetual: `ETH_USDT_Perp`</li><li>Future: `BTC_USDT_Fut_20Oct23`</li><li>Call: `ETH_USDT_Call_20Oct23_2800`</li><li>Put: `ETH_USDT_Put_20Oct23_2800`</li></ul>|
Expand All @@ -18,6 +18,9 @@
|min_size<br>`ms` |string|True|The minimum contract size, expressed in base asset decimal units|
|create_time<br>`ct` |string|True|Creation time in unix nanoseconds|
|max_position_size<br>`mp` |string|True|The maximum position size, expressed in base asset decimal units|
|funding_interval_hours<br>`fi` |integer|False<br>`None`|Defines the funding interval to be applied.|
|adjusted_funding_rate_cap<br>`af` |string|False<br>`None`|Funding rate cap over the defined `intervalHours`.|
|adjusted_funding_rate_floor<br>`af1` |string|False<br>`None`|Funding rate floor over the defined `intervalHours`.|
??? info "[Kind](/../../schemas/kind)"
The list of asset kinds that are supported on the GRVT exchange<br>

Expand Down
7 changes: 5 additions & 2 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
@@ -1,8 +1,8 @@
!!! info "[ApiGetFilteredInstrumentsResponse](/../../schemas/api_get_filtered_instruments_response)"
|Name<br>`Lite`|Type|Required<br>`Default`| Description |
|-|-|-|-|
|result<br>`r` |[Instrument]|True|The instruments matching the request filter|
??? info "[Instrument](/../../schemas/instrument)"
|result<br>`r` |[InstrumentDisplay]|True|The instruments matching the request filter|
??? info "[InstrumentDisplay](/../../schemas/instrument_display)"
|Name<br>`Lite`|Type|Required<br>`Default`| Description |
|-|-|-|-|
|instrument<br>`i` |string|True|The readable instrument name:<ul><li>Perpetual: `ETH_USDT_Perp`</li><li>Future: `BTC_USDT_Fut_20Oct23`</li><li>Call: `ETH_USDT_Call_20Oct23_2800`</li><li>Put: `ETH_USDT_Put_20Oct23_2800`</li></ul>|
Expand All @@ -18,6 +18,9 @@
|min_size<br>`ms` |string|True|The minimum contract size, expressed in base asset decimal units|
|create_time<br>`ct` |string|True|Creation time in unix nanoseconds|
|max_position_size<br>`mp` |string|True|The maximum position size, expressed in base asset decimal units|
|funding_interval_hours<br>`fi` |integer|False<br>`None`|Defines the funding interval to be applied.|
|adjusted_funding_rate_cap<br>`af` |string|False<br>`None`|Funding rate cap over the defined `intervalHours`.|
|adjusted_funding_rate_floor<br>`af1` |string|False<br>`None`|Funding rate floor over the defined `intervalHours`.|
??? info "[Kind](/../../schemas/kind)"
The list of asset kinds that are supported on the GRVT exchange<br>

Expand Down
7 changes: 5 additions & 2 deletions artifacts/apidocs/schemas/api_get_instrument_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
!!! info "[ApiGetInstrumentResponse](/../../schemas/api_get_instrument_response)"
|Name<br>`Lite`|Type|Required<br>`Default`| Description |
|-|-|-|-|
|result<br>`r` |Instrument|True|The instrument matching the request asset|
??? info "[Instrument](/../../schemas/instrument)"
|result<br>`r` |InstrumentDisplay|True|The instrument matching the request asset|
??? info "[InstrumentDisplay](/../../schemas/instrument_display)"
|Name<br>`Lite`|Type|Required<br>`Default`| Description |
|-|-|-|-|
|instrument<br>`i` |string|True|The readable instrument name:<ul><li>Perpetual: `ETH_USDT_Perp`</li><li>Future: `BTC_USDT_Fut_20Oct23`</li><li>Call: `ETH_USDT_Call_20Oct23_2800`</li><li>Put: `ETH_USDT_Put_20Oct23_2800`</li></ul>|
Expand All @@ -18,6 +18,9 @@
|min_size<br>`ms` |string|True|The minimum contract size, expressed in base asset decimal units|
|create_time<br>`ct` |string|True|Creation time in unix nanoseconds|
|max_position_size<br>`mp` |string|True|The maximum position size, expressed in base asset decimal units|
|funding_interval_hours<br>`fi` |integer|False<br>`None`|Defines the funding interval to be applied.|
|adjusted_funding_rate_cap<br>`af` |string|False<br>`None`|Funding rate cap over the defined `intervalHours`.|
|adjusted_funding_rate_floor<br>`af1` |string|False<br>`None`|Funding rate floor over the defined `intervalHours`.|
??? 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_order_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
|v<br>`v` |integer|True|Signature V|
|expiration<br>`e` |string|True|Timestamp after which this signature expires, expressed in unix nanoseconds. Must be capped at 30 days|
|nonce<br>`n` |integer|True|Users can randomly generate this value, used as a signature deconflicting key.<br>ie. You can send the same exact instruction twice with different nonces.<br>When the same nonce is used, the same payload will generate the same signature.<br>Our system will consider the payload a duplicate, and ignore it.|
|chain_id<br>`ci` |string|True|Chain ID used in EIP-712 domain. Zero value fallbacks to GRVT Chain ID.|
??? info "[OrderMetadata](/../../schemas/order_metadata)"
Metadata fields are used to support Backend only operations. These operations are not trustless by nature.<br>Hence, fields in here are never signed, and is never transmitted to the smart contract.<br>

Expand All @@ -56,6 +57,7 @@
|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|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|
|allow_crossing<br>`ac` |boolean|False<br>`false`|Specifies if post only order is allowed to cross the orderbook|
??? 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 Expand Up @@ -156,3 +158,4 @@
|`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|
|`INVALID_CHAIN_ID` = 38|the chain ID is invalid|
3 changes: 3 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 @@ -49,6 +49,7 @@
|v<br>`v` |integer|True|Signature V|
|expiration<br>`e` |string|True|Timestamp after which this signature expires, expressed in unix nanoseconds. Must be capped at 30 days|
|nonce<br>`n` |integer|True|Users can randomly generate this value, used as a signature deconflicting key.<br>ie. You can send the same exact instruction twice with different nonces.<br>When the same nonce is used, the same payload will generate the same signature.<br>Our system will consider the payload a duplicate, and ignore it.|
|chain_id<br>`ci` |string|True|Chain ID used in EIP-712 domain. Zero value fallbacks to GRVT Chain ID.|
??? info "[OrderMetadata](/../../schemas/order_metadata)"
Metadata fields are used to support Backend only operations. These operations are not trustless by nature.<br>Hence, fields in here are never signed, and is never transmitted to the smart contract.<br>

Expand All @@ -58,6 +59,7 @@
|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|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|
|allow_crossing<br>`ac` |boolean|False<br>`false`|Specifies if post only order is allowed to cross the orderbook|
??? 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 Expand Up @@ -158,3 +160,4 @@
|`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|
|`INVALID_CHAIN_ID` = 38|the chain ID is invalid|
Loading