Polymarket

https://docs.polymarket.com/developers
Admin
Polymarket is a prediction market platform that enables users to trade on real-world events, with...
Tokens:120,539
Snippets:372
Trust Score:9.9
Update:8 months ago
Show doc for...
Tokens:
Raw
### Create and Post Order - TypeScript and Python

Source: https://docs.polymarket.com/developers/CLOB/quickstart

Initialize a CLOB client with API credentials and create a buy order on Polygon mainnet. This example demonstrates the complete workflow from wallet setup through order placement, supporting both TypeScript and Python implementations with identical functionality.

```typescript
import { ClobClient, Side } from "@polymarket/clob-client";
import { Wallet } from "ethers";

async function trade() {
  const HOST = "https://clob.polymarket.com";
  const CHAIN_ID = 137; // Polygon mainnet
  const signer = new Wallet(process.env.PRIVATE_KEY);

  const tempClient = new ClobClient(HOST, CHAIN_ID, signer);
  const apiCreds = await tempClient.createOrDeriveApiKey();

  const signatureType = 0;

  const client = new ClobClient(
    HOST,
    CHAIN_ID,
    signer,
    apiCreds,
    signatureType
  );

  const response = await client.createAndPostOrder({
    tokenID: "YOUR_TOKEN_ID",
    price: 0.65,
    size: 10,
    side: Side.BUY,
  });

  console.log(`Order placed! ID: ${response.orderID}`);
}

trade();
```

```python
from py_clob_client.client import ClobClient
from py_clob_client.clob_types import OrderArgs
from py_clob_client.order_builder.constants import BUY
import asyncio
import os

async def trade():
    host = "https://clob.polymarket.com"
    chain_id = 137 # Polygon mainnet
    private_key = os.getenv("PRIVATE_KEY")

    temp_client = ClobClient(host, key=private_key, chain_id=chain_id)
    creds = await temp_client.create_or_derive_api_key()

    signature_type=0

    client = ClobClient(
        host,
        chain_id=chain_id,
        key=private_key,
        creds=creds,
        signature_type=signature_type
    )

    response = await client.create_and_post_order(
        OrderArgs(
            token_id="YOUR_TOKEN_ID",
            price=0.65,
            size=10,
            side=BUY
        )
    )

    print(f"Order placed! ID: {response['orderID']}")

if __name__ == "__main__":
    asyncio.run(trade())
```

--------------------------------

### Install CLOB Client Library

Source: https://docs.polymarket.com/developers/CLOB/quickstart

Install the Polymarket CLOB client package and dependencies for your programming language. TypeScript requires ethers v5.8.0, Python uses py-clob-client, and Rust uses polymarket-client-sdk.

```bash
npm install @polymarket/clob-client ethers
```

```bash
pip install py-clob-client
```

```bash
cargo add polymarket-client-sdk
```

--------------------------------

### Setup CLOB Client with API Credentials

Source: https://docs.polymarket.com/developers/CLOB/quickstart

Initialize the ClobClient with wallet credentials and derive API keys for authentication. This sets up the trading client with Polygon mainnet (chain ID 137) and creates or retrieves existing API credentials for secure API access.

```typescript
import { ClobClient } from "@polymarket/clob-client";
import { Wallet } from "ethers"; // v5.8.0

const HOST = "https://clob.polymarket.com";
const CHAIN_ID = 137; // Polygon mainnet
const signer = new Wallet(process.env.PRIVATE_KEY);

// Create or derive user API credentials
const tempClient = new ClobClient(HOST, CHAIN_ID, signer);
const apiCreds = await tempClient.createOrDeriveApiKey();

// See 'Signature Types' note below
const signatureType = 0;

// Initialize trading client
const client = new ClobClient(
  HOST, 
  CHAIN_ID, 
  signer, 
  apiCreds, 
  signatureType
);
```

```python
from py_clob_client.client import ClobClient
import os

host = "https://clob.polymarket.com"
chain_id = 137 # Polygon mainnet
private_key = os.getenv("PRIVATE_KEY")

# Create or derive user API credentials
temp_client = ClobClient(host, key=private_key, chain_id=chain_id)
api_creds = await temp_client.create_or_derive_api_key()

# See 'Signature Types' note below
signature_type = 0

# Initialize trading client
client = ClobClient(
    host,
    key=private_key,
    chain_id=chain_id,
    creds=api_creds,
    signature_type=signature_type
)
```

--------------------------------

### Initialize ClobClient with Builder Credentials to Get Builder Orders (TypeScript, Python)

Source: https://docs.polymarket.com/developers/CLOB/clients/methods-overview

This example demonstrates initializing the ClobClient with specific builder authentication headers and configuration. This setup enables access to specialized builder methods, such as retrieving builder-specific trade data, in addition to all other public, L1, and L2 functionalities.

