polymarket

polymarket

Kind: global class
Extends: Exchange

• fetchMarkets
• fetchTicker
• fetchTickers
• fetchOrderBook
• fetchOHLCV
• fetchTime
• fetchStatus
• fetchOpenInterest
• fetchTradingFee
• fetchTrades
• fetchMyTrades
• fetchOrderTrades
• fetchBalance
• fetchPositions
• fetchPosition
• fetchOpenOrders
• fetchOrder
• createOrder
• createOrders
• createMarketBuyOrderWithCost
• cancelOrder
• cancelOrders
• cancelAllOrders
• fetchEvents
• fetchEvent
• deriveApiKey
• createApiKey
• createOrDeriveApiKey
• watchOrderBook
• watchTrades
• watchTicker
• watchOrders
• watchMyTrades

fetchMarkets

retrieves data on all markets for polymarket, each prediction market becomes one market with its outcome tokens listed under the outcomes key

Kind: instance method of polymarket
Returns: Array<object> - an array of objects representing market data

See

• https://docs.polymarket.com/api-reference/events/list-events
• https://docs.polymarket.com/api-reference/search/search-markets-events-and-profiles

polymarket.fetchMarkets (params?)

fetchTicker

fetches the current mid-price and best bid/ask for a single outcome token

Kind: instance method of polymarket
Returns: object - a ticker structure

See

• https://docs.polymarket.com/api-reference/data/get-midpoint-price
• https://docs.polymarket.com/api-reference/market-data/get-order-book
• https://docs.polymarket.com/api-reference/data/get-last-trade-price

polymarket.fetchTicker (outcome, params?)

fetchTickers

fetches tickers for multiple outcome tokens at once using the batched CLOB book, midpoint and last-trade-price endpoints (200 per request trio)

Kind: instance method of polymarket
Returns: object - a dictionary of ticker structures indexed by outcome

See

• https://docs.polymarket.com/api-reference/market-data/get-order-books-request-body
• https://docs.polymarket.com/api-reference/market-data/get-midpoint-prices-request-body
• https://docs.polymarket.com/api-reference/data/get-last-trades-prices

polymarket.fetchTickers (outcomes, params?)

fetchOrderBook

fetches the CLOB order book for a single outcome token

Kind: instance method of polymarket
Returns: object - an order book structure

See: https://docs.polymarket.com/api-reference/market-data/get-order-book

polymarket.fetchOrderBook (outcome, limit?, params?)

fetchOHLCV

fetches price history ticks for a single outcome token and buckets them client-side into OHLCV candles, snapping tick timestamps to the candle boundary

Kind: instance method of polymarket
Returns: Array<Array<int>> - a list of candles ordered as timestamp, open, high, low, close, volume

See: https://docs.polymarket.com/api-reference/markets/get-prices-history

polymarket.fetchOHLCV (outcome, timeframe, since?, limit?, params?)

fetchTime

fetches the current timestamp from the CLOB server

Kind: instance method of polymarket
Returns: int - the current server time in milliseconds

See: https://docs.polymarket.com/api-reference/data/get-server-time

polymarket.fetchTime (params?)

fetchStatus

fetches the gamma API health status

Kind: instance method of polymarket
Returns: object - a status structure

See: https://docs.polymarket.com/api-reference/events/list-events

polymarket.fetchStatus (params?)

fetchOpenInterest

fetches the open interest of a prediction market outcome

Kind: instance method of polymarket
Returns: object - an open interest structure

See: https://docs.polymarket.com/api-reference/misc/get-open-interest

polymarket.fetchOpenInterest (outcome, params?)

fetchTradingFee

fetches the base fee rate for a prediction market outcome token

Kind: instance method of polymarket
Returns: object - a fee structure

See: https://docs.polymarket.com/api-reference/market-data/get-fee-rate

polymarket.fetchTradingFee (outcome, params?)

fetchTrades

fetches public trade history for a single outcome token from the data API

Kind: instance method of polymarket
Returns: Array<object> - a list of trade structures

See: https://docs.polymarket.com/api-reference/core/get-trades-for-a-user-or-markets

polymarket.fetchTrades (outcome, since?, limit?, params?)

fetchMyTrades

fetches the authenticated user's trade history from the CLOB, optionally filtered by outcome token

Kind: instance method of polymarket
Returns: Array<object> - a list of trade structures

See: https://docs.polymarket.com/api-reference/trade/get-trades

polymarket.fetchMyTrades (outcome?, since?, limit?, params?)

fetchOrderTrades

fetches all the trades made from a single order

Kind: instance method of polymarket
Returns: Array<object> - a list of trade structures

See: https://docs.polymarket.com/api-reference/trade/get-trades

polymarket.fetchOrderTrades (id, outcome?, since?, limit?, params?)

fetchBalance

fetches the USDC collateral balance available for trading on the CLOB

Kind: instance method of polymarket
Returns: object - a balance structure

See: https://docs.polymarket.com/api-reference/trade/get-balance-allowance

polymarket.fetchBalance (params?)

fetchPositions

fetches open outcome token positions for the wallet from the data API

Kind: instance method of polymarket
Returns: Array<object> - a list of position structures

See: https://docs.polymarket.com/api-reference/core/get-current-positions-for-a-user

polymarket.fetchPositions (outcomes?, params?)

fetchPosition

fetches the open position for a single outcome token

Kind: instance method of polymarket
Returns: object - a position structure

