docs(stocks): document candle split/dividend adjustment rules#158
Open
MarketDataDev01 wants to merge 2 commits into
Open
docs(stocks): document candle split/dividend adjustment rules#158MarketDataDev01 wants to merge 2 commits into
MarketDataDev01 wants to merge 2 commits into
Conversation
Companion to api PR #212, which unifies the adjustsplits/adjustdividends contract on the stock candles endpoint and the Sheets STOCKDATA formula. - api/stocks/candles.mdx: document the previously-undocumented `adjustdividends` parameter and add a "Split and Dividend Adjustments" section covering the three supported CRSP-style views (raw, split-only, fully adjusted) and the combinations now rejected with HTTP 400 (daily divs-only; any adjustdividends=true on intraday). - sheets/stocks/stockdata.md: correct the `adjusted`/`unadjusted` attribute descriptions and document them as standalone attributes that return a full OHLCV row (parity with "all").
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.
Companion documentation for API PR #212, which unifies the
adjustsplits/adjustdividendscontract across the stock candles endpoint and the SheetsSTOCKDATAformula.Changes
api/stocks/candles.mdxadjustdividendsparameter, which was not previously listed on this page (onlyadjustsplitswas).adjustsplits=false, adjustdividends=true(dividend-only) — most often reached by passingadjustsplits=falsealone, sinceadjustdividendsdefaults totrueon daily.adjustdividends=true(no intraday source implements dividend adjustment).sheets/stocks/stockdata.mdadjusted/unadjustedattribute descriptions.all), or that can be combined with a specific column (e.g.unadjusted,close).Notes
stagingper the docs workflow.