```typescript
// Create client with builder's authentication headers
import { BuilderConfig, BuilderApiKeyCreds } from "@polymarket/builder-signing-sdk";

const builderCreds: BuilderApiKeyCreds = {
  key: process.env.POLY_BUILDER_API_KEY!,
  secret: process.env.POLY_BUILDER_SECRET!,
  passphrase: process.env.POLY_BUILDER_PASSPHRASE!
};

const builderConfig: BuilderConfig = {
  localBuilderCreds: builderCreds
};

const client = new ClobClient(
  "https://clob.polymarket.com", 
  137, 
  signer,
  creds, // User's API credentials
  2,
  funder,
  undefined,
  false,
  builderConfig // Builder's API credentials
);

// You can call all methods including builder methods
const builderTrades = await client.getBuilderTrades();
```

```python
# Create client with builder's authentication headers
from py_clob_client.client import ClobClient
from py_clob_client.clob_types import ApiCreds
from py_builder_signing_sdk.config import BuilderConfig, BuilderApiKeyCreds

builder_creds = BuilderApiKeyCreds(
    key="POLY_BUILDER_API_KEY",
    secret="POLY_BUILDER_SECRET,
    passphrase="POLY_BUILDER_PASSPHRASE"
)

builder_config = BuilderConfig(
    local_builder_creds=builder_creds
)

client = ClobClient(
    host="https://clob.polymarket.com",
    chain_id=137,
    key="private_key",
    creds=creds, # User's API credentials
    signature_type=2,
    funder=funder_address,
    builder_config=builder_config # Builder's API credentials
)

# You can call all methods including builder methods
builder_trades = client.get_builder_trades()
```

--------------------------------

### Place a Limit Order

Source: https://docs.polymarket.com/developers/CLOB/quickstart

Create and post a limit order to buy or sell shares at a specified price. Requires a token ID (obtained from Gamma API), price per share, order size, and side (BUY or SELL). Returns the order ID upon successful placement.

```typescript
import { Side } from "@polymarket/clob-client";

// Place a limit order in one step
const response = await client.createAndPostOrder({
  tokenID: "YOUR_TOKEN_ID", // Get from Gamma API
  price: 0.65, // Price per share
  size: 10, // Number of shares
  side: Side.BUY, // or SELL
});

console.log(`Order placed! ID: ${response.orderID}`);
```

```python
from py_clob_client.clob_types import OrderArgs
from py_clob_client.order_builder.constants import BUY

# Place a limit order in one step
response = await client.create_and_post_order(
    OrderArgs(
        token_id="YOUR_TOKEN_ID",  # Get from Gamma API
        price=0.65,                # Price per share
        size=10,                   # Number of shares
        side=BUY,                  # or SELL
    )
)

print(f"Order placed! ID: {response['orderID']}")
```

--------------------------------

### Initialize CLOB Client with API Credentials - TypeScript

Source: https://docs.polymarket.com/developers/CLOB/quickstart

Demonstrates the proper initialization of a ClobClient with API credentials to resolve L2_AUTH_NOT_AVAILABLE errors. This snippet shows the required two-step process: first creating temporary client to derive API credentials, then creating the authenticated client.

```typescript
const creds = await clobClient.createOrDeriveApiKey();
const client = new ClobClient(host, chainId, wallet, creds);
```

--------------------------------

### Retrieve Open Orders and Trade History

Source: https://docs.polymarket.com/developers/CLOB/quickstart

Query the CLOB client to fetch all open orders and view complete trade history. These methods provide visibility into current positions and past trading activity without parameters.

```typescript
// View all open orders
const openOrders = await client.getOpenOrders();
console.log(`You have ${openOrders.length} open orders`);

// View your trade history
const trades = await client.getTrades();
console.log(`You've made ${trades.length} trades`);
```

```python
# View all open orders
open_orders = await client.get_open_orders()
print(f"You have {len(open_orders)} open orders")

# View your trade history
trades = await client.get_trades()
print(f"You've made {len(trades)} trades")
```

--------------------------------

### Initialize ClobClient with Credentials - TypeScript

Source: https://docs.polymarket.com/developers/market-makers/setup

Creates an authenticated ClobClient instance for Polymarket CLOB operations. Requires a wallet object and credentials obtained from the authentication process. The client connects to the Polymarket CLOB endpoint on Polygon network (chain ID 137).

```typescript
const client = new ClobClient(
  "https://clob.polymarket.com",
  137,
  wallet,
  credentials
);
```

--------------------------------

### Install Python Builder Relayer Client

Source: https://docs.polymarket.com/developers/builders/relayer-client

Install the Polymarket builder relayer client library for Python environments. This package enables Python developers to access Polymarket's relayer service for gasless transaction execution.

```bash
pip install py-builder-relayer-client
```

--------------------------------

### Install Official CLOB Clients - TypeScript, Python, Rust

Source: https://docs.polymarket.com/developers/market-makers/maker-rebates-program

Install the official Polymarket CLOB clients for automatic fee handling. Available for TypeScript, Python, and Rust. These clients automatically fetch fee rates, include feeRateBps in orders, and sign orders with fees included.

```bash
npm install @polymarket/clob-client@latest
```

```bash
pip install --upgrade py-clob-client
```

```bash
cargo add polymarket-client-sdk
```

--------------------------------

### Create and Post Order with Local Signing - Python

Source: https://docs.polymarket.com/developers/builders/order-attribution

Create an order dictionary with price, side, size, and token_id, then post it to the CLOB. The SDK automatically includes builder authentication headers. Returns the response from posting the signed order.

```python
# Orders automatically include builder headers
order = client.create_order({
    "price": 0.40,
    "side": "BUY",
    "size": 5,
    "token_id": "YOUR_TOKEN_ID"
})

