Polymarket

Polymarket Documentation

Docs

• Create deposit addresses: Generate unique deposit addresses for depositing assets to your Polymarket wallet.

How it works:

1. Submit your Polymarket wallet address
2. Receive deposit addresses for each blockchain type (EVM, Solana, Bitcoin)
3. Send assets from any supported chain to the appropriate deposit address
4. Assets are automatically bridged and swapped to USDC.e on Polygon
5. USDC.e is credited to your Polymarket wallet for trading

Supported Assets: Use /supported-assets to see all available chains and tokens you can deposit from.

• Create withdrawal addresses: Generate unique deposit addresses for withdrawing USDC.e from your Polymarket wallet to any supported chain and token.

How it works:

1. Specify your Polymarket wallet address, destination chain, token, and recipient address
2. Receive deposit addresses for each blockchain type (EVM, Solana, Bitcoin)
3. Send USDC.e from your Polymarket wallet to the appropriate deposit address
4. Funds are automatically bridged and swapped to your desired token
5. Funds arrive at your destination wallet

Supported Destinations: Use /supported-assets to see all available chains and tokens you can withdraw to.

• Get a quote: Get an estimated quote for a deposit or withdrawal, including output amounts, checkout time, and a detailed fee breakdown.

Use Cases:

• Preview fees and estimated output before executing a deposit or withdrawal
• Compare costs across different token/chain combinations
• Get the quoteId to reference this specific quote

Notes:

• Quotes are estimates and actual amounts may vary slightly due to market conditions

• See /supported-assets for a list of all supported chains and tokens

• Get supported assets: Retrieve all supported chains and tokens for deposits and withdrawals.

USDC.e on Polygon: Polymarket uses USDC.e (Bridged USDC from Ethereum) on Polygon as the native collateral for all markets. When you deposit assets from other chains, they are automatically bridged and swapped to USDC.e on Polygon. When you withdraw, your USDC.e is bridged and swapped to your desired token on the destination chain.

Minimum Amounts: Each asset has a minCheckoutUsd field indicating the minimum amount required in USD. Make sure your deposit or withdrawal meets this minimum to avoid transaction failures.

• Get transaction status: Get the transaction status for all deposits and withdrawals associated with a given address.

Usage:

• Use the deposit address returned from the /deposit or /withdraw endpoint (EVM, SVM, or BTC address)
• Poll this endpoint to track the progress of your deposits and withdrawals

Status Values:

• DEPOSIT_DETECTED: Funds detected but not yet processing
• PROCESSING: Transaction is being routed and swapped
• ORIGIN_TX_CONFIRMED: Origin transaction has been confirmed on source chain
• SUBMITTED: Transaction has been submitted to destination chain
• COMPLETED: Transaction completed successfully
• FAILED: Transaction encountered an error and did not complete

Notes:

• Transactions typically complete within a few minutes, but may take longer depending on network conditions

• An empty transactions array means no transactions have been made to this address yet

• Get aggregated builder leaderboard: Returns aggregated builder rankings with one entry per builder showing total for the specified time period. Supports pagination.

• Get daily builder volume time-series: Returns daily time-series volume data with multiple entries per builder (one per day), each including a dt timestamp. No pagination.

• Get comments by comment id

• Get comments by user address

• List comments

• Get closed positions for a user: Fetches closed positions for a user(address)

• Get current positions for a user: Returns positions filtered by user and optional filters.

• Get top holders for markets

• Get total value of a user's positions

• Get trader leaderboard rankings: Returns trader leaderboard rankings filtered by category, time period, and ordering.

• Get trades for a user or markets

• Get user activity: Returns on-chain activity for a user.

• Data API Health check

• Get event by id

• Get event by slug

• Get event tags

• List events

• Gamma API Health check

• Get market by id

• Get market by slug

• Get market tags by id

• List markets

• Download an accounting snapshot (ZIP of CSVs): Public endpoint (no auth) that returns an application/zip containing two CSV files generated from the same snapshot time.

ZIP contents

1. positions.csv (0+ rows)

• Columns (in order):
  • conditionId (string): market condition id
  • asset (string): outcome token id (uniquely identifies the position within a market)
  • size (number): tokens, 6 decimals
  • curPrice (number): per-token price/value in USDC, 6 decimals
  • valuationTime (string): RFC3339 UTC timestamp

2. equity.csv (0 or 1 row)

