Polymarket Client SDK

https://docs.rs/polymarket-client-sdk/0.4.1
Admin
An ergonomic Rust client for interacting with Polymarket services, providing strongly typed request...
Tokens:721,359
Snippets:5,029
Trust Score:9.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### Result::flatten Method Examples

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/type.Result.html

Examples demonstrating the flatten method to reduce nesting in Result types.

```rust
let x: Result<Result<&'static str, u32>, u32> = Ok(Ok("hello"));
assert_eq!(Ok("hello"), x.flatten());

let x: Result<Result<&'static str, u32>, u32> = Ok(Err(6));
assert_eq!(Err(6), x.flatten());

let x: Result<Result<&'static str, u32>, u32> = Err(6);
assert_eq!(Err(6), x.flatten());
```

```rust
let x: Result<Result<Result<&'static str, u32>, u32>, u32> = Ok(Ok(Ok("hello")));
assert_eq!(Ok(Ok("hello")), x.flatten());
assert_eq!(Ok("hello"), x.flatten().flatten());
```

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

### Result::is_ok and Result::is_err Examples

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/type.Result.html

Basic usage examples for checking the status of a Result.

```rust
let x: Result<i32, &str> = Ok(-3);
assert_eq!(x.is_ok(), true);

let x: Result<i32, &str> = Err("Some error message");
assert_eq!(x.is_ok(), false);
```

```rust
let x: Result<i32, &str> = Ok(-3);
assert_eq!(x.is_err(), false);

let x: Result<i32, &str> = Err("Some error message");
assert_eq!(x.is_err(), true);
```

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

### Result::is_ok_and Method Example

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/type.Result.html

Example demonstrating the use of is_ok_and with a predicate.

```rust
let x: Result<u32, &str> = Ok(2);
assert_eq!(x.is_ok_and(|x| x > 1), true);

let x: Result<u32, &str> = Ok(0);
assert_eq!(x.is_ok_and(|x| x > 1), false);

let x: Result<u32, &str> = Err("hey");
assert_eq!(x.is_ok_and(|x| x > 1), false);

let x: Result<String, &str> = Ok("ownership".to_string());
assert_eq!(x.as_ref().is_ok_and(|x| x.len() > 1), true);
println!("still alive {:?}", x);
```

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

### Result::transpose Method Example

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/type.Result.html

Example demonstrating the transpose method on a Result containing an Option.

```rust
#[derive(Debug, Eq, PartialEq)]
struct SomeErr;

let x: Result<Option<i32>, SomeErr> = Ok(Some(5));
let y: Option<Result<i32, SomeErr>> = Some(Ok(5));
assert_eq!(x.transpose(), y);
```

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

### Result::cloned Method Examples

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/type.Result.html

Examples demonstrating the use of the cloned method on Result<&T, E> and Result<&mut T, E>.

```rust
let val = 12;
let x: Result<&i32, i32> = Ok(&val);
assert_eq!(x, Ok(&12));
let cloned = x.cloned();
assert_eq!(cloned, Ok(12));
```

```rust
let mut val = 12;
let x: Result<&mut i32, i32> = Ok(&mut val);
assert_eq!(x, Ok(&mut 12));
let cloned = x.cloned();
assert_eq!(cloned, Ok(12));
```

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

### Result::copied Method Examples

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/type.Result.html

Examples demonstrating the use of the copied method on Result<&T, E> and Result<&mut T, E>.

```rust
let val = 12;
let x: Result<&i32, i32> = Ok(&val);
assert_eq!(x, Ok(&12));
let copied = x.copied();
assert_eq!(copied, Ok(12));
```

```rust
let mut val = 12;
let x: Result<&mut i32, i32> = Ok(&mut val);
assert_eq!(x, Ok(&mut 12));
let copied = x.copied();
assert_eq!(copied, Ok(12));
```

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

### Subscribe to Crypto Prices with Custom Configuration

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/rtds/client/struct.Client.html

Shows how to initialize a client with a specific endpoint and configuration before subscribing to a price stream.

```rust
use polymarket_client_sdk::rtds::Client;
use polymarket_client_sdk::ws::config::Config;
use futures::StreamExt;
use tokio::pin;

let client = Client::new("wss://rtds.polymarket.com", Config::default())?;
let stream = client.subscribe_crypto_prices(Some(vec!["BTCUSDT".to_string()]))?;

pin!(stream);

while let Some(price_result) = stream.next().await {
    let price = price_result?;
    println!("BTC Price: ${}", price.value);
}
```

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

### Get Day of Month (1-31) from NaiveDate

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/types/struct.NaiveDate.html

The `day()` method returns the day of the month, starting from 1. This is the standard representation for days.

```rust
use chrono::{Datelike, NaiveDate};

assert_eq!(NaiveDate::from_ymd_opt(2015, 9, 8).unwrap().day(), 8);
assert_eq!(NaiveDate::from_ymd_opt(-308, 3, 14).unwrap().day(), 14);
```

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

### Get Position ID - Rust

Source: https://docs.rs/polymarket-client-sdk/0.4.1/src/polymarket_client_sdk/ctf/client.rs.html

Retrieves the unique identifier for a position based on collateral and collection IDs. Requires contract call setup.

```rust
pub async fn position_id(&self, request: &PositionIdRequest) -> Result<PositionIdResponse> {
        let position_id = self
            .contract
            .getPositionId(request.collateral_token, request.collection_id)
            .call()
            .await
            .map_err(|e| CtfError::ContractCall(format!("Failed to get position ID: {e}")))?;

        Ok(PositionIdResponse { position_id })
    }
```

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

### Initialize EOA Wallet Client

Source: https://docs.rs/polymarket-client-sdk/0.4.1/index.html