response = client.post_order(order)
```

--------------------------------

### Approve USDCe for CTF Contract using Relayer Client (TypeScript)

Source: https://docs.polymarket.com/developers/market-makers/setup

This example demonstrates how to approve the CTF contract to spend USDCe tokens using the Polymarket Relayer Client. It constructs an ERC-20 `approve` transaction with `MaxUint256` for unlimited spending and executes it via the client. This approval is a prerequisite for splitting USDCe into outcome tokens and engaging in trading operations.

```typescript
import { ethers } from "ethers";
import { Interface } from "ethers/lib/utils";

const erc20Interface = new Interface([
  "function approve(address spender, uint256 amount) returns (bool)"
]);

// Approve USDCe for CTF contract
const approveTx = {
  to: ADDRESSES.USDCe,
  data: erc20Interface.encodeFunctionData("approve", [
    ADDRESSES.CTF,
    ethers.constants.MaxUint256
  ]),
  value: "0"
};

const response = await client.execute([approveTx], "Approve USDCe for CTF");
await response.wait();
```

--------------------------------

### Initialize Polymarket CLOB Client (Python)

Source: https://docs.polymarket.com/developers/CLOB/orders/create-order

This snippet demonstrates how to initialize the `py_clob_client` for Polymarket, supporting different authentication methods (email/Magic, browser wallet, EOA). It sets up the host, private key, chain ID, and funder address, which are prerequisites for placing orders.

```python
from py_clob_client.client import ClobClient
from py_clob_client.clob_types import OrderArgs, OrderType
from py_clob_client.order_builder.constants import BUY

host: str = "https://clob.polymarket.com"
key: str = "" #This is your Private Key. Export from reveal.polymarket.com or from your Web3 Application
chain_id: int = 137 #No need to adjust this
POLYMARKET_PROXY_ADDRESS: str = '' #This is the address you deposit/send USDC to to FUND your Polymarket account.

#Select from the following 3 initialization options to matches your login method, and remove any unused lines so only one client is initialized.


### Initialization of a client using a Polymarket Proxy associated with an Email/Magic account. If you login with your email use this example.
client = ClobClient(host, key=key, chain_id=chain_id, signature_type=1, funder=POLYMARKET_PROXY_ADDRESS)

### Initialization of a client using a Polymarket Proxy associated with a Browser Wallet(Metamask, Coinbase Wallet, etc)
client = ClobClient(host, key=key, chain_id=chain_id, signature_type=2, funder=POLYMARKET_PROXY_ADDRESS)

### Initialization of a client that trades directly from an EOA. 
client = ClobClient(host, key=key, chain_id=chain_id)
```

--------------------------------

### Create or Derive API Key with Fallback

Source: https://docs.polymarket.com/developers/CLOB/clients/methods-l1

Convenience method that attempts to derive an API key with the default nonce, or creates a new one if it doesn't exist. This is the recommended method for initial setup when unsure if credentials already exist, providing automatic fallback behavior.

```typescript
async createOrDeriveApiKey(nonce?: number): Promise<ApiKeyCreds>

// Params:
// nonce (optional): Custom nonce for deterministic key generation. If not provided, a default derivation is used.

// Response:
interface ApiKeyCreds {
  apiKey: string;
  secret: string;
  passphrase: string;
}
```

--------------------------------

### Enable Verbose WebSocket Logging

Source: https://docs.polymarket.com/developers/sports-websocket/quickstart

Configures comprehensive logging for all WebSocket lifecycle events including open, close, error, and message events. Logs connection status, close codes, error details, and message data to help diagnose connection issues and track event flow.

```javascript
ws.onopen = () => console.log('[connected]');
ws.onclose = (e) => console.log('[closed]', e.code, e.reason);
ws.onerror = (e) => console.error('[error]', e);
ws.onmessage = (e) => console.log('[message]', e.data);
```

--------------------------------

### Initialize ClobClient to Generate User API Credentials (TypeScript, Python)

Source: https://docs.polymarket.com/developers/CLOB/clients/methods-overview

This example illustrates initializing the ClobClient with a signer to enable access to L1 methods for managing user API credentials. It demonstrates how to create new API keys, derive existing keys, or create/derive keys based on the current context.

```typescript
// Create client with signer
const client = new ClobClient(
  "https://clob.polymarket.com", 
  137, 
  signer
);