• Columns (in order):
  • cashBalance (number): onchain USDC balanceOf(user) using Polygon USDC 0x2791bca1f2de4661ed88a30c99a7a9449aa84174, 6 decimals
  • positionsValue (number): (\sum(\text{size} \times \text{curPrice})) across positions.csv, 6 decimals
  • equity (number): cashBalance + positionsValue, 6 decimals
  • valuationTime (string): RFC3339 UTC timestamp (same snapshot time as positions.csv)

Example positions.csv

conditionId,asset,size,curPrice,valuationTime
0xd007d71fd17b0913b9d7ff198f617caa96a9e4aab1bed7d6f9abd76bb17dd507,65396714035221124737265515219989336303267439172398528294132309725835127126381,90548.087076,0.064500,2026-01-21T18:30:00Z
0x96f6fb6567b5938fc3c2e75f9829d7287340b9581a9c4817b8bc0aff82e1c45f,10057237541929696185971116542487795282113077727880089878027691009747516185940,45666.487374,0.495000,2026-01-21T18:30:00Z

Example equity.csv

cashBalance,positionsValue,equity,valuationTime
125000.000000,28481009.037705,28606009.037705,2026-01-21T18:30:00Z

• Get live volume for an event

• Get open interest

• Get total markets a user has traded

• Get multiple order books summaries by request: Retrieves order book summaries for specified tokens via POST request

• Get order book summary: Retrieves the order book summary for a specific token

• Get market price: Retrieves the market price for a specific token and side

• Get midpoint price: Retrieves the midpoint price for a specific token

• Get multiple market prices: Retrieves market prices for multiple tokens and sides

• Get multiple market prices by request: Retrieves market prices for specified tokens and sides via POST request

• Get price history for a traded token: Fetches historical price data for a specified market token

• Get public profile by wallet address

• Search markets, events, and profiles

• Get series by id

• List series

• Get sports metadata information: Retrieves metadata for various sports including images, resolution sources, ordering preferences, tags, and series information. This endpoint provides comprehensive sport configuration data used throughout the platform.

• Get valid sports market types: Get a list of all valid sports market types available on the platform. Use these values when filtering markets by the sportsMarketTypes parameter.

• List teams

• Get bid-ask spreads: Retrieves bid-ask spreads for multiple tokens

• Get related tags (relationships) by tag id

• Get related tags (relationships) by tag slug

• Get tag by id

• Get tag by slug

• Get tags related to a tag id

• Get tags related to a tag slug

• List tags

• Polymarket Changelog: Welcome to the Polymarket Changelog. Here you will find any important changes to Polymarket, including but not limited to CLOB, API, UI and Mobile Applications.

• Authentication: Understanding authentication using Polymarket's CLOB

• Builder Methods: These methods require builder API credentials and are only relevant for Builders Program order attribution.

• L1 Methods: These methods require a wallet signer (private key) but do not require user API credentials. Use these for initial setup.

• L2 Methods: These methods require user API credentials (L2 headers). Use these for placing trades and managing user's positions.

• Methods Overview: CLOB client methods require different levels of authentication. This reference is organized by what credentials you need to call each method.

• Public Methods: These methods can be called without a signer or user credentials. Use these for reading market data, prices, and order books.

• Geographic Restrictions: Check geographic restrictions before placing orders on Polymarket's CLOB

• CLOB Introduction

• Cancel Orders(s): Multiple endpoints to cancel a single order, multiple orders, all orders or all orders from a single market.

• Check Order Reward Scoring: Check if an order is eligble or scoring for Rewards purposes

• Place Single Order: Detailed instructions for creating, placing, and managing orders using Polymarket's CLOB API.

• Place Multiple Orders (Batching): Instructions for placing multiple orders(Batch)

• Get Active Orders

• Get Order: Get information about an existing order

• Onchain Order Info

• Orders Overview: Detailed instructions for creating, placing, and managing orders using Polymarket's CLOB API.

• Quickstart: Initialize the CLOB and place your first order.

• null

• Historical Timeseries Data: Fetches historical price data for a specified market token.

• Get Trades

• Trades Overview

• Market Channel

• User Channel

• WSS Authentication

• WSS Overview: Overview and general information about the Polymarket Websocket

• Deployment and Additional Information

• Merging Tokens

• Overview

• Reedeeming Tokens

• Splitting USDC

• RTDS Comments

• RTDS Crypto Prices

• Real Time Data Socket

• Blockchain Data Resources: Access Polymarket on-chain activity for data & analytics

• Builder Program Introduction: Learn about Polymarket's Builder Program and how to integrate

• Builder Profile & Keys: Learn how to access your builder profile and obtain API credentials

• Builder Tiers: Permissionless integration with tiered rate limits, rewards, and revenue generating opportunities as you scale

• Examples: Complete Next.js applications demonstrating Polymarket builder integration

• Order Attribution: Learn how to attribute orders to your builder account

• Relayer Client: Use Polymarket's Polygon relayer to execute gasless transactions for your users

• How to Fetch Markets

• Gamma Structure

• null

• Data Feeds: Real-time and historical data sources for market makers

• Market Maker Introduction: Overview of market making on Polymarket and available tools for liquidity providers

• Inventory Management: Split, merge, and redeem outcome tokens for market making

• Liquidity Rewards: Polymarket provides incentives aimed at catalyzing the supply and demand side of the marketplace. Specifically there is a public liquidity rewards program as well as one-off public pnl/volume competitions.

• Maker Rebates Program: Technical guide for handling taker fees and earning maker rebates on Polymarket

• Setup: One-time setup for market making on Polymarket: deposits, approvals, wallets, and API keys

• Trading: CLOB order entry and management for market makers

• Overview: Bridge and swap assets to Polymarket

• Overview

• null

• Resolution

• Message Format: Structure of sports result update messages

• Overview: Real-time sports results via WebSocket

• Quickstart: Connect to the Sports WebSocket and receive live updates

• null

• Does Polymarket have an API?: Getting data from Polymarket

• How To Use Embeds: Adding market embeds to your Substack or website.

• Geographic Restrictions: Countries and regions where Polymarket is restricted

• How Do I Export My Key?: Exporting your private key on Magic.Link

• Is My Money Safe?: Yes. Polymarket is non-custodial, so you're in control of your funds.

• Is Polymarket The House?: No, Polymarket is not the house. All trades happen peer-to-peer (p2p).

• Polymarket vs. Polling: How is Polymarket better than traditional / legacy polling?

• Recover Missing Deposit: If you deposited the wrong cryptocurrency on Ethereum or Polygon, use these tools to recover those funds.

• Can I Sell Early?

• How Do I Contact Support?: Polymarket offers technical support through our website chat feature, and through Discord.

• Does Polymarket Have a Token?

• What is a Prediction Market?: How people collectively forecast the future.

• Why Crypto?: Why Polymarket uses crypto and blockchain technology to create the world’s largest Prediction market.

• Deposit with Coinbase: How to buy and deposit USDC to your Polymarket account using Coinbase.

• How to Withdraw: How to withdraw your cash balance from Polymarket.

• Large Cross Chain Deposits

• Deposit Using Your Card: Use MoonPay to deposit cash using your Visa, Mastercard, or bank account.

• Deposit by Transfering Crypto: Learn what Tokens and Chains are supported for deposit.

• Deposit USDC on Ethereum: How to deposit USDC on the Ethereum Network to your Polymarket account.

• How to Deposit: How to add cash to your balance on Polymarket.

• How to Sign-Up: How to create a Polymarket account.

• Making Your First Trade: How to buy shares.

• What is Polymarket?

• How Are Markets Disputed?

• How Are Markets Clarified?: How are markets on Polymarket clarified?

• How Are Markets Created?: Markets are created by the markets team with input from users and the community.

• How Are Prediction Markets Resolved?: Markets are resolved by the UMA Optimistic Oracle, a smart-contract based optimistic oracle.

• Trading Fees

• Holding Rewards

• How Are Prices Calculated?: The prices probabilities displayed on Polymarket are the midpoint of the bid-ask spread in the orderbook.

• Limit Orders: What are limit orders and how to make them.

• Liquidity Rewards: Learn how to earn rewards merely by placing trades on Polymarket

• Maker Rebates Program

• Market Orders: How to buy shares.

• Does Polymarket Have Trading Limits?

• Using the Order Book: Understanding the Order Book will help you become an advanced trader.

• Fetching Market Data: Fetch Polymarket data in minutes with no authentication required

• Placing Your First Order: Set up authentication and submit your first trade

• API Rate Limits

• Developer Quickstart: Get started building with Polymarket APIs

• Endpoints: All Polymarket API URLs and base endpoints

• Glossary: Key terms and concepts for Polymarket developers

• WSS Quickstart

Optional

• Polymarket
• Discord Community
• Twitter