Sets up the client for EOA wallets like MetaMask or hardware wallets. Ensure token allowances are set beforehand.

```rust
use std::str::FromStr as _;

use alloy::signers::Signer as _;
use alloy::signers::local::LocalSigner;
use polymarket_client_sdk::{POLYGON, PRIVATE_KEY_VAR};
use polymarket_client_sdk::clob::{Client, Config};

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let private_key = std::env::var(PRIVATE_KEY_VAR).expect("Need a private key");
    let signer = LocalSigner::from_str(&private_key)?.with_chain_id(Some(POLYGON));
    let client = Client::new("https://clob.polymarket.com", Config::default())?
        .authentication_builder(&signer)
        .authenticate()
        .await?;

    let ok = client.ok().await?;
    println!("Ok: {ok}");

    let api_keys = client.api_keys().await?;
    println!("API keys: {api_keys:?}");

    Ok(())
}
```

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

### Client Initialization and Subscription Example

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/clob/ws/client/struct.Client.html

Demonstrates how to create an unauthenticated WebSocket client and subscribe to orderbook updates for specified assets.

```APIDOC
## Example Usage

### Description
This example shows how to initialize an unauthenticated WebSocket client and subscribe to real-time orderbook updates for a given list of asset IDs.

### Method
`Client::default()` and `client.subscribe_orderbook()`

### Endpoint
(Not directly specified, handled by the client)

### Request Body
(Not applicable for subscription setup)

### Request Example
```rust
use std::str::FromStr as _;

use polymarket_client_sdk::clob::ws::Client;
use polymarket_client_sdk::types::U256;
use futures::StreamExt;

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    // Create unauthenticated client
    let client = Client::default();

    let stream = client.subscribe_orderbook(vec![U256::from_str("106585164761922456203746651621390029417453862034640469075081961934906147433548")?])?;
    let mut stream = Box::pin(stream);

    while let Some(book) = stream.next().await {
        println!("Orderbook: {:?}", book?);
    }

    Ok(())
}
```

### Response
#### Success Response (Stream of Orderbook Updates)
- **BookUpdate** (type) - Represents the current state of the orderbook for a subscribed asset.

#### Response Example
```json
{
  "example": "Orderbook: Ok(BookUpdate { ... })"
}
```
```

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

### GET /fee_rate_bps/{token_id}

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/clob/client/struct.Client.html

Retrieves the trading fee rate for a market outcome token. Returns the fee rate in basis points (bps) charged on trades for this token. For example, 10 bps = 0.10% fee. Results are cached internally to reduce API calls.

```APIDOC
## GET /fee_rate_bps/{token_id}

### Description
Retrieves the trading fee rate for a market outcome token. Returns the fee rate in basis points (bps) charged on trades for this token. For example, 10 bps = 0.10% fee. Results are cached internally to reduce API calls.

### Method
GET

### Endpoint
/fee_rate_bps/{token_id}

### Parameters
#### Path Parameters
- **token_id** (U256) - Required - The unique identifier for the market outcome token.

### Response
#### Success Response (200)
- **fee_rate_bps** (integer) - The trading fee rate in basis points (bps).

#### Response Example
```json
{
  "fee_rate_bps": 10
}
```

### Errors
Returns an error if the request fails or the token ID is invalid.
```

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

### GET /tick_size/{token_id}

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/clob/client/struct.Client.html

Retrieves the minimum tick size for a market outcome token. The tick size defines the minimum price increment for orders on this token. Results are cached internally to reduce API calls. For example, a tick size of 0.01 means prices must be in increments of $0.01.

```APIDOC
## GET /tick_size/{token_id}

### Description
Retrieves the minimum tick size for a market outcome token. The tick size defines the minimum price increment for orders on this token. Results are cached internally to reduce API calls. For example, a tick size of 0.01 means prices must be in increments of $0.01.

### Method
GET

### Endpoint
/tick_size/{token_id}

### Parameters
#### Path Parameters
- **token_id** (U256) - Required - The unique identifier for the market outcome token.

### Response
#### Success Response (200)
- **tick_size** (string) - The minimum tick size for the token.

#### Response Example
```json
{
  "tick_size": "0.01"
}
```

### Errors
Returns an error if the request fails or the token ID is invalid.
```

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

### Client Initialization

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/gamma/client/struct.Client.html

Demonstrates how to create an instance of the Polymarket Gamma API client, either with the default API endpoint or a custom one.

```APIDOC
## Client Initialization

### Description
Initializes the Polymarket Gamma API client. You can use the default API endpoint or specify a custom one.

### Usage
```rust
use polymarket_client_sdk::gamma::Client;

// Create client with default endpoint
let client = Client::default();

// Or with a custom endpoint
let client = Client::new("https://custom-api.example.com").unwrap();
```

### Method
`Client::default()` or `Client::new(host: &str)`

### Parameters
- `host` (string) - Required - The base URL for the Gamma API when using `Client::new`.

### Errors
Returns an error if the provided URL is invalid or if the HTTP client cannot be created.
```

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

### Run example

Source: https://docs.rs/polymarket-client-sdk/0.4.1/index.html

Execute a specific example from the crate.

```bash
cargo run --example unauthenticated
```

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

### Initialize and Use Polymarket Bridge Client

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/bridge/client/struct.Client.html

Demonstrates how to initialize the client and use its deposit and supported_assets methods. Requires the client to be initialized with default settings.

```rust
use polymarket_client_sdk::types::address;
use polymarket_client_sdk::bridge::{Client, types::DepositRequest};

let client = Client::default();

// Get deposit addresses
let request = DepositRequest::builder()
    .address(address!("56687bf447db6ffa42ffe2204a05edaa20f55839"))
    .build();
let response = client.deposit(&request).await?;

// Get supported assets
let assets = client.supported_assets().await?;
```

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