// All public and L1 methods available
const newCreds = createApiKey();
const derivedCreds = deriveApiKey();
const creds = createOrDeriveApiKey();
```

```python
# Create client with signer
client = new ClobClient(
    host="https://clob.polymarket.com", 
    chain_id=137
    key="private_key"
  )

# All public and L1 methods available
new_creds = client.create_api_key()
derived_creds = client.derive_api_key()
creds = client.create_or_derive_api_key()
```

--------------------------------

### Deploy Safe Wallet with Polymarket Relayer Client (TypeScript)

Source: https://docs.polymarket.com/developers/market-makers/setup

This code snippet illustrates how to initialize the Polymarket Relayer Client and deploy a Gnosis Safe-based wallet on Polygon mainnet. The Relayer Client enables gasless transactions and advanced features for market makers. It requires a signer, builder configuration, and specifies the transaction type as SAFE.

```typescript
import { RelayClient, RelayerTxType } from "@polymarket/builder-relayer-client";

const client = new RelayClient(
  "https://relayer-v2.polymarket.com/",
  137, // Polygon mainnet
  signer,
  builderConfig,
  RelayerTxType.SAFE
);

// Deploy the Safe wallet
const response = await client.deploy();
const result = await response.wait();
console.log("Safe Address:", result?.proxyAddress);
```

--------------------------------

### Initialize ClobClient to Get Market Data (TypeScript, Python)

Source: https://docs.polymarket.com/developers/CLOB/clients/methods-overview

This snippet demonstrates how to initialize the ClobClient to retrieve public market data without requiring a signer or any authentication credentials. It shows how to fetch a list of markets, an order book for a specific token, and the price for a given token and order type.

```typescript
// No signer or credentials needed
const client = new ClobClient(
  "https://clob.polymarket.com", 
  137
);

// All public methods available
const markets = await client.getMarkets();
const book = await client.getOrderBook(tokenId);
const price = await client.getPrice(tokenId, "BUY");
```

```python
# No signer or credentials needed
client = new ClobClient(
    host="https://clob.polymarket.com", 
    chain_id=137
)

# All public methods available
markets = client.get_markets()
book = client.get_order_book()
price = client.get_price()
```

--------------------------------

### Generate Polymarket L2 API Credentials with Clob Client (TypeScript)

Source: https://docs.polymarket.com/developers/market-makers/setup

This snippet shows how to derive L2 API credentials (key, secret, passphrase) using the Polymarket Clob Client. These credentials are required for authenticating with Polymarket's CLOB (Central Limit Order Book) and placing orders. The process involves initializing the ClobClient with a signer and then calling the `deriveApiKey()` method.

```typescript
import { ClobClient } from "@polymarket/clob-client";

const client = new ClobClient(
  "https://clob.polymarket.com",
  137,
  signer
);

// Derive API credentials from your wallet
const credentials = await client.deriveApiKey();
console.log("API Key:", credentials.key);
console.log("Secret:", credentials.secret);
console.log("Passphrase:", credentials.passphrase);
```

--------------------------------

### Define Polymarket Contract Addresses for Polygon (TypeScript)

Source: https://docs.polymarket.com/developers/market-makers/setup

This snippet provides a JavaScript object containing essential contract addresses on Polygon mainnet for Polymarket operations. These addresses include USDCe, CTF (outcome tokens), CTF Exchange, and Neg Risk CTF Exchange, which are crucial for token approvals and trading. Developers can use these constants to interact with the correct smart contracts.

```typescript
const ADDRESSES = {
  USDCe: "0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174",
  CTF: "0x4d97dcd97ec945f40cf65f87097ace5ea0476045",
  CTF_EXCHANGE: "0x4bFb41d5B3570DeFd03C39a9A4D8dE6Bd8B8982E",
  NEG_RISK_CTF_EXCHANGE: "0xC5d563A36AE78145C45a50134d48A1215220f80a",
  NEG_RISK_ADAPTER: "0xd91E80cF2E7be2e162c6513ceD06f1dD0dA35296"
};
```

--------------------------------

### Debug PING/PONG WebSocket Handler

Source: https://docs.polymarket.com/developers/sports-websocket/quickstart

Implements proper PING/PONG string message handling to prevent 10-second connection drops. Responds to ping messages with pong strings and logs received data for debugging. Ensures non-JSON string messages are handled separately from JSON payloads.

```javascript
ws.onmessage = (event) => {
  console.log('Received:', event.data);
  if (event.data === 'ping') {
    console.log('Sending PONG response');
    ws.send('pong');
    return;
  }
  // Handle JSON messages...
};
```

--------------------------------

### Handle PING Messages - JavaScript

Source: https://docs.polymarket.com/developers/sports-websocket/quickstart

Demonstrates correct PING/PONG protocol handling for Polymarket Sports WebSocket. Server sends PING every 5 seconds and client must respond with PONG within 10 seconds or connection terminates. Shows correct implementation and common mistake to avoid.

```javascript
// CORRECT - Handle PING messages
ws.onmessage = (event) => {
  if (event.data === 'ping') {
    ws.send('pong');  // Respond immediately
    return;
  }
  // Handle other messages...
  const data = JSON.parse(event.data);
  handleUpdate(data);
};
```

--------------------------------

### Deposit USDCe via Polymarket Bridge API (TypeScript)

Source: https://docs.polymarket.com/developers/market-makers/setup

This snippet demonstrates how to programmatically deposit USDCe from Ethereum to Polygon using Polymarket's Bridge API. It sends a POST request to the deposit endpoint, specifying chain IDs, asset type, and the amount in its smallest unit (e.g., 6 decimals for USDCe). This method is suitable for automated deposits from other chains.

```typescript
// Deposit USDCe from Ethereum to Polygon
const deposit = await fetch("https://clob.polymarket.com/deposit", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    chainId: "1",
    fromChain: "ethereum",
    toChain: "polygon",
    asset: "USDCe",
    amount: "100000000000" // $100,000 in USDCe (6 decimals)
  })
});
```

--------------------------------

### WSS Initial Subscription

Source: https://docs.polymarket.com/developers/CLOB/websocket/wss-overview

Establishes a connection to the Polymarket Websocket API and subscribes to either the 'user' or 'market' channel based on the provided authentication and intent.

```APIDOC
## WEBSOCKET CONNECT

