polymarket

README

PolyMarket Provider

Docs: https://docs.polymarket.com/

Polymarket is a web3 based prediction market. This provider uses the Polymarket CLOB REST API to access the off-chain order book.

How it Works

Polymarket uses conditional outcome tokens, a token that represents an outcome of a specific event. All tokens in Polymarket are denominated in terms of USD.

We suggest tickers take the form of the <market_slug>?<outcome>/USD. However, tickers are ignored by the polymarket provider, and they can be whatever arbitrary data that suits your use case. The ONLY required text is your ticker must end in /USD.

Example: WILL_BERNIE_SANDERS_WIN_THE_2024_US_PRESIDENTIAL_ELECTION?YES/USD Example2: BernieBecomesPresident/USD

The offchain ticker must be <market_id>/<token_id>

example: 0x08f5fe8d0d29c08a96f0bc3dfb52f50e0caf470d94d133d95d38fa6c847e0925/95128817762909535143571435260705470642391662537976312011260538371392879420759

The Provider queries the /markets endpoint, and looks for the token_id in the response. The provider will throw an error if the token_id in the offchain ticker is not present in the response data.

Example:

https://clob.polymarket.com/markets/0xc6485bb7ea46d7bb89beb9c91e7572ecfc72a6273789496f78bc5e989e4d1638

Market Config

Below is an example of a market config for a single Polymarket token.

 {
  "markets": {
    "WILL_BERNIE_SANDERS_WIN_THE_2024_US_PRESIDENTIAL_ELECTION?YES/USD": {
      "ticker": {
        "currency_pair": {
          "Base": "WILL_BERNIE_SANDERS_WIN_THE_2024_US_PRESIDENTIAL_ELECTION?YES",
          "Quote": "USD"
        },
        "decimals": 3,
        "min_provider_count": 1,
        "enabled": true
      },
      "provider_configs": [
        {
          "name": "polymarket_api",
          "off_chain_ticker": "0x08f5fe8d0d29c08a96f0bc3dfb52f50e0caf470d94d133d95d38fa6c847e0925/95128817762909535143571435260705470642391662537976312011260538371392879420759"
        }
      ]
    }
  }
 }

Oracle Config

Below is an example of an oracle config with a Polymarket provider.

{
  "providers": {
    "polymarket_api": {
      "name": "polymarket_api",
      "type": "price_provider",
      "api": {
        "name": "polymarket_api",
        "enabled": true,
        "timeout": 3000000000,
        "interval": 500000000,
        "reconnectTimeout": 2000000000,
        "maxQueries": 1,
        "atomic": false,
        "endpoints": [
          {
            "url": "https://clob.polymarket.com/markets/%s",
            "authentication": {
              "apiKey": "",
              "apiKeyHeader": ""
            }
          }
        ],
        "batchSize": 0
      }
    }
  }
}

Rate Limits

While not publicly available on the docs, the following information was given from a Polymarket developer regarding rate limits on the CLOB API:

• In general you can't do more than 20req/s
• You can't request orders and trades combined more than 20req/s
• You can't do more than 10 reqs to /book per second

Documentation

Index

• Constants
• Variables
• func NewAPIHandler(api config.APIConfig) (types.PriceAPIDataHandler, error)
• type APIHandler
  • func (h APIHandler) CreateURL(ids []types.ProviderTicker) (string, error)
  • func (h APIHandler) ParseResponse(ids []types.ProviderTicker, response *http.Response) types.PriceResponse
• type MarketsResponse
• type TokenData

Constants

const (
	// Name is the name of the Polymarket provider.
	Name = "polymarket_api"

	// URL is the default base URL of the Polymarket CLOB API. It uses the `markets` endpoint with a given market ID.
	URL = "https://clob.polymarket.com/markets/%s"
)

Variables

var DefaultAPIConfig = config.APIConfig{
	Name:             Name,
	Atomic:           false,
	Enabled:          true,
	Timeout:          3 * time.Second,
	Interval:         500 * time.Millisecond,
	ReconnectTimeout: 2 * time.Second,
	MaxQueries:       1,
	Endpoints:        []config.Endpoint{{URL: URL}},
}

Functions

func NewAPIHandler

func NewAPIHandler(api config.APIConfig) (types.PriceAPIDataHandler, error)

NewAPIHandler returns a new Polymarket PriceAPIDataHandler.

Types

type APIHandler

type APIHandler struct {
	// contains filtered or unexported fields
}

APIHandler implements the PriceAPIDataHandler interface for Polymarket, which can be used by a base provider. The handler fetches data from the `markets` endpoint.

func (APIHandler) CreateURL

func (h APIHandler) CreateURL(ids []types.ProviderTicker) (string, error)

CreateURL returns the URL that is used to fetch data from the Polymarket API for the given ticker. Since the markets endpoint's price data is automatically denominated in USD, only one ID is expected to be passed into this method.

func (APIHandler) ParseResponse

func (h APIHandler) ParseResponse(ids []types.ProviderTicker, response *http.Response) types.PriceResponse

ParseResponse parses the HTTP response from the markets endpoint of the Polymarket API endpoint and returns the resulting data.

type MarketsResponse

type MarketsResponse struct {
	EnableOrderBook         bool      `json:"enable_order_book"`
	Active                  bool      `json:"active"`
	Closed                  bool      `json:"closed"`
	Archived                bool      `json:"archived"`
	AcceptingOrders         bool      `json:"accepting_orders"`
	AcceptingOrderTimestamp time.Time `json:"accepting_order_timestamp"`
	MinimumOrderSize        int       `json:"minimum_order_size"`
	MinimumTickSize         float64   `json:"minimum_tick_size"`
	ConditionID             string    `json:"condition_id"`
	QuestionID              string    `json:"question_id"`
	Question                string    `json:"question"`
	Description             string    `json:"description"`
	MarketSlug              string    `json:"market_slug"`
	EndDateIso              time.Time `json:"end_date_iso"`
	GameStartTime           any       `json:"game_start_time"`
	SecondsDelay            int       `json:"seconds_delay"`
	Fpmm                    string    `json:"fpmm"`
	MakerBaseFee            int       `json:"maker_base_fee"`
	TakerBaseFee            int       `json:"taker_base_fee"`
	NotificationsEnabled    bool      `json:"notifications_enabled"`
	NegRisk                 bool      `json:"neg_risk"`
	NegRiskMarketID         string    `json:"neg_risk_market_id"`
	NegRiskRequestID        string    `json:"neg_risk_request_id"`
	Icon                    string    `json:"icon"`
	Image                   string    `json:"image"`
	Rewards                 struct {
		Rates []struct {
			AssetAddress     string `json:"asset_address"`
			RewardsDailyRate int    `json:"rewards_daily_rate"`
		} `json:"rates"`
		MinSize   int     `json:"min_size"`
		MaxSpread float64 `json:"max_spread"`
	} `json:"rewards"`
	Is5050Outcome bool        `json:"is_50_50_outcome"`
	Tokens        []TokenData `json:"tokens"`
	Tags          []string    `json:"tags"`
}

type TokenData

type TokenData struct {
	TokenID string  `json:"token_id"`
	Outcome string  `json:"outcome"`
	Price   float64 `json:"price"`
}