### HashMap Example: From Array and Into

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/clob/types/response/type.RewardsPercentagesResponse.html

Demonstrates creating a HashMap from an array using `HashMap::from` and the `into` keyword.

```rust
use std::collections::HashMap;

let map1 = HashMap::from([(1, 2), (3, 4)]);
let map2: HashMap<_, _> = [(1, 2), (3, 4)].into();
assert_eq!(map1, map2);
```

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

### Example: Building a PositionsRequest

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/data/types/request/struct.PositionsRequest.html

Demonstrates how to construct a PositionsRequest using the builder pattern, specifying user, sort criteria, and sort direction.

```rust
use polymarket_client_sdk::types::address;
use polymarket_client_sdk::data::{types::request::PositionsRequest, types::{PositionSortBy, SortDirection}};

let request = PositionsRequest::builder()
    .user(address!("56687bf447db6ffa42ffe2204a05edaa20f55839"))
    .sort_by(PositionSortBy::CashPnl)
    .sort_direction(SortDirection::Desc)
    .build();
```

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

### Get Type ID

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/bridge/types/struct.DepositAddressesBuilder.html

Gets the TypeId of self. This is part of the Any trait implementation.

```rust
fn type_id(&self) -> TypeId
```

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

### SimpleParser Example

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/ws/traits/trait.MessageParser.html

An example implementation of the MessageParser trait for a custom message type `MyMessage`.

```APIDOC
## Example
```rust
pub struct SimpleParser;

impl MessageParser<MyMessage> for SimpleParser {
    fn parse(&self, bytes: &[u8]) -> crate::Result<Vec<MyMessage>> {
        let msg: MyMessage = serde_json::from_slice(bytes)?;
        Ok(vec![msg])
    }
}
```
```

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

### Initialize WebSocket Connection Manager

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/ws/index.html

Demonstrates the setup of a ConnectionManager and SubscriptionManager using a custom message type and parser.

```rust
// Define your message type
#[derive(Clone, Debug, Deserialize)]
enum MyMessage { /* ... */ }

let connection = ConnectionManager::new(endpoint, config, SimpleParser)?;
let subscriptions = SubscriptionManager::new(connection);
```

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

### Client Initialization

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/bridge/client/struct.Client.html

Demonstrates how to create a new Bridge API client, either with default settings or a custom host.

```APIDOC
## Client Initialization

### Description
Initializes a new `Client` for the Polymarket Bridge API. You can use the default client or specify a custom host.

### Methods
- `Client::default()`: Creates a client with default settings.
- `Client::new(host: &str)`: Creates a client with a custom host URL.

### Errors
`Client::new` returns an error if the provided host URL is invalid or if the underlying HTTP client fails to build.

### Example
```rust
use polymarket_client_sdk::bridge::Client;

// Using default client
let client = Client::default();

// Using a custom host
let custom_host = "https://api.example.com";
let client_with_custom_host = Client::new(custom_host).await?;
```
```

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

### Example: Creating a BuilderLeaderboardRequest

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/data/types/request/struct.BuilderLeaderboardRequest.html

Demonstrates how to create an instance of BuilderLeaderboardRequest using the builder pattern, specifying a weekly time period.

```rust
use polymarket_client_sdk::data::{types::request::BuilderLeaderboardRequest, types::TimePeriod};

let request = BuilderLeaderboardRequest::builder()
    .time_period(TimePeriod::Week)
    .build();
```

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

### Set Start Date

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/gamma/types/response/struct.ClobRewardBuilder.html

Sets the start date for the ClobReward. Use this when the StartDate state is unset.

```rust
pub fn start_date(self, value: NaiveDate) -> ClobRewardBuilder<SetStartDate<S>>
where S::StartDate: IsUnset,
```

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

### Initialize and Subscribe with ConnectionManager

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/ws/connection/struct.ConnectionManager.html

Demonstrates creating a new ConnectionManager instance and subscribing to incoming messages using a parser.

```rust
let parser = SimpleParser;
let connection = ConnectionManager::new(
    "wss://example.com".to_owned(),
    config,
    parser,
)?;

// Subscribe to messages
let mut rx = connection.subscribe();
while let Ok(msg) = rx.recv().await {
    println!("Received: {:?}", msg);
}
```

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

### Client Initialization and Authentication

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/rtds/client/struct.Client.html

Demonstrates how to create a new unauthenticated client and authenticate it with CLOB credentials.

```APIDOC
## Client Initialization and Authentication

### Description
This section covers the creation of a new RTDS client and its subsequent authentication.

### Methods

#### `Client::new`
- **Description**: Creates a new unauthenticated RTDS client.
- **Parameters**:
  - `endpoint` (str): The RTDS endpoint URL.
  - `config` (Config): The client configuration.
- **Returns**: `Result<Client<Unauthenticated>>`

#### `Client::authenticate`
- **Description**: Authenticates the client with CLOB credentials.
- **Parameters**:
  - `self` (Client<Unauthenticated>): The unauthenticated client instance.
  - `address` (Address): The user's address.
  - `credentials` (Credentials): The CLOB credentials.
- **Returns**: `Result<Client<Authenticated<Normal>>>`
- **Description**: Returns an authenticated client.
```

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

### Create Binary Market Split Request

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/ctf/types/struct.SplitPositionRequest.html

Example of using the for_binary_market convenience method to initialize a request for a standard YES/NO market.

```rust
let request = SplitPositionRequest::for_binary_market(
    address!("0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174"), // USDC
    B256::default(),
    U256::from(1_000_000), // 1 USDC (6 decimals)
);
```

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

