Repository navigation
Document the live orders and trades export endpoints - #2774
Merged
AlexCatarino merged 1 commit intoOct 15, 2026
Merged
AlexCatarino merged 1 commit into
AlexCatarino merged 1 commit into
Conversation
Add /live/export/orders and /live/export/trades to the API reference, render CSV responses in the generator, add an example that builds the full orders CSV, link the endpoints from the results pages, and add the missing live Trades results page. /live/orders/read filters on deployId, not algorithmId. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #2773.
Adds `/live/export/orders` and `/live/export/trades` (the Download Orders and Download Trades buttons) to the API reference, with an example that builds the full orders CSV: the export's last 750 days plus the older orders from `/live/orders/read`. The results pages now link the endpoints, and the live results docs get the Trades page they were missing. The generator learns to render a `text/csv` response.
`/live/orders/read` filters on `deployId`; the `algorithmId` field it listed is ignored by the endpoint.
`/live/export/trades` documents only `start` (earliest entry time): its `end` filter drops in-range trades until QuantConnect/api.quantconnect.com#2223 is deployed.
Test plan: ran the example against a live project; its CSV matches the export byte for byte plus the older orders. Regenerating the API reference changes no other page. The docs-style linter flags only endpoint paths as slashes.