L1 (p.polymarket.0.2.0.doc.polymarket.clob.Polymarket

polymarket
- CHANGELOG
- README
- Library polymarket
  - Polymarket
- Library polymarket.clob
  - Polymarket_clob
- Library polymarket.common
  - Polymarket_common
- Library polymarket.data
  - Polymarket_data
- Library polymarket.gamma
  - Polymarket_gamma
- Library polymarket.http
  - Polymarket_http
- Library polymarket.rate_limiter
  - Polymarket_rate_limiter
- Library polymarket.rfq
  - Polymarket_rfq
- Library polymarket.rtds
  - Polymarket_rtds
- Library polymarket.websocket
  - Websocket
- Library polymarket.wss
  - Polymarket_wss
- Library ppx_polymarket_enum
  - Ppx_polymarket_enum
- Sources

L1-Authenticated Client

Provides L1 (wallet-based) authentication for creating and deriving API keys, plus all public endpoints. L1 authentication uses EIP-712 signatures from the wallet's private key.

Sourcetype t = l1

L1-authenticated client with private key for wallet operations.

Source

val create : 
  ?base_url:string ->
  sw:Eio.Switch.t ->
  net:_ Eio.Net.t ->
  rate_limiter:Polymarket_rate_limiter.Rate_limiter.t ->
  private_key:Crypto.private_key ->
  unit ->
  t

Create a new L1-authenticated CLOB client.

parameter base_url
Optional base URL (defaults to default_base_url)

parameter sw
The Eio switch for resource management

parameter net
The Eio network interface

parameter rate_limiter
Shared rate limiter for enforcing API limits

parameter private_key
The wallet's private key for signing

Sourceval address : t -> string

Get the Ethereum address derived from the private key.

L1 Authentication Endpoints

Source

val create_api_key : 
  t ->
  nonce:int ->
  (Auth.api_key_response, Polymarket_http.Client.error) result

Create a new API key using L1 wallet authentication. Returns the API key, secret, and passphrase.

Source

val derive_api_key : 
  t ->
  nonce:int ->
  (l2 * Auth.api_key_response, Polymarket_http.Client.error) result

Derive API key from wallet and automatically upgrade to L2 client. Returns both the L2 client and the raw response (for credential storage).

Order Book

Source

val get_order_book : 
  t ->
  token_id:string ->
  unit ->
  (Types.order_book_summary, Polymarket_http.Client.error) result

Source

val get_order_books : 
  t ->
  token_ids:string list ->
  unit ->
  (Types.order_book_summary list, Polymarket_http.Client.error) result

Pricing

Source

val get_price : 
  t ->
  token_id:string ->
  side:Polymarket_clob.Types.Side.t ->
  unit ->
  (Types.price_response, Polymarket_http.Client.error) result

Source

val get_midpoint : 
  t ->
  token_id:string ->
  unit ->
  (Types.midpoint_response, Polymarket_http.Client.error) result

Source

val get_prices : 
  t ->
  requests:(string * Polymarket_clob.Types.Side.t) list ->
  unit ->
  (Types.prices_response, Polymarket_http.Client.error) result

Source

val get_spreads : 
  t ->
  token_ids:string list ->
  unit ->
  (Types.spreads_response, Polymarket_http.Client.error) result

Timeseries

Source

val get_price_history : 
  t ->
  market:string ->
  ?start_ts:int ->
  ?end_ts:int ->
  ?interval:Types.Interval.t ->
  ?fidelity:int ->
  unit ->
  (Types.price_history, Polymarket_http.Client.error) result