### Description
Establishes a connection to the Polymarket Websocket API and subscribes to either the 'user' or 'market' channel based on the provided authentication and intent.

### Method
WEBSOCKET CONNECT

### Websocket URL
wss://[polymarket_websocket_endpoint]

### Message Payload
- **auth** (Auth) - Required - See WSS Authentication section for details.
- **markets** (string[]) - Optional - Array of markets (condition IDs) to receive events for (for `user` channel).
- **assets_ids** (string[]) - Optional - Array of asset ids (token IDs) to receive events for (for `market` channel).
- **type** (string) - Required - ID of channel to subscribe to ("USER" or "MARKET").
- **custom_feature_enabled** (bool) - Optional - Enabling / disabling custom features.

### Request Example
```json
{
  "auth": {
    "signature": "0x...",
    "address": "0x...",
    "timestamp": "1678886400"
  },
  "type": "USER",
  "markets": [
    "0x123...abc"
  ],
  "custom_feature_enabled": false
}
```

```json
{
  "auth": {
    "signature": "0x...",
    "address": "0x...",
    "timestamp": "1678886400"
  },
  "type": "MARKET",
  "assets_ids": [
    "0xdef...xyz"
  ],
  "custom_feature_enabled": true
}
```

### Response
#### Success Response (200)
Details not provided in source.

#### Response Example
Details not provided in source.
```

--------------------------------

### Binance Crypto Price Update Examples

Source: https://docs.polymarket.com/developers/RTDS/RTDS-crypto-prices

Example messages showing real-time cryptocurrency price updates from the Binance data source. Includes examples for different trading pairs like Solana and Bitcoin.

```APIDOC
## Binance Crypto Price Update Examples

### Solana Price Update (Binance)

```json
{
  "topic": "crypto_prices",
  "type": "update",
  "timestamp": 1753314064237,
  "payload": {
    "symbol": "solusdt",
    "timestamp": 1753314064213,
    "value": 189.55
  }
}
```

### Bitcoin Price Update (Binance)

```json
{
  "topic": "crypto_prices",
  "type": "update",
  "timestamp": 1753314088421,
  "payload": {
    "symbol": "btcusdt",
    "timestamp": 1753314088395,
    "value": 67234.50
  }
}
```

### Message Structure
- **topic**: `crypto_prices` - Identifies the Binance price feed
- **type**: `update` - Indicates a price update message
- **timestamp**: Unix milliseconds when the message was sent
- **payload.symbol**: Trading pair in lowercase concatenated format
- **payload.timestamp**: Unix milliseconds of the price data
- **payload.value**: Current price in the quote currency (USDT)
```

--------------------------------

### Initialize ClobClient to Create and Post Orders (TypeScript, Python)

Source: https://docs.polymarket.com/developers/CLOB/clients/methods-overview

This snippet shows how to initialize the ClobClient with a signer, user API credentials, and funder details, which is necessary for interacting with L1 and L2 methods. It covers creating an order, posting it to the exchange, and retrieving a user's trade history.

```typescript
// Create client with signer and creds
const client = new ClobClient(
  "https://clob.polymarket.com", 
  137, 
  signer,
  creds,
  2, // Indicates Gnosis Safe proxy
  funder // Safe wallet address holding funds
);

// All public, L1, and L2 methods available
const order = await client.createOrder({ /* ... */ });
const result = await client.postOrder(order);
const trades = await client.getTrades();
```

```python
# Create client with signer and creds
const client = new ClobClient(
    host="https://clob.polymarket.com",
    chain_id=137,
    key="private_key",
    creds=creds,
    signature_type=2, // Indicates Gnosis Safe proxy
    funder="funder_address" // Safe wallet address holding funds
)

