Client (p.polymarket.0.2.0.doc.polymarket.rfq.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

Sourcemodule Auth = Polymarket_common.Auth

Sourcemodule Crypto = Polymarket_common.Crypto

Sourceval default_base_url : string

Default base URL for the RFQ API: https://clob.polymarket.com

Sourcetype t

RFQ client with L2 authentication.

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 ->
  credentials:Auth.credentials ->
  unit ->
  t

Sourceval address : t -> string

Get the Ethereum address derived from the private key.

Sourceval credentials : t -> Auth.credentials

Get the API credentials.

Request Endpoints

Source

val create_request : 
  t ->
  body:Types.create_request_body ->
  unit ->
  (Types.create_request_response, Types.error) result

Source

val cancel_request : 
  t ->
  request_id:Types.request_id ->
  unit ->
  (unit, Types.error) result

Source

val get_requests : 
  t ->
  ?offset:string ->
  ?limit:int ->
  ?state:Types.State_filter.t ->
  ?request_ids:string list ->
  ?markets:string list ->
  ?size_min:float ->
  ?size_max:float ->
  ?size_usdc_min:float ->
  ?size_usdc_max:float ->
  ?price_min:float ->
  ?price_max:float ->
  ?sort_by:Types.Sort_by.t ->
  ?sort_dir:Types.Sort_dir.t ->
  unit ->
  (Types.get_requests_response, Types.error) result

Quote Endpoints

Source

val create_quote : 
  t ->
  body:Types.create_quote_body ->
  unit ->
  (Types.create_quote_response, Types.error) result

Source

val cancel_quote : 
  t ->
  quote_id:Types.quote_id ->
  unit ->
  (unit, Types.error) result

Source

val get_quotes : 
  t ->
  ?offset:string ->
  ?limit:int ->
  ?state:Types.State_filter.t ->
  ?quote_ids:string list ->
  ?request_ids:string list ->
  ?markets:string list ->
  ?size_min:float ->
  ?size_max:float ->
  ?size_usdc_min:float ->
  ?size_usdc_max:float ->
  ?price_min:float ->
  ?price_max:float ->
  ?sort_by:Types.Sort_by.t ->
  ?sort_dir:Types.Sort_dir.t ->
  unit ->
  (Types.get_quotes_response, Types.error) result

Execution Endpoints

Source

val accept_quote : 
  t ->
  body:Types.accept_quote_body ->
  unit ->
  (unit, Types.error) result

Accept a quote. Use Order_builder.build_accept_quote_body to create the body.

Source

val approve_order : 
  t ->
  body:Types.approve_order_body ->
  unit ->
  (Types.approve_order_response, Types.error) result

Approve an order. Use Order_builder.build_accept_quote_body to create the body.