Skip to content

Docs Map

Use this map when you know the job you need done but not which Polygolem page owns it. The docs are organized around a safety ladder: read first, simulate second, mutate only after explicit wallet and protocol checks.

Choose your path

If you are…Start hereThen read
New to PolymarketPolymarket API OverviewMarkets, Events & Tokens, Docs Map
Installing PolygolemInstallationQuick Start
Exploring markets with no walletQuick StartMarket Discovery, Orderbook Data
Simulating a strategyPaper TradingGo-Bot Integration, Universal Client
Studying public walletsWallet IntelligenceData API, Safety Model
Preparing live tradingSafety ModelDeposit Wallet Lifecycle, POLY_1271 Signing Chain
Integrating from another toolMCP and OpenAPIGo SDK Contracts, CLI Commands
Auditing protocol detailsPolymarket API OverviewSmart Contracts, Coverage Matrix

Safety ladder

  1. No-wallet reads — health, market search, order books, streams, public wallet data, and local diagnostics. No secrets required.
  2. Paper workflows — simulate fills against live CLOB prices while keeping all state local.
  3. Readiness checks — inspect deposit-wallet address, relayer auth, balances, approvals, tick sizes, fee rates, and stale-market guards.
  4. Tiny capped mutations — only after POLYMARKET_PRIVATE_KEY, deposit wallet/POLY_1271 mode, confirmations, and operator stop conditions are clear.

Mental model

Question/event ──▶ market ──▶ YES/NO outcome tokens ──▶ CLOB order book
Public APIs ──▶ read-only CLI/SDK ──▶ paper state
│ │
└──▶ intelligence signals └──▶ operator confidence
EOA key ──▶ CLOB auth + local signing ──▶ deposit wallet maker/signer
└──▶ POLY_1271 order signature

The EOA authenticates and signs; the deposit wallet is the on-order maker and holds pUSD/CTF positions. Polygolem keeps those identities separate throughout the docs and API surface.

Source-of-truth rule

The web docsite is the navigation layer. Long protocol facts should point back to canonical Markdown under docs/ or stable package contracts under pkg/. When pages disagree, prefer the canonical source and update this site to link or summarize it.