### Set MarketRewardsConfig Start Date

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/clob/types/response/struct.MarketRewardsConfigBuilder.html

Sets the required start date for the MarketRewardsConfig. The state S must have an unset StartDate.

```rust
pub fn start_date( self, value: NaiveDate, ) -> MarketRewardsConfigBuilder<SetStartDate<S>>
where S::StartDate: IsUnset,
```

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

### Config and ConfigBuilder

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/clob/client/index.html

Configuration structures for initializing the Polymarket client.

```APIDOC
## Config

### Description
Configuration for `Client`.

## ConfigBuilder

### Description
Use builder syntax to set the inputs and finish with `build()`.
```

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

### Initialize Polymarket Data Client

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/data/client/struct.Client.html

Create a new Data API client. Use the default endpoint or provide a custom one. The custom endpoint must be a valid URL.

```rust
use polymarket_client_sdk::data::Client;

// Create client with default endpoint
let client = Client::default();

// Or with a custom endpoint
let client = Client::new("https://custom-api.example.com").unwrap();
```

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

### Get URL as String Reference

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/auth/builder/struct.Url.html

Implement `AsRef<str>` for `Url` to get a string reference to the URL's serialization.

```rust
fn as_ref(&self) -> &str
```

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

### Polymarket Data API Client Initialization

Source: https://docs.rs/polymarket-client-sdk/0.4.1/src/polymarket_client_sdk/data/client.rs.html

Demonstrates how to initialize the Polymarket Data API client, either with the default endpoint or a custom one.

```APIDOC
## Polymarket Data API Client

### Description

This client provides an interface to interact with the Polymarket Data API. It supports querying various data points such as user positions, trades, activity, and market data.

### API Base URL

The default API endpoint is `https://data-api.polymarket.com`.

### Initialization

#### Default Client

```rust
use polymarket_client_sdk::data::Client;

// Create client with default endpoint
let client = Client::default();
```

#### Custom Endpoint Client

```rust
use polymarket_client_sdk::data::Client;

// Or with a custom endpoint
let client = Client::new("https://custom-api.example.com").unwrap();
```

### Errors

Returns an error if the URL is invalid or the HTTP client cannot be created.
```

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

### URL File Path Conversion Examples

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/auth/builder/struct.Url.html

Examples demonstrating the conversion between file paths and URLs using the `from_file_path` and `to_file_path` methods.

```APIDOC
## Examples

On Unix-like platforms:
```rust
use url::Url;

let url = Url::from_file_path("/tmp/foo.txt")?;
assert_eq!(url.as_str(), "file:///tmp/foo.txt");

let url = Url::from_file_path("../foo.txt");
assert!(url.is_err());

let url = Url::from_file_path("https://google.com/");
assert!(url.is_err());
```

This method is only available if the `std` Cargo feature is enabled.
```

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

### Polymarket Gamma API Client Initialization

Source: https://docs.rs/polymarket-client-sdk/0.4.1/src/polymarket_client_sdk/gamma/client.rs.html

Demonstrates how to initialize the Polymarket Gamma API client, either with the default endpoint or a custom one.

```APIDOC
## Client Initialization

### Description

Initializes the Polymarket Gamma API client. You can use the default endpoint or specify a custom one.

### Usage

```rust
use polymarket_client_sdk::gamma::Client;

// Create client with default endpoint
let client = Client::default();

// Or with a custom endpoint
let client = Client::new("https://custom-api.example.com").unwrap();
```

### Methods

- `Client::default()`: Creates a client using the default API endpoint (`https://gamma-api.polymarket.com`).
- `Client::new(host: &str)`: Creates a client with a specified custom host URL. Returns a `Result<Client>`.

### Errors

Returns an error if the provided URL is invalid or if the underlying HTTP client cannot be created.
```

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

### Get Month Number (0-11) from NaiveDate

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/types/struct.NaiveDate.html

Use the `month0()` method to get the month as a zero-based index (0-11). This is common in programming contexts.

```rust
use chrono::{Datelike, NaiveDate};

assert_eq!(NaiveDate::from_ymd_opt(2015, 9, 8).unwrap().month0(), 8);
assert_eq!(NaiveDate::from_ymd_opt(-308, 3, 14).unwrap().month0(), 2);
```

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

### Set Optional Start Date

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/gamma/types/response/struct.ClobRewardBuilder.html

Sets an optional start date for the ClobReward using an Option<NaiveDate>. Use this when the StartDate state is unset.

```rust
pub fn maybe_start_date( self, value: Option<NaiveDate>, ) -> ClobRewardBuilder<SetStartDate<S>>
where S::StartDate: IsUnset,
```

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

### Client Initialization

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/ctf/client/struct.Client.html

Constructors for creating a new Client instance for interacting with the CTF contract.

```APIDOC
## Client Initialization

### `Client::new`

Creates a new CTF client for the specified chain.

#### Arguments
- `provider` (P): An alloy provider instance.
- `chain_id` (ChainId): The chain ID (e.g., 137 for Polygon mainnet, 80002 for Amoy testnet).

#### Errors
- Returns an error if the contract configuration is not found for the given chain.

### `Client::with_neg_risk`

Creates a new CTF client with `NegRisk` adapter support, suitable for working with negative risk markets.

#### Arguments
- `provider` (P): An alloy provider instance.
- `chain_id` (ChainId): The chain ID (e.g., 137 for Polygon mainnet, 80002 for Amoy testnet).

