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 here | Then read |
|---|---|---|
| New to Polymarket | Polymarket API Overview | Markets, Events & Tokens, Docs Map |
| Installing Polygolem | Installation | Quick Start |
| Exploring markets with no wallet | Quick Start | Market Discovery, Orderbook Data |
| Simulating a strategy | Paper Trading | Go-Bot Integration, Universal Client |
| Studying public wallets | Wallet Intelligence | Data API, Safety Model |
| Preparing live trading | Safety Model | Deposit Wallet Lifecycle, POLY_1271 Signing Chain |
| Integrating from another tool | MCP and OpenAPI | Go SDK Contracts, CLI Commands |
| Auditing protocol details | Polymarket API Overview | Smart Contracts, Coverage Matrix |
Safety ladder
- No-wallet reads — health, market search, order books, streams, public wallet data, and local diagnostics. No secrets required.
- Paper workflows — simulate fills against live CLOB prices while keeping all state local.
- Readiness checks — inspect deposit-wallet address, relayer auth, balances, approvals, tick sizes, fee rates, and stale-market guards.
- 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 signatureThe 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.