See: https://docs.polymarket.com/api-reference/core/get-current-positions-for-a-user

polymarket.fetchPosition (outcome, params?)

fetchOpenOrders

fetches open resting orders for the authenticated user, optionally filtered by outcome token

Kind: instance method of polymarket
Returns: Array<object> - a list of order structures

See: https://docs.polymarket.com/api-reference/trade/get-user-orders

polymarket.fetchOpenOrders (outcome?, since?, limit?, params?)

fetchOrder

fetches a single order by id from the CLOB private data endpoint

Kind: instance method of polymarket
Returns: object - an order structure

See: https://docs.polymarket.com/api-reference/trade/get-single-order-by-id

polymarket.fetchOrder (id, outcome?, params?)

createOrder

places a limit or market order on the CLOB for the given outcome token

Kind: instance method of polymarket
Returns: object - an order structure

See: https://docs.polymarket.com/api-reference/trade/post-a-new-order

polymarket.createOrder (outcome, type, side, amount, price?, params?)

createOrders

places multiple orders on the CLOB in a single batched request

Kind: instance method of polymarket
Returns: Array<object> - a list of order structures

See: https://docs.polymarket.com/api-reference/trade/post-orders

polymarket.createOrders (orders, params?)

createMarketBuyOrderWithCost

places a market buy order sized by USDC cost (how much to spend) rather than shares

Kind: instance method of polymarket
Returns: object - an order structure

See: https://docs.polymarket.com/api-reference/trade/post-a-new-order

polymarket.createMarketBuyOrderWithCost (outcome, cost, params?)

cancelOrder

cancels a single open order by id on the CLOB

Kind: instance method of polymarket
Returns: object - an order structure

See: https://docs.polymarket.com/api-reference/trade/cancel-single-order

polymarket.cancelOrder (id, outcome?, params?)

cancelOrders

cancels multiple open orders by id on the CLOB in a single request

Kind: instance method of polymarket
Returns: Array<object> - a list of order structures

See: https://docs.polymarket.com/api-reference/trade/cancel-orders

polymarket.cancelOrders (ids, outcome?, params?)

cancelAllOrders

cancels all open orders on the CLOB, optionally scoped to one outcome token

Kind: instance method of polymarket
Returns: Array<object> - a list of order structures

See

• https://docs.polymarket.com/api-reference/trade/cancel-all-orders
• https://docs.polymarket.com/api-reference/trade/cancel-market-orders

polymarket.cancelAllOrders (outcome?, params?)

fetchEvents

fetches prediction-market events matching the given scope (query/queries/tags/eventId/slug — required) and caches their markets and outcomes on the instance; for an unscoped top-volume browse use fetchMarkets ()

Kind: instance method of polymarket
Returns: Array<object> - an array of event structures

See

• https://docs.polymarket.com/api-reference/search/search-markets-events-and-profiles
• https://docs.polymarket.com/api-reference/events/list-events

polymarket.fetchEvents (params?)

fetchEvent

fetches a single prediction-market event by its id or slug

Kind: instance method of polymarket
Returns: object - a prediction event structure

See

• https://docs.polymarket.com/api-reference/events/get-event-by-id
• https://docs.polymarket.com/api-reference/events/get-event-by-slug

polymarket.fetchEvent (id, params?)

deriveApiKey

derives the L2 api credentials (apiKey, secret, passphrase) deterministically from the wallet private key

Kind: instance method of polymarket
Returns: object - the api credentials { apiKey, secret, passphrase }

See: https://docs.polymarket.com/developers/CLOB/authentication

polymarket.deriveApiKey (params?)

createApiKey

creates new L2 api credentials (apiKey, secret, passphrase) for the wallet private key

Kind: instance method of polymarket
Returns: object - the api credentials { apiKey, secret, passphrase }

See: https://docs.polymarket.com/developers/CLOB/authentication

polymarket.createApiKey (params?)

createOrDeriveApiKey

derives the existing L2 api credentials for the wallet private key, creating them if none exist yet

Kind: instance method of polymarket
Returns: object - the api credentials { apiKey, secret, passphrase }

See: https://docs.polymarket.com/developers/CLOB/authentication

polymarket.createOrDeriveApiKey (params?)

watchOrderBook

streams live order-book updates for a single Polymarket outcome token

Kind: instance method of polymarket
Returns: object - an order book structure

polymarket.watchOrderBook (outcome, limit?, params?)

watchTrades

streams live fills for a single Polymarket outcome token

Kind: instance method of polymarket
Returns: Array<object> - a list of trade structures

polymarket.watchTrades (outcome, since?, limit?, params?)

watchTicker

streams a synthetic ticker derived from order-book snapshots and deltas (mid = (bid + ask) / 2)

Kind: instance method of polymarket
Returns: object - a ticker structure

polymarket.watchTicker (outcome, params?)

watchOrders

watches the authenticated user's order updates over the CLOB user websocket channel

Kind: instance method of polymarket
Returns: Array<object> - a list of order structures

See: https://docs.polymarket.com/developers/CLOB/websocket/user-channel

polymarket.watchOrders (outcome?, since?, limit?, params?)

watchMyTrades

watches the authenticated user's trade fills over the CLOB user websocket channel

Kind: instance method of polymarket
Returns: Array<object> - a list of trade structures

See: https://docs.polymarket.com/developers/CLOB/websocket/user-channel

polymarket.watchMyTrades (outcome?, since?, limit?, params?)