#### Errors
- Returns an error if the contract configuration is not found for the given chain, or if the `NegRisk` adapter is not configured for the chain.
```

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

### Start SubscriptionManager Reconnection Handler

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/rtds/subscription/struct.SubscriptionManager.html

Starts a reconnection handler for the SubscriptionManager. This handler will attempt to re-subscribe when the connection is recovered. Requires an Arc<Self> reference.

```rust
pub fn start_reconnection_handler(self: &Arc<Self>)
```

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

### Initialize CTF Client and Perform Position Split

Source: https://docs.rs/polymarket-client-sdk/0.4.1/src/polymarket_client_sdk/ctf/mod.rs.html

Demonstrates how to instantiate the CTF client using an alloy provider and execute a position split request. Requires a configured provider and valid contract addresses.

```rust
use polymarket_client_sdk::ctf::{Client, types::*};
use polymarket_client_sdk::types::address;
use polymarket_client_sdk::POLYGON;
use alloy::providers::ProviderBuilder;
use alloy::primitives::{B256, U256};

async fn example() -> Result<(), Box<dyn std::error::Error>> {
// Create a provider (requires a wallet for state-changing operations)
let provider = ProviderBuilder::new()
    .connect("https://polygon-rpc.com")
    .await?;

let client = Client::new(provider, POLYGON)?;

let condition_id_req = ConditionIdRequest::builder()
    .oracle(address!("<oracle_address>"))
    .question_id(B256::default())
    .outcome_slot_count(U256::from(2))
    .build();

let condition_id = client.condition_id(&condition_id_req).await?;
println!("Condition ID: {}", condition_id.condition_id);

// Split USDC into outcome tokens
let split_req = SplitPositionRequest::builder()
    .collateral_token(address!("<collateral_token_address>"))
    .condition_id(condition_id.condition_id)
    .partition(vec![U256::from(1), U256::from(2)])
    .amount(U256::from(1_000_000)) // 1 USDC (6 decimals)
    .build();

let result = client.split_position(&split_req).await?;
println!("Split tx: {}", result.transaction_hash);
Ok(())
}
```

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

### Series Builder - Start Date

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/gamma/types/response/struct.SeriesBuilder.html

Methods to set the start date of a series. `start_date` sets it directly, while `maybe_start_date` allows for an optional date value.

```APIDOC
## POST /api/series/start_date

### Description
Sets the start date for the series.

### Method
POST

### Endpoint
/api/series/start_date

### Parameters
#### Request Body
- **value** (string) - Required - The start date in ISO 8601 format (e.g., UTC).

### Request Example
```json
{
  "value": "2023-10-27T10:00:00Z"
}
```

## POST /api/series/maybe_start_date

### Description
Sets the start date for the series, allowing for an optional value.

### Method
POST

### Endpoint
/api/series/maybe_start_date

### Parameters
#### Request Body
- **value** (string | null) - Optional - The start date in ISO 8601 format, or null to unset.

### Request Example
```json
{
  "value": "2023-10-27T10:00:00Z"
}
```
```

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

### Get Ordinal Day of Year (1-366) from NaiveDate

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/types/struct.NaiveDate.html

Use the `ordinal()` method to get the day of the year as a number from 1 to 366. This is useful for calculations related to the position within a year.

```rust
use chrono::{Datelike, NaiveDate};

assert_eq!(NaiveDate::from_ymd_opt(2015, 9, 8).unwrap().ordinal(), 251);
assert_eq!(NaiveDate::from_ymd_opt(-308, 3, 14).unwrap().ordinal(), 74);
```

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

### Constructing a DepositRequest

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/bridge/types/struct.DepositRequest.html

Example showing how to use the builder pattern to create a new DepositRequest instance.

```rust
use polymarket_client_sdk::types::address;
use polymarket_client_sdk::bridge::types::DepositRequest;

let request = DepositRequest::builder()
    .address(address!("56687bf447db6ffa42ffe2204a05edaa20f55839"))
    .build();
```

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

### Subscribe to Crypto Prices with Default Client

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/rtds/client/struct.Client.html

Demonstrates initializing a default unauthenticated client and subscribing to specific cryptocurrency price streams.

```rust
use polymarket_client_sdk::rtds::Client;
use futures::StreamExt;

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let client = Client::default();

    // Subscribe to BTC and ETH prices from Binance
    let symbols = vec!["btcusdt".to_owned(), "ethusdt".to_owned()];
    let stream = client.subscribe_crypto_prices(Some(symbols))?;
    let mut stream = Box::pin(stream);

    while let Some(price) = stream.next().await {
        println!("Price: {:?}", price?);
    }

    Ok(())
}
```

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

### GET /all_prices

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/clob/client/struct.Client.html

Retrieves prices for all available market outcome tokens. Returns the current best bid and ask prices for every active token in the system. This is useful for getting a complete market overview.

```APIDOC
## GET /all_prices

### Description
Retrieves prices for all available market outcome tokens. Returns the current best bid and ask prices for every active token in the system. This is useful for getting a complete market overview.

### Method
GET

### Endpoint
/all_prices

### Response
#### Success Response (200)
- **prices** (array of Price) - A list of all available market outcome tokens with their best bid and ask prices.

#### Response Example
```json
{
  "prices": [
    {
      "token_id": "0x123...",
      "best_bid": "0.85",
      "best_ask": "0.90"
    },
    {
      "token_id": "0x456...",
      "best_bid": "0.10",
      "best_ask": "0.15"
    }
  ]
}
```

### Errors
Returns an error if the request fails.
```

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

### Interact with the Conditional Token Framework

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/ctf/index.html

Demonstrates initializing the CTF client, calculating a condition ID, and splitting USDC collateral into outcome tokens. Requires a provider and appropriate addresses for the oracle and collateral token.

```rust
use polymarket_client_sdk::ctf::{Client, types::*};
use polymarket_client_sdk::types::address;
use polymarket_client_sdk::POLYGON;
use alloy::providers::ProviderBuilder;
use alloy::primitives::{B256, U256};

// Create a provider (requires a wallet for state-changing operations)
let provider = ProviderBuilder::new()
    .connect("https://polygon-rpc.com")
    .await?;

let client = Client::new(provider, POLYGON)?;

let condition_id_req = ConditionIdRequest::builder()
    .oracle(address!("<oracle_address>"))
    .question_id(B256::default())
    .outcome_slot_count(U256::from(2))
    .build();

let condition_id = client.condition_id(&condition_id_req).await?;
println!("Condition ID: {}", condition_id.condition_id);

// Split USDC into outcome tokens
let split_req = SplitPositionRequest::builder()
    .collateral_token(address!("<collateral_token_address>"))
    .condition_id(condition_id.condition_id)
    .partition(vec![U256::from(1), U256::from(2)])
    .amount(U256::from(1_000_000)) // 1 USDC (6 decimals)
    .build();

let result = client.split_position(&split_req).await?;
println!("Split tx: {}", result.transaction_hash);
```

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

### Get Midpoint Price for a Market Outcome Token

Source: https://docs.rs/polymarket-client-sdk/0.4.1/src/polymarket_client_sdk/clob/client.rs.html

Use this function to get the average of the best bid and ask prices for a specific token. This provides a fair market price estimate. Ensure the `MidpointRequest` is correctly configured.

```rust
pub async fn midpoint(&self, request: &MidpointRequest) -> Result<MidpointResponse> {
        let params = request.query_params(None);
        let request = self
            .client()
            .request(Method::GET, format!("{}midpoint{params}", self.host()))
            .build()?;

        crate::request(&self.inner.client, request, None).await
    }
```

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

### Create Authenticated CLOB Client and Place Order

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/clob/index.html

Set up an authenticated client using a private key and signer for trading operations. This involves creating a signer, authenticating the client, building a limit order, signing it, and posting it to the CLOB API.

```rust
use std::str::FromStr as _;

use alloy::signers::Signer;
use alloy::signers::local::LocalSigner;
use polymarket_client_sdk::{POLYGON, PRIVATE_KEY_VAR};
use polymarket_client_sdk::clob::{Client, Config};
use polymarket_client_sdk::clob::types::{Side, SignedOrder};
use polymarket_client_sdk::types::{dec, Decimal, U256};

// Create signer from private key
let private_key = std::env::var(PRIVATE_KEY_VAR)?;
let signer = LocalSigner::from_str(&private_key)?.with_chain_id(Some(POLYGON));

let client = Client::new("https://clob.polymarket.com", Config::default())?
    .authentication_builder(&signer)
    .authenticate()
    .await?;

let order = client
    .limit_order()
    .token_id(U256::from_str("15871154585880608648532107628464183779895785213830018178010423617714102767076")?)
    .side(Side::Buy)
    .price(dec!(0.5))
    .size(Decimal::TEN)
    .build()
    .await?;

let signed_order = client.sign(&signer, order).await?;
let response = client.post_order(signed_order).await?;
println!("Order ID: {}", response.order_id);
```

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

### GET /

Source: https://docs.rs/polymarket-client-sdk/0.4.1/src/polymarket_client_sdk/clob/client.rs.html

Checks if the CLOB API is healthy and operational.

```APIDOC
## GET /

### Description
Checks if the CLOB API is healthy and operational. Returns "OK" if the API is functioning properly.

### Method
GET

### Endpoint
/

### Response
#### Success Response (200)
- **status** (string) - The health status of the API, typically "OK".
```

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

### Get Decimal mantissa

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/types/struct.Decimal.html

Returns the mantissa of the Decimal.

```rust

let num = dec!(-1.2345678);
assert_eq!(num.mantissa(), -12345678i128);
assert_eq!(num.scale(), 7);
```

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

### Create Polymarket Gamma API Client

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/gamma/client/struct.Client.html

Instantiate the `Client` with the default API endpoint or a custom one. Ensure the provided URL is valid.

```rust
use polymarket_client_sdk::gamma::Client;

// Create client with default endpoint
let client = Client::default();

// Or with a custom endpoint
let client = Client::new("https://custom-api.example.com").unwrap();
```

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

### PolicyExt Or Implementation

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/clob/types/request/struct.TradesRequest.html

Combines two policies, succeeding if either policy returns `Action::Follow`.

```rust
fn or<P, B, E>(self, other: P) -> Or<T, P>
where
    T: Policy<B, E>,
    P: Policy<B, E>,
```

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

### GET /tags

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/gamma/index.html

Retrieves tag metadata and relationships.

```APIDOC
## GET /tags

### Description
List tags or retrieve specific tag details by ID, slug, or related tags.

### Method
GET

### Endpoint
/tags, /tags/{id}, /tags/slug/{slug}, /tags/{id}/related-tags

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the tag.
- **slug** (string) - Required - The URL-friendly slug of the tag.
```

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

### GET /leaderboard

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/data/client/struct.Client.html

Fetches trader leaderboard rankings.

```APIDOC
## GET /leaderboard

### Description
Fetches trader leaderboard rankings. Returns trader rankings filtered by category, time period, and ordering.

### Method
GET

### Endpoint
/leaderboard

### Parameters
#### Request Body
- **req** (TraderLeaderboardRequest) - Required - The request object containing filtering criteria.
```

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

### GET /v1/leaderboard

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/data/index.html

Retrieves trader leaderboard rankings.

```APIDOC
## GET /v1/leaderboard

### Description
Get trader leaderboard rankings.

### Method
GET

### Endpoint
/v1/leaderboard
```

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

### MarketFilter Usage Example

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/data/types/enum.MarketFilter.html

Demonstrates how to create MarketFilter instances for filtering by specific markets (condition IDs) or by event IDs. Ensure correct types are used for IDs.

```rust
use polymarket_client_sdk::data::types::MarketFilter;
use polymarket_client_sdk::types::b256;

// Filter by specific markets (condition IDs)
let by_markets = MarketFilter::markets([b256!("dd22472e552920b8438158ea7238bfadfa4f736aa4cee91a6b86c39ead110917")]);

// Or filter by events (which may contain multiple markets)
let by_events = MarketFilter::event_ids(["123".to_owned()]);
```

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

### get

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/clob/types/response/type.RewardsPercentagesResponse.html

Returns a reference to the value corresponding to the key.

```APIDOC
## get

### Description
Returns a reference to the value corresponding to the key.

### Parameters
#### Request Body
- **k** (Q) - Required - The key to look up.
```

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

### Constructing ActivityRequest with Builder

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/data/types/request/struct.ActivityRequest.html

Example demonstrating how to instantiate an ActivityRequest using the builder pattern.

```rust
use polymarket_client_sdk::types::address;
use polymarket_client_sdk::data::{types::request::ActivityRequest, types::ActivityType};

let request = ActivityRequest::builder()
    .user(address!("56687bf447db6ffa42ffe2204a05edaa20f55839"))
    .activity_types(vec![ActivityType::Trade, ActivityType::Redeem])
    .build();
```

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

### GET /fragment

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/auth/builder/struct.Url.html

Retrieves the fragment identifier of the URL.

```APIDOC
## GET /fragment

### Description
Return this URL’s fragment identifier, if any. The fragment is the part of the URL after the # symbol.

### Method
GET

### Endpoint
/fragment

### Response
#### Success Response (200)
- **fragment** (string) - The fragment identifier, or None if not present.
```

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

### Default Client Initialization

Source: https://docs.rs/polymarket-client-sdk/0.4.1/src/polymarket_client_sdk/clob/client.rs.html

Tests the default initialization of the Client. This is a basic sanity check.

```rust
_ = Client::default();
```

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

### GET /query

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/auth/builder/struct.Url.html

Retrieves the query string of the URL.

```APIDOC
## GET /query

### Description
Return this URL’s query string, if any, as a percent-encoded ASCII string.

### Method
GET

### Endpoint
/query

### Response
#### Success Response (200)
- **query** (string) - The query string, or None if not present.
```

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

### Scheme Retrieval

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/auth/builder/struct.Url.html

Shows how to get the scheme of a URL.

```APIDOC
## scheme()

### Description
Returns the scheme of the URL, lower-cased, as an ASCII string without the ‘:’ delimiter.

### Method
`pub fn scheme(&self) -> &str`

### Examples
```rust
use url::Url;

let url = Url::parse("file:///tmp/foo")?;
assert_eq!(url.scheme(), "file");
```
```

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

### Create PricePoint Instance with Builder

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/clob/types/response/struct.PricePoint.html

Demonstrates how to create an instance of the PricePoint struct using a builder pattern. This is the recommended way to construct PricePoint objects.

```rust
pub fn builder() -> PricePointBuilder
```

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

### Initialize Proxy/Safe Wallet Client

Source: https://docs.rs/polymarket-client-sdk/0.4.1/index.html

Initializes the client for Proxy/Safe wallets, automatically deriving the funder address using CREATE2. The signing key differs from the funder address.

```rust
let client = Client::new("https://clob.polymarket.com", Config::default())?
    .authentication_builder(&signer)
    .signature_type(SignatureType::GnosisSafe)  // Funder auto-derived via CREATE2
    .authenticate()
    .await?;
```

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

### Get URL username

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/auth/builder/struct.Url.html

Returns the percent-encoded username.

```rust
use url::Url;

let url = Url::parse("ftp://rms@example.com")?;
assert_eq!(url.username(), "rms");

let url = Url::parse("ftp://:secret123@example.com")?;
assert_eq!(url.username(), "");

let url = Url::parse("https://example.com")?;
assert_eq!(url.username(), "");
```

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

### Querying Active Events

Source: https://docs.rs/polymarket-client-sdk/0.4.1/src/polymarket_client_sdk/gamma/client.rs.html

Demonstrates how to initialize the client and fetch a list of active events using the EventsRequest builder.

```rust
use polymarket_client_sdk::gamma::{Client, types::request::EventsRequest};

# async fn example() -> Result<(), Box<dyn std::error::Error>> {
let client = Client::default();

// List active events
let request = EventsRequest::builder()
    .active(true)
    .limit(10)
    .build();

let events = client.events(&request).await?;
for event in events {
    println!("{}: {:?}", event.id, event.title);
}
# Ok(())
# }
```

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

### GET /notifications

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/clob/client/struct.Client.html

Retrieves all notifications for the authenticated user.

```APIDOC
## GET /notifications

### Description
Returns order fill notifications, cancellations, and other trading events.

### Method
GET

### Endpoint
/notifications

### Response
#### Success Response (200)
- **notifications** (Vec<NotificationResponse>) - A list of user notifications.
```

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

### GET /server_time

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/clob/client/struct.Client.html

Retrieves the current server timestamp.

```APIDOC
## GET /server_time

### Description
Returns the current server timestamp in milliseconds since Unix epoch.

### Method
GET

### Response
#### Success Response (200)
- **timestamp** (i64) - The current server time in milliseconds.
```

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

### Client Initialization and Authentication

Source: https://docs.rs/polymarket-client-sdk/0.4.1/src/polymarket_client_sdk/clob/ws/client.rs.html

This section covers the creation of the WebSocket client in both unauthenticated and authenticated states, along with the process of authenticating an existing client.

```APIDOC
## Client Initialization and Authentication

