Skip to content

docs(history): clarify that channel choice affects OHLC candle values#3786

Open
aditya520 wants to merge 1 commit into
mainfrom
hydra/i-hpwotibg/head
Open

docs(history): clarify that channel choice affects OHLC candle values#3786
aditya520 wants to merge 1 commit into
mainfrom
hydra/i-hpwotibg/head

Conversation

@aditya520

@aditya520 aditya520 commented Jun 1, 2026

Copy link
Copy Markdown
Member

Summary

  • Adds a <Callout type="warn"> near the base URL section explaining that {channel} materially affects both /{channel}/price and /{channel}/history results.
  • Adds a worked example (MSFT pyth_lazer_id=1292, 2026-05-29) showing how the 15:59 one-minute candle high differs across real_time/fixed_rate@50ms, fixed_rate@200ms, and fixed_rate@1000ms.
  • Docs-only change scoped to history.mdx. No API or code changes.

Context: [[i-ctkicqtd]]


Open in Devin Review

Add a warning callout and worked example (MSFT, 2026-05-29) showing how
different channels produce different candle highs/lows due to sampling
rate differences. Helps users pick the right channel for settlement,
backtesting, and exact-price workflows.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@vercel

vercel Bot commented Jun 1, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
component-library Ready Ready Preview, Comment Jun 1, 2026 4:38pm
developer-hub Ready Ready Preview, Comment Jun 1, 2026 4:38pm
5 Skipped Deployments
Project Deployment Actions Updated (UTC)
api-reference Skipped Skipped Jun 1, 2026 4:38pm
entropy-explorer Skipped Skipped Jun 1, 2026 4:38pm
insights Skipped Skipped Jun 1, 2026 4:38pm
proposals Skipped Skipped Jun 1, 2026 4:38pm
staking Skipped Skipped Jun 1, 2026 4:38pm

Request Review

@vercel vercel Bot temporarily deployed to Preview – insights June 1, 2026 16:36 Inactive
@vercel vercel Bot temporarily deployed to Preview – api-reference June 1, 2026 16:36 Inactive
@vercel vercel Bot temporarily deployed to Preview – staking June 1, 2026 16:36 Inactive
@vercel vercel Bot temporarily deployed to Preview – entropy-explorer June 1, 2026 16:36 Inactive
@vercel vercel Bot temporarily deployed to Preview – proposals June 1, 2026 16:36 Inactive

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Devin Review found 1 potential issue.

View 2 additional findings in Devin Review.

Open in Devin Review


| Channel | Candle high |
| ---------------------------------- | ----------- |
| `real_time` / `fixed_rate@50ms` | `450.01` |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Example candle high (450.01) contradicts the sample price data (max 450.00000)

The worked example at lines 134–139 lists four specific prices "published around market close" on fixed_rate@50ms, the highest being 450.00000. However, the candle high table at line 145 claims the real_time / fixed_rate@50ms candle high is 450.01 — a value that exceeds every price shown in the sample data. This is internally contradictory: a candle high cannot exceed the maximum published price within the window. Either the sample data table is missing rows that include a 450.01 tick, or the candle high should be 450.00000 (or 450.00). As written, the example will confuse developers trying to learn how channel resolution affects candle values, which undermines the purpose of the new documentation.

Prompt for agents
The candle high for real_time / fixed_rate@50ms is listed as 450.01 but the sample data table (lines 134-139) only shows prices up to 450.00000. These must be reconciled: either add the missing price tick(s) that produced the 450.01 high to the sample data table, or correct the candle high to match the data shown (e.g. 450.00). The explanation paragraph at lines 149-152 may also need updating depending on which values are corrected.
Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant