Skip to content

docs: clarify historical fetch order book usage#837

Open
realfishsam wants to merge 2 commits into
mainfrom
docs/fetch-order-book-historical-clarity
Open

docs: clarify historical fetch order book usage#837
realfishsam wants to merge 2 commits into
mainfrom
docs/fetch-order-book-historical-clarity

Conversation

@realfishsam
Copy link
Copy Markdown
Contributor

Summary

  • Clarify that Polymarket fetch_order_book(token_id) without historical params uses the live CLOB only and can fail for closed/resolved markets.
  • Document archive-backed historical snapshot/range behavior and distinguish it from live order book calls.
  • Use fetch_event(slug=...) with nested markets for crypto 5m event slugs.
  • Fix curl Authorization header quote syntax and note raw bulk Parquet access via PMXT Archive.

Closes #836

Test plan

  • Inspected package.json docs scripts; no dedicated docs/MDX validation script was present.
  • Ran a Node sanity check for balanced MDX code fences and component tags, plus curl Authorization header syntax.
  • Ran git diff --check.

@mintlify
Copy link
Copy Markdown

mintlify Bot commented Jun 2, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
PMXT 🟢 Ready View Preview Jun 2, 2026, 11:39 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

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.

Docs: clarify live vs historical fetchOrderBook for Polymarket archives

1 participant