# All public, L1, and L2 methods available
order = client.create_order({ /* ... */ })
result = client.post_order(order)
trades = client.get_trades()
```

--------------------------------

### GET /api/markets

Source: https://docs.polymarket.com/developers/CLOB/clients/methods-public

Get details for multiple markets, with results paginated.

```APIDOC
## GET /api/markets

### Description
Get details for multiple markets paginated.

### Method
GET

### Endpoint
/api/markets

### Parameters
#### Path Parameters
(None)

#### Query Parameters
(None)

#### Request Body
(None)

### Request Example
(None)

### Response
#### Success Response (200)
- **limit** (number) - The maximum number of items returned per page.
- **count** (number) - The total number of items available.
- **data** (Market[]) - An array of Market objects.
  - **accepting_order_timestamp** (string | null) - Timestamp when orders started being accepted.
  - **accepting_orders** (boolean) - Indicates if the market is currently accepting orders.
  - **active** (boolean) - Indicates if the market is active.
  - **archived** (boolean) - Indicates if the market is archived.
  - **closed** (boolean) - Indicates if the market is closed.
  - **condition_id** (string) - The unique identifier for the market.
  - **description** (string) - A detailed description of the market.
  - **enable_order_book** (boolean) - Indicates if an order book is enabled for this market.
  - **end_date_iso** (string) - ISO formatted end date of the market.
  - **fpmm** (string) - FPMM address.
  - **game_start_time** (string) - Start time of the associated game/event.
  - **icon** (string) - URL to the market icon.
  - **image** (string) - URL to the market image.
  - **is_50_50_outcome** (boolean) - Indicates if it's a 50/50 outcome market.
  - **maker_base_fee** (number) - Base fee for maker orders.
  - **market_slug** (string) - URL-friendly identifier for the market.
  - **minimum_order_size** (number) - Minimum size for an order.
  - **minimum_tick_size** (number) - Minimum tick size for pricing.
  - **neg_risk** (boolean) - Indicates if negative risk is enabled.
  - **neg_risk_market_id** (string) - ID for negative risk market.
  - **neg_risk_request_id** (string) - Request ID for negative risk.
  - **notifications_enabled** (boolean) - Indicates if notifications are enabled for this market.
  - **question** (string) - The market question.
  - **question_id** (string) - The unique identifier for the question.
  - **rewards** (object) - Reward structure details.
    - **max_spread** (number) - Maximum spread for rewards.
    - **min_size** (number) - Minimum size for rewards.
    - **rates** (any | null) - Reward rates.
  - **seconds_delay** (number) - Delay in seconds.
  - **tags** (string[]) - List of tags associated with the market.
  - **taker_base_fee** (number) - Base fee for taker orders.
  - **tokens** (MarketToken[]) - Array of market tokens.
    - **outcome** (string) - The outcome string for the token.
    - **price** (number) - Current price of the token.
    - **token_id** (string) - The unique identifier for the token.
    - **winner** (boolean) - Indicates if this token is the winner.

#### Response Example
```json
{
  "limit": 10,
  "count": 25,
  "data": [
    {
      "accepting_order_timestamp": "2023-01-01T12:00:00Z",
      "accepting_orders": true,
      "active": true,
      "archived": false,
      "closed": false,
      "condition_id": "0x123abc",
      "description": "Will BTC price be above $30,000 by end of year?",
      "enable_order_book": true,
      "end_date_iso": "2023-12-31T23:59:59Z",
      "fpmm": "0xdef456",
      "game_start_time": "2023-01-01T00:00:00Z",
      "icon": "https://example.com/icon.png",
      "image": "https://example.com/image.png",
      "is_50_50_outcome": true,
      "maker_base_fee": 0.001,
      "market_slug": "btc-price-dec-2023",
      "minimum_order_size": 1,
      "minimum_tick_size": 0.01,
      "neg_risk": false,
      "neg_risk_market_id": "",
      "neg_risk_request_id": "",
      "notifications_enabled": true,
      "question": "Will Bitcoin close above $30,000 on December 31, 2023?",
      "question_id": "q123",
      "rewards": {
        "max_spread": 0.05,
        "min_size": 10,
        "rates": null
      },
      "seconds_delay": 0,
      "tags": ["crypto", "bitcoin", "prediction"],
      "taker_base_fee": 0.002,
      "tokens": [
        {
          "outcome": "Yes",
          "price": 0.6,
          "token_id": "0xtoken1",
          "winner": false
        },
        {
          "outcome": "No",
          "price": 0.4,
          "token_id": "0xtoken2",
          "winner": false
        }
      ]
    }
  ]
}
```
```

--------------------------------

### Monitor WebSocket Connection State

Source: https://docs.polymarket.com/developers/sports-websocket/quickstart

Periodically monitors and logs the current WebSocket connection state (CONNECTING, OPEN, CLOSING, or CLOSED) every 5 seconds. Helps identify state transitions and connection stability issues during runtime debugging.

```javascript
setInterval(() => {
  const states = ['CONNECTING', 'OPEN', 'CLOSING', 'CLOSED'];
  console.log('WebSocket state:', states[ws.readyState]);
}, 5000);
```

--------------------------------

### GET /api/simplified-markets

Source: https://docs.polymarket.com/developers/CLOB/clients/methods-public

Get simplified market data, paginated for faster loading.

```APIDOC
## GET /api/simplified-markets

