Skip to content

[CP-575] add depth parameter orderbooks v2 requests #180

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
aarmoa merged 1 commit into from
Aug 18, 2025
Merged

[CP-575] add depth parameter orderbooks v2 requests #180

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
1 change: 1 addition & 0 deletions source/includes/_derivativesrpc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3083,6 +3083,7 @@ func main() {
| Parameter | Type | Description | Required |
| ---------- | ------------ | ------------------------------------------------------ | -------- |
| market_ids | String Array | List of IDs of markets to get orderbook snapshots from | Yes |
| depth | Integer | The depth of the orderbook | Yes |
Copy link

Copilot AI Aug 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description 'The depth of the orderbook' is too vague. Consider providing more specific details about what depth means (e.g., 'Maximum number of price levels to return for both bids and asks' or 'Number of order book levels to include in the response').

Suggested change
| depth | Integer | The depth of the orderbook | Yes |
| depth | Integer | Maximum number of price levels to return for both bids and asks | Yes |

Copilot uses AI. Check for mistakes.


### Response Parameters
Expand Down
1 change: 1 addition & 0 deletions source/includes/_spotrpc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1894,6 +1894,7 @@ func main() {
| Parameter | Type | Description | Required |
| ---------- | ------------ | ------------------------------------------------------ | -------- |
| market_ids | String Array | List of IDs of markets to get orderbook snapshots from | Yes |
| depth | Integer | The depth of the orderbook | Yes |
Copy link

Copilot AI Aug 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description 'The depth of the orderbook' is too vague. Consider providing more specific details about what depth means (e.g., 'Maximum number of price levels to return for both bids and asks' or 'Number of order book levels to include in the response').

Suggested change
| depth | Integer | The depth of the orderbook | Yes |
| depth | Integer | Maximum number of price levels to return for both bids and asks | Yes |

Copilot uses AI. Check for mistakes.

Comment on lines 1894 to 1898
Copy link

@coderabbitai coderabbitai bot Aug 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Clarify depth semantics (0 = full depth, per-side, truncation) and align wording across docs

The current description is vague. Given other examples in this file use depth=0 to fetch a full snapshot, please state that explicitly, note that depth is per side, and mention truncation to any server-defined max. Also ensure the same phrasing is used in derivatives docs for consistency.

Apply this diff to improve the description:

-| depth | Integer | The depth of the orderbook | Yes |
+| depth | Integer | Maximum number of price levels to return per side; 0 returns full depth. Values above the server-defined maximum are truncated. | Yes |

Run this script to verify consistency of the “depth” parameter wording across Spot and Derivatives OrderbooksV2 docs:

🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "== Checking OrderbooksV2 sections =="
rg -n -C2 '^##\s+OrderbooksV2$' source/includes

echo
echo "== Checking depth parameter rows =="
rg -n -C1 '^\|\s*depth\s*\|\s*Integer\s*\|' source/includes

echo
echo "== Show full Request Parameters tables around depth for quick inspection =="
rg -n -C6 '^\|\s*depth\s*\|\s*Integer\s*\|' source/includes/_spotrpc.md || true
rg -n -C6 '^\|\s*depth\s*\|\s*Integer\s*\|' source/includes/_derivativesrpc.md || true

Length of output: 2699

Update depth parameter description in Spot and Derivatives OrderbooksV2 docs

Both Spot and Derivatives OrderbooksV2 reference tables currently say “The depth of the orderbook”. To clarify that 0 returns a full, per-side snapshot and larger values are truncated, update both tables as follows:

• source/includes/_spotrpc.md:1897
• source/includes/_derivativesrpc.md:3086

-| depth | Integer | The depth of the orderbook | Yes |
+| depth | Integer | Maximum number of price levels to return per side; 0 returns full depth. Values above the server-defined maximum are truncated. | Yes |
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
| Parameter | Type | Description | Required |
| ---------- | ------------ | ------------------------------------------------------ | -------- |
| market_ids | String Array | List of IDs of markets to get orderbook snapshots from | Yes |
| depth | Integer | The depth of the orderbook | Yes |
| Parameter | Type | Description | Required |
| ---------- | ------------ | ---------------------------------------------------------------------------------------------------------------------- | -------- |
| market_ids | String Array | List of IDs of markets to get orderbook snapshots from | Yes |
| depth | Integer | Maximum number of price levels to return per side; 0 returns full depth. Values above the server-defined maximum are truncated. | Yes |
🧰 Tools
🪛 LanguageTool

[grammar] ~1894-~1894: There might be a mistake here.
Context: ... | Required | | ---------- | ------------ | ----------...

(QB_NEW_EN)

[grammar] ~1895-~1895: There might be a mistake here.
Context: ...--------------------------- | -------- | | market_ids | String Array | List of ID...

(QB_NEW_EN)

[grammar] ~1896-~1896: There might be a mistake here.
Context: ...et orderbook snapshots from | Yes | | depth | Integer | The depth of the ord...

(QB_NEW_EN)

🤖 Prompt for AI Agents 
In source/includes/_spotrpc.md around lines 1894–1898 and
source/includes/_derivativesrpc.md around line 3086, update the "depth"
parameter description to clarify behavior: replace "The depth of the orderbook"
with a concise explanation such as "Depth of the orderbook; 0 returns a full
per-side snapshot, values >0 return the top N levels per side (truncated)."
Ensure the wording is consistent in both files and preserves table formatting.


### Response Parameters
Expand Down