### Description

This section details how to initialize the WebSocket client and transition it from an unauthenticated to an authenticated state.

### `Client::new` (Unauthenticated)

- **Description**: Creates a new unauthenticated WebSocket client.
- **Parameters**:
  - `endpoint` (string) - Required - The base WebSocket URL (e.g., `wss://...polymarket.com`). Channel paths are appended automatically.
  - `config` (Config) - Required - Configuration for the WebSocket connections.
- **Returns**: `Result<Client<Unauthenticated>>`

### `Client::default` (Unauthenticated)

- **Description**: Creates a new unauthenticated WebSocket client using the default endpoint.
- **Returns**: `Client<Unauthenticated>`

### `Client::authenticate`

- **Description**: Authenticates the client, transitioning it to an authenticated state. This method consumes the `Client<Unauthenticated>` and returns a `Client<Authenticated<Normal>>`. It requires that no other references (clones) to the client exist.
- **Parameters**:
  - `credentials` (Credentials) - Required - User credentials for authentication.
  - `address` (Address) - Required - The user's address.
- **Returns**: `Result<Client<Authenticated<Normal>>>`
- **Error**: Returns an error if other references to the client exist.

### Request Example (Authentication)

```rust
use polymarket_client_sdk::clob::ws::Client;
use polymarket_client_sdk::auth::{Credentials, Normal};
use polymarket_client_sdk::types::Address;

// Assume credentials and address are already defined
// let credentials = Credentials { ... };
// let address = Address { ... };

let unauthenticated_client = Client::<Unauthenticated>::default();
let authenticated_client = unauthenticated_client.authenticate(credentials, address)?;
```

### Client States

- **`Client<Unauthenticated>`**: Can only access public market data.
- **`Client<Authenticated<K>>`**: Can access both public and user-specific data.
```

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

### LocalSigner - Signing and Verifying a Message

Source: https://docs.rs/polymarket-client-sdk/0.4.1/polymarket_client_sdk/auth/struct.LocalSigner.html

Demonstrates how to use LocalSigner to sign messages and verify the resulting signatures. It highlights the use of EIP-191 hashing and optional chain ID configuration for replay protection.

```APIDOC
## LocalSigner - Signing and Verifying a Message

### Description
This example shows how to create a `LocalSigner`, sign a message, and verify the signature. It also demonstrates setting a chain ID for EIP-155 compliance and the cloneability of the signer.

### Method
N/A (Illustrative Example)

### Endpoint
N/A (Local Operation)

### Request Example
```rust
use alloy_signer::{Signer, SignerSync};
use alloy_signer_local::PrivateKeySigner;

let signer = PrivateKeySigner::random();
let signer = signer.with_chain_id(Some(1337));
let message = b"hello";
let signature = signer.sign_message_sync(message)?;
assert_eq!(signature.recover_address_from_msg(&message[..]).unwrap(), signer.address());

let signer_clone = signer.clone();
let signature2 = signer_clone.sign_message_sync(message)?;
assert_eq!(signature, signature2);
```

### Response
N/A (Illustrative Example)

### Response Example
N/A
```

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

### GET /rfq/data/quotes

Source: https://docs.rs/polymarket-client-sdk/0.4.1/src/polymarket_client_sdk/clob/client.rs.html

Retrieves a paginated list of RFQ quotes.

```APIDOC
## GET /rfq/data/quotes

### Description
Retrieves a paginated list of RFQ quotes based on the provided request parameters.

### Method
GET

### Endpoint
/rfq/data/quotes

### Parameters
#### Query Parameters
- **request** (RfqQuotesRequest) - Required - The request object containing query parameters.
- **next_cursor** (Option<String>) - Optional - Cursor for pagination.
```

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

### Fetch Polymarket Events using Gamma API

Source: https://docs.rs/polymarket-client-sdk/0.4.1/src/polymarket_client_sdk/gamma/mod.rs.html

Demonstrates how to create a client, build a request for active events with a limit, and fetch events using the Polymarket Gamma API. Requires the `gamma` feature flag.

```rust
use polymarket_client_sdk::gamma::{Client, types::request::EventsRequest};

# async fn example() -> Result<(), Box<dyn std::error::Error>> {
// Create a client with the default endpoint
let client = Client::default();

// Build a request for active events
let request = EventsRequest::builder()
    .active(true)
    .limit(10)
    .build();

// Fetch events
let events = client.events(&request).await?;

for event in events {
    println!("{}: {{:?}}", event.id, event.title);
}
# Ok(())
# }

```

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

### GET /auth/derive-api-key

Source: https://docs.rs/polymarket-client-sdk/0.4.1/src/polymarket_client_sdk/clob/client.rs.html

Derives an existing API key for authentication.

```APIDOC
## GET /auth/derive-api-key

### Description
Derives an existing API key for the client using a signer and an optional nonce.

### Method
GET

### Endpoint
/auth/derive-api-key

### Parameters
#### Query Parameters
- **signer** (Signer) - Required - The signer used to authorize the request.
- **nonce** (u32) - Optional - A unique number used to prevent replay attacks.

### Response
#### Success Response (200)
- **credentials** (Credentials) - The derived API credentials.
```

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

### GET /events

Source: https://docs.rs/polymarket-client-sdk/0.4.1/src/polymarket_client_sdk/gamma/client.rs.html

Retrieves a list of events with optional filtering.

```APIDOC
## GET /events

### Description
Retrieves a list of events with optional filtering. Events are collections of related markets.

### Method
GET

### Endpoint
events
```
Tokens:
Raw