### Description
Get simplified market data paginated for faster loading.

### Method
GET

### Endpoint
/api/simplified-markets

### Parameters
#### Path Parameters
(None)

#### Query Parameters
(None)

#### Request Body
(None)

### Request Example
(None)

### Response
#### Success Response (200)
- **limit** (number) - The maximum number of items returned per page.
- **count** (number) - The total number of items available.
- **data** (SimplifiedMarket[]) - An array of SimplifiedMarket objects.
  - **accepting_orders** (boolean) - Indicates if the market is currently accepting orders.
  - **active** (boolean) - Indicates if the market is active.
  - **archived** (boolean) - Indicates if the market is archived.
  - **closed** (boolean) - Indicates if the market is closed.
  - **condition_id** (string) - The unique identifier for the market.
  - **rewards** (object) - Reward structure details.
    - **rates** (any | null) - Reward rates.
    - **min_size** (number) - Minimum size for rewards.
    - **max_spread** (number) - Maximum spread for rewards.
  - **tokens** (SimplifiedToken[]) - Array of simplified market tokens.
    - **outcome** (string) - The outcome string for the token.
    - **price** (number) - Current price of the token.
    - **token_id** (string) - The unique identifier for the token.

#### Response Example
```json
{
  "limit": 10,
  "count": 50,
  "data": [
    {
      "accepting_orders": true,
      "active": true,
      "archived": false,
      "closed": false,
      "condition_id": "0xabc123",
      "rewards": {
        "rates": null,
        "min_size": 5,
        "max_spread": 0.03
      },
      "tokens": [
        {
          "outcome": "Yes",
          "price": 0.7,
          "token_id": "0xsimp1"
        },
        {
          "outcome": "No",
          "price": 0.3,
          "token_id": "0xsimp2"
        }
      ]
    }
  ]
}
```
```

--------------------------------

### GET /api/markets/{conditionId}

Source: https://docs.polymarket.com/developers/CLOB/clients/methods-public

Get details for a single market by its unique condition ID.

```APIDOC
## GET /api/markets/{conditionId}

### Description
Get details for a single market by condition ID.

### Method
GET

### Endpoint
/api/markets/{conditionId}

### Parameters
#### Path Parameters
- **conditionId** (string) - Required - The unique identifier for the market.

#### Query Parameters
(None)

#### Request Body
(None)

### Request Example
(None)

### Response
#### Success Response (200)
- **accepting_order_timestamp** (string | null) - Timestamp when orders started being accepted.
- **accepting_orders** (boolean) - Indicates if the market is currently accepting orders.
- **active** (boolean) - Indicates if the market is active.
- **archived** (boolean) - Indicates if the market is archived.
- **closed** (boolean) - Indicates if the market is closed.
- **condition_id** (string) - The unique identifier for the market.
- **description** (string) - A detailed description of the market.
- **enable_order_book** (boolean) - Indicates if an order book is enabled for this market.
- **end_date_iso** (string) - ISO formatted end date of the market.
- **fpmm** (string) - FPMM address.
- **game_start_time** (string) - Start time of the associated game/event.
- **icon** (string) - URL to the market icon.
- **image** (string) - URL to the market image.
- **is_50_50_outcome** (boolean) - Indicates if it's a 50/50 outcome market.
- **maker_base_fee** (number) - Base fee for maker orders.
- **market_slug** (string) - URL-friendly identifier for the market.
- **minimum_order_size** (number) - Minimum size for an order.
- **minimum_tick_size** (number) - Minimum tick size for pricing.
- **neg_risk** (boolean) - Indicates if negative risk is enabled.
- **neg_risk_market_id** (string) - ID for negative risk market.
- **neg_risk_request_id** (string) - Request ID for negative risk.
- **notifications_enabled** (boolean) - Indicates if notifications are enabled for this market.
- **question** (string) - The market question.
- **question_id** (string) - The unique identifier for the question.
- **rewards** (object) - Reward structure details.
  - **max_spread** (number) - Maximum spread for rewards.
  - **min_size** (number) - Minimum size for rewards.
  - **rates** (any | null) - Reward rates.
- **seconds_delay** (number) - Delay in seconds.
- **tags** (string[]) - List of tags associated with the market.
- **taker_base_fee** (number) - Base fee for taker orders.
- **tokens** (MarketToken[]) - Array of market tokens.
  - **outcome** (string) - The outcome string for the token.
  - **price** (number) - Current price of the token.
  - **token_id** (string) - The unique identifier for the token.
  - **winner** (boolean) - Indicates if this token is the winner.

