PolymarketDocumentation/docs/index.md

Documentation Index

Fetch the complete documentation index at: https://docs.polymarket.com/llms.txt Use this file to discover all available pages before exploring further.

Overview

Build on the world's largest prediction market. Trade, integrate, and access real-time market data with the Polymarket API.

export const IconCard = ({ icon, title, description, href, color }) => { return ( <div className="flex items-center justify-center w-10 h-10 rounded-lg mb-4" style={{ backgroundColor: color ? ${color}1A : "#2E5CFF15" }} > <img src={"/images/icons/" + icon + ".svg"} />

{title}

{description}

); };

🇺🇸 Looking for Polymarket US documentation? Visit US Docs →

Polymarket Documentation

<div className="max-w-2xl px-4  md:px-24 mt-4 text-lg text-gray-500 dark:text-zinc-500">
  Build on the world's largest prediction market. APIs, SDKs, and tools for prediction market developers.
</div>

<div className="grid grid-cols-1 md:grid-cols-2 gap-8 mt-12 px-4  md:px-24 ">
  <div className="flex flex-col justify-center ">
    <h2 className="text-xl font-semibold text-gray-900 dark:text-zinc-50">
      Developer Quickstart
    </h2>

    <p className="mt-3 text-gray-500 dark:text-zinc-400">
      Make your first API request in minutes. Learn the basics of the Polymarket platform, fetch market data, place orders, and redeem winning positions.
    </p>

    <div className="mt-6">
      <a href="/quickstart" className="inline-flex items-center px-4 py-2 text-sm font-medium text-white bg-primary rounded-full hover:bg-indigo-700 transition-colors">
        Get Started →
      </a>
    </div>
  </div>

  <CodeGroup>
    ```typescript TypeScript theme={null}
    import { ClobClient, Side } from "@polymarket/clob-client-v2";

    const client = new ClobClient({ host, chain: chainId, signer, creds });

    const order = await client.createAndPostOrder(
      { tokenID, price: 0.50, size: 10, side: Side.BUY },
      { tickSize: "0.01", negRisk: false }
    );
    ```

    ```python Python theme={null}
    from py_clob_client_v2 import ClobClient, OrderArgs, PartialCreateOrderOptions
    from py_clob_client_v2.order_builder.constants import BUY

    client = ClobClient(host, key=key, chain_id=chain, creds=creds)
    order = client.create_and_post_order(
        OrderArgs(token_id=token_id, price=0.50, size=10, side=BUY),
        options=PartialCreateOrderOptions(tick_size="0.01", neg_risk=False)
    )
    ```

    ```rust Rust theme={null}
    use polymarket_client_sdk_v2::clob::{Client, Config};
    use polymarket_client_sdk_v2::clob::types::Side;
    use polymarket_client_sdk_v2::types::dec;

    let client = Client::new(host, Config::default())?.authentication_builder(&signer).authenticate().await?;
    let order = client.limit_order().token_id(token_id).price(dec!(0.50)).size(dec!(10)).side(Side::Buy).build().await?;
    let signed = client.sign(&signer, order).await?;
    let response = client.post_order(signed).await?;
    ```
  </CodeGroup>
</div>

Get Familiar with Polymarket

<p className="mt-2 text-gray-500 dark:text-zinc-400 max-w-2xl">
  Learn the fundamentals, explore our APIs, and start building on the world's largest prediction market.
</p>

<div className="mt-8">
  <CardGroup cols={2}>
    <Card title="Quickstart" icon="rocket" href="/quickstart">
      Set up your environment and make your first API call in minutes.
    </Card>

    <Card title="Core Concepts" icon="lightbulb" href="/concepts/markets-events">
      Understand markets, events, tokens, and how trading works.
    </Card>

    <Card title="API Reference" icon="code" href="/api-reference/introduction">
      Explore REST endpoints, WebSocket streams, and authentication.
    </Card>

    <Card title="SDKs" icon="cube" href="/api-reference/clients-sdks">
      Official Python, TypeScript, and Rust libraries for faster development.
    </Card>
  </CardGroup>
</div>

<div className="my-12 ">
  <a href="https://builders.polymarket.com" target="_blank">
    <img src="https://mintcdn.com/polymarket-292d1b1b/FOMte3ewbG-LVy3k/images/banner.png?fit=max&auto=format&n=FOMte3ewbG-LVy3k&q=85&s=d83f2f21e8474e998d8ba0f45810d978" alt="Banner" className="w-full rounded-2xl" width="2394" height="549" data-path="images/banner.png" />
  </a>
</div>

  <IconCard icon="quiz" title="Help Desk" description="Get support, report issues, and find answers to common questions" href="https://help.polymarket.com" />

  <IconCard icon="sensor" title="Status" description="Check API uptime, service health, and incident reports" href="https://status.polymarket.com" />
</div>