Document the Object Store download permission rule - #2685
Merged
AlexCatarino merged 1 commit intoSep 17, 2026
Merged
AlexCatarino merged 1 commit into
AlexCatarino merged 1 commit into
Conversation
AlexCatarino
force-pushed
the
feature-object-store-download-docs
branch
from
September 16, 2026 23:15
71cdb15 to
ddb8551
Compare
Downloading from the Object Store is an Institution tier entitlement that covers every file in the store, but the docs only said "contact us to unlock this feature", so every tier writes to support. State the rule, the tiers it excludes, the API/CLI error, and the in-cloud alternatives on the Download Files pages, cross-link it from the Institution and Trading Firm tier pages, the storage sizes table, and the /object/get API reference, and fix the broken mailto. Also link each item on the backtest Download Results page to its section, and note on Runtime Statistics that custom statistics reach the banner, report and download, with the limits from LEAN #9760. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
AlexCatarino
force-pushed
the
feature-object-store-download-docs
branch
from
September 16, 2026 23:18
ddb8551 to
2e495f0
Compare
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
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.
Summary
"How do I download my files from the Object Store?" is the most repeated support question with a fixed policy answer. The current Download Files page only says "contact us to unlock this feature", so every tier emails support and most get told no.
Resources/object-store/download-files-from-cloud-permission.php(shared by the Cloud Platform, Organizations, and LEAN CLI Download Files pages) to state the rule up front: Institution tier plus the derived data agreement, not available on the other tiers, storage subscriptions don't change it, the gate covers every file including uploads and algorithm output, raw data is never exportable, and the API/CLI error textOrganization does not have derivative export enabled. Lists the in-cloud alternatives (read in Research or a backtest, Download Results, log quota,lean cloud pullfor project files). Replaces the brokenmailtowith the pricing page's demo wording and/appointmentslink.download-files-from-cloud.phpto permissioned organizations and drop the old fallback paragraph (moved into the list above).descriptionto/object/getin the OpenAPI spec and regenerate the Get Object Store File reference, which adds a Description page and renumbers Request and Responses (no docs link to those anchors).download, export, derivative export, institutionto both Object Store section keywords.Test plan
code-generators/API-Reference-Code-Generator.pyregenerated only the Get Object Store File folder; Request and Responses are byte-identical to the previous files.vacuum lint QuantConnect-Platform-2.0.0.yaml --fail-severity errorpasses./docs/v2/...#anchorin the changed files resolves throughdoc_anchors.check_section_anchor./object/geterrorsarray verbatim (lean/components/api/api_client.py), so the error text customers quote appears in both the API and CLI.