#### Response Example
```json
{
  "accepting_order_timestamp": "2023-01-01T12:00:00Z",
  "accepting_orders": true,
  "active": true,
  "archived": false,
  "closed": false,
  "condition_id": "0x123abc",
  "description": "Will BTC price be above $30,000 by end of year?",
  "enable_order_book": true,
  "end_date_iso": "2023-12-31T23:59:59Z",
  "fpmm": "0xdef456",
  "game_start_time": "2023-01-01T00:00:00Z",
  "icon": "https://example.com/icon.png",
  "image": "https://example.com/image.png",
  "is_50_50_outcome": true,
  "maker_base_fee": 0.001,
  "market_slug": "btc-price-dec-2023",
  "minimum_order_size": 1,
  "minimum_tick_size": 0.01,
  "neg_risk": false,
  "neg_risk_market_id": "",
  "neg_risk_request_id": "",
  "notifications_enabled": true,
  "question": "Will Bitcoin close above $30,000 on December 31, 2023?",
  "question_id": "q123",
  "rewards": {
    "max_spread": 0.05,
    "min_size": 10,
    "rates": null
  },
  "seconds_delay": 0,
  "tags": ["crypto", "bitcoin", "prediction"],
  "taker_base_fee": 0.002,
  "tokens": [
    {
      "outcome": "Yes",
      "price": 0.6,
      "token_id": "0xtoken1",
      "winner": false
    },
    {
      "outcome": "No",
      "price": 0.4,
      "token_id": "0xtoken2",
      "winner": false
    }
  ]
}
```
```

--------------------------------

### Implement Exponential Backoff Reconnection

Source: https://docs.polymarket.com/developers/sports-websocket/quickstart

Handles frequent connection drops by implementing exponential backoff strategy with a maximum delay of 30 seconds. Doubles the reconnection delay on each failed attempt to reduce server load and improve recovery stability.

```javascript
handleReconnect() {
  this.reconnectDelay = Math.min(this.reconnectDelay * 2, 30000);
  setTimeout(() => this.connect(), this.reconnectDelay);
}
```

--------------------------------

### POST createOrDeriveApiKey()

Source: https://docs.polymarket.com/developers/CLOB/clients/methods-l1

Convenience method that attempts to derive an API key with the default nonce, or creates a new one if it doesn't exist. This is the recommended method for initial setup if you're unsure if credentials already exist.

```APIDOC
## createOrDeriveApiKey()

### Description
Convenience method that attempts to derive an API key with the default nonce, or creates a new one if it doesn't exist. Recommended for initial setup when uncertain about existing credentials.

### Method
POST (L1 Method - Requires Wallet Signer)

### Signature
```typescript
async createOrDeriveApiKey(nonce?: number): Promise<ApiKeyCreds>
```

### Parameters
#### Optional Parameters
- **nonce** (number) - Optional - Custom nonce for deterministic key generation. If not provided, a default derivation is used.

### Response
#### Success Response (200)
```typescript
interface ApiKeyCreds {
  apiKey: string;      // API key credential
  secret: string;      // Secret credential
  passphrase: string;  // Passphrase credential
}
```

### Response Example
```json
{
  "apiKey": "your-api-key-string",
  "secret": "your-secret-string",
  "passphrase": "your-passphrase-string"
}
```

### Notes
- Recommended method for initial setup
- Automatically handles both creation and derivation
- Idempotent operation - safe to call multiple times
- Returns existing credentials if already created with same nonce
```

--------------------------------

### GET /status/{address}

Source: https://docs.polymarket.com/developers/misc-endpoints/bridge-overview

Get the transaction status for a given address. This endpoint allows you to track the progress of your deposit or withdrawal transactions on the bridge.

```APIDOC
## GET /status/{address}

### Description
Retrieve the current status and details of transactions associated with a specific address.

### Method
GET

### Endpoint
```
https://bridge.polymarket.com/status/{address}
```

### Parameters
#### Path Parameters
- **address** (string) - Required - The wallet address or transaction ID to check status for

#### Query Parameters
- **chain** (string) - Optional - Filter results by blockchain network
- **type** (string) - Optional - Filter by transaction type ("deposit" or "withdrawal")

### Response
#### Success Response (200)
- **transactions** (array) - List of transactions for the address
  - **id** (string) - Transaction identifier
  - **type** (string) - Transaction type (deposit or withdrawal)
  - **status** (string) - Current status (pending, completed, failed)
  - **fromChain** (string) - Source blockchain
  - **toChain** (string) - Destination blockchain
  - **amount** (string) - Transaction amount
  - **createdAt** (string) - Transaction creation timestamp
  - **completedAt** (string) - Transaction completion timestamp
  - **txHash** (string) - Blockchain transaction hash

#### Response Example
```json
{
  "transactions": [
    {
      "id": "tx_123abc456def",
      "type": "deposit",
      "status": "completed",
      "fromChain": "ethereum",
      "toChain": "polygon",
      "amount": "1000000000000000000",
      "createdAt": "2024-01-15T10:30:00Z",
      "completedAt": "2024-01-15T10:35:00Z",
      "txHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"
    }
  ]
}
```
```
Tokens:
Raw