curl --request POST \
--url https://api.prod.polymarketexchange.com/v1/refdata/instruments \
--header 'Content-Type: application/json' \
--data '
{
"pageSize": 123,
"pageToken": "<string>",
"symbols": [
"<string>"
],
"productId": "<string>",
"states": [],
"eventSeries": "<string>",
"eventCategory": "<string>",
"clearingSym": "<string>",
"startTimeGte": "<string>",
"startTimeLte": "<string>",
"endTimeGte": "<string>",
"endTimeLte": "<string>",
"filter": {
"whereClause": "<string>",
"fieldFilters": [
{
"field": "<string>",
"stringValue": "<string>",
"stringList": {
"values": [
"<string>"
]
}
}
]
}
}
'import requests
url = "https://api.prod.polymarketexchange.com/v1/refdata/instruments"
payload = {
"pageSize": 123,
"pageToken": "<string>",
"symbols": ["<string>"],
"productId": "<string>",
"states": [],
"eventSeries": "<string>",
"eventCategory": "<string>",
"clearingSym": "<string>",
"startTimeGte": "<string>",
"startTimeLte": "<string>",
"endTimeGte": "<string>",
"endTimeLte": "<string>",
"filter": {
"whereClause": "<string>",
"fieldFilters": [
{
"field": "<string>",
"stringValue": "<string>",
"stringList": { "values": ["<string>"] }
}
]
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
pageSize: 123,
pageToken: '<string>',
symbols: ['<string>'],
productId: '<string>',
states: [],
eventSeries: '<string>',
eventCategory: '<string>',
clearingSym: '<string>',
startTimeGte: '<string>',
startTimeLte: '<string>',
endTimeGte: '<string>',
endTimeLte: '<string>',
filter: {
whereClause: '<string>',
fieldFilters: [
{field: '<string>', stringValue: '<string>', stringList: {values: ['<string>']}}
]
}
})
};
fetch('https://api.prod.polymarketexchange.com/v1/refdata/instruments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.prod.polymarketexchange.com/v1/refdata/instruments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'pageSize' => 123,
'pageToken' => '<string>',
'symbols' => [
'<string>'
],
'productId' => '<string>',
'states' => [
],
'eventSeries' => '<string>',
'eventCategory' => '<string>',
'clearingSym' => '<string>',
'startTimeGte' => '<string>',
'startTimeLte' => '<string>',
'endTimeGte' => '<string>',
'endTimeLte' => '<string>',
'filter' => [
'whereClause' => '<string>',
'fieldFilters' => [
[
'field' => '<string>',
'stringValue' => '<string>',
'stringList' => [
'values' => [
'<string>'
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.prod.polymarketexchange.com/v1/refdata/instruments"
payload := strings.NewReader("{\n \"pageSize\": 123,\n \"pageToken\": \"<string>\",\n \"symbols\": [\n \"<string>\"\n ],\n \"productId\": \"<string>\",\n \"states\": [],\n \"eventSeries\": \"<string>\",\n \"eventCategory\": \"<string>\",\n \"clearingSym\": \"<string>\",\n \"startTimeGte\": \"<string>\",\n \"startTimeLte\": \"<string>\",\n \"endTimeGte\": \"<string>\",\n \"endTimeLte\": \"<string>\",\n \"filter\": {\n \"whereClause\": \"<string>\",\n \"fieldFilters\": [\n {\n \"field\": \"<string>\",\n \"stringValue\": \"<string>\",\n \"stringList\": {\n \"values\": [\n \"<string>\"\n ]\n }\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.prod.polymarketexchange.com/v1/refdata/instruments")
.header("Content-Type", "application/json")
.body("{\n \"pageSize\": 123,\n \"pageToken\": \"<string>\",\n \"symbols\": [\n \"<string>\"\n ],\n \"productId\": \"<string>\",\n \"states\": [],\n \"eventSeries\": \"<string>\",\n \"eventCategory\": \"<string>\",\n \"clearingSym\": \"<string>\",\n \"startTimeGte\": \"<string>\",\n \"startTimeLte\": \"<string>\",\n \"endTimeGte\": \"<string>\",\n \"endTimeLte\": \"<string>\",\n \"filter\": {\n \"whereClause\": \"<string>\",\n \"fieldFilters\": [\n {\n \"field\": \"<string>\",\n \"stringValue\": \"<string>\",\n \"stringList\": {\n \"values\": [\n \"<string>\"\n ]\n }\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prod.polymarketexchange.com/v1/refdata/instruments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"pageSize\": 123,\n \"pageToken\": \"<string>\",\n \"symbols\": [\n \"<string>\"\n ],\n \"productId\": \"<string>\",\n \"states\": [],\n \"eventSeries\": \"<string>\",\n \"eventCategory\": \"<string>\",\n \"clearingSym\": \"<string>\",\n \"startTimeGte\": \"<string>\",\n \"startTimeLte\": \"<string>\",\n \"endTimeGte\": \"<string>\",\n \"endTimeLte\": \"<string>\",\n \"filter\": {\n \"whereClause\": \"<string>\",\n \"fieldFilters\": [\n {\n \"field\": \"<string>\",\n \"stringValue\": \"<string>\",\n \"stringList\": {\n \"values\": [\n \"<string>\"\n ]\n }\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"instruments": [
{
"symbol": "<string>",
"tickSize": 123,
"baseCurrency": "<string>",
"multiplier": 123,
"minimumTradeQty": "<string>",
"startDate": {
"year": 123,
"month": 123,
"day": 123
},
"expirationDate": {
"year": 123,
"month": 123,
"day": 123
},
"terminationDate": {
"year": 123,
"month": 123,
"day": 123
},
"tradingSchedule": [
{
"daysOfWeek": [
123
],
"timeOfDay": {
"hours": 123,
"minutes": 123,
"seconds": 123
},
"duration": "<string>",
"hideMarketData": true,
"expireAllOrders": true
}
],
"description": "<string>",
"clearingHouse": "<string>",
"minimumUnaffiliatedFirms": "<string>",
"nonTradable": true,
"jsonAttributes": "<string>",
"productId": "<string>",
"priceLimit": {
"low": "<string>",
"high": "<string>",
"lowSet": true,
"highSet": true,
"relativeLow": 123,
"relativeHigh": 123,
"relativeLowSet": true,
"relativeHighSet": true
},
"orderSizeLimit": {
"low": "<string>",
"high": "<string>",
"lowSet": true,
"highSet": true,
"totalNotionalLow": "<string>",
"totalNotionalHigh": "<string>",
"totalNotionalLowSet": true,
"totalNotionalHighSet": true
},
"expirationTime": {
"hours": 123,
"minutes": 123,
"seconds": 123
},
"tradeSettlementPeriod": "<string>",
"priceScale": "<string>",
"fractionalQtyScale": "<string>",
"settlementCurrency": "<string>",
"settlementPriceScale": "<string>",
"metadata": {},
"eventAttributes": {
"question": "<string>",
"payoutValue": "<string>",
"eventDisplayName": "<string>",
"eventId": "<string>",
"strikeValue": "<string>",
"evaluationType": "<string>",
"strikeUnit": "<string>",
"calculationMethod": "<string>",
"timeSpecifier": "<string>",
"positionAccountabilityValue": "<string>"
},
"createTime": "2023-11-07T05:31:56Z",
"updateTime": "2023-11-07T05:31:56Z"
}
],
"nextPageToken": "<string>",
"eof": true
}List instruments
Returns a list of instruments matching the request
curl --request POST \
--url https://api.prod.polymarketexchange.com/v1/refdata/instruments \
--header 'Content-Type: application/json' \
--data '
{
"pageSize": 123,
"pageToken": "<string>",
"symbols": [
"<string>"
],
"productId": "<string>",
"states": [],
"eventSeries": "<string>",
"eventCategory": "<string>",
"clearingSym": "<string>",
"startTimeGte": "<string>",
"startTimeLte": "<string>",
"endTimeGte": "<string>",
"endTimeLte": "<string>",
"filter": {
"whereClause": "<string>",
"fieldFilters": [
{
"field": "<string>",
"stringValue": "<string>",
"stringList": {
"values": [
"<string>"
]
}
}
]
}
}
'import requests
url = "https://api.prod.polymarketexchange.com/v1/refdata/instruments"
payload = {
"pageSize": 123,
"pageToken": "<string>",
"symbols": ["<string>"],
"productId": "<string>",
"states": [],
"eventSeries": "<string>",
"eventCategory": "<string>",
"clearingSym": "<string>",
"startTimeGte": "<string>",
"startTimeLte": "<string>",
"endTimeGte": "<string>",
"endTimeLte": "<string>",
"filter": {
"whereClause": "<string>",
"fieldFilters": [
{
"field": "<string>",
"stringValue": "<string>",
"stringList": { "values": ["<string>"] }
}
]
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
pageSize: 123,
pageToken: '<string>',
symbols: ['<string>'],
productId: '<string>',
states: [],
eventSeries: '<string>',
eventCategory: '<string>',
clearingSym: '<string>',
startTimeGte: '<string>',
startTimeLte: '<string>',
endTimeGte: '<string>',
endTimeLte: '<string>',
filter: {
whereClause: '<string>',
fieldFilters: [
{field: '<string>', stringValue: '<string>', stringList: {values: ['<string>']}}
]
}
})
};
fetch('https://api.prod.polymarketexchange.com/v1/refdata/instruments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.prod.polymarketexchange.com/v1/refdata/instruments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'pageSize' => 123,
'pageToken' => '<string>',
'symbols' => [
'<string>'
],
'productId' => '<string>',
'states' => [
],
'eventSeries' => '<string>',
'eventCategory' => '<string>',
'clearingSym' => '<string>',
'startTimeGte' => '<string>',
'startTimeLte' => '<string>',
'endTimeGte' => '<string>',
'endTimeLte' => '<string>',
'filter' => [
'whereClause' => '<string>',
'fieldFilters' => [
[
'field' => '<string>',
'stringValue' => '<string>',
'stringList' => [
'values' => [
'<string>'
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.prod.polymarketexchange.com/v1/refdata/instruments"
payload := strings.NewReader("{\n \"pageSize\": 123,\n \"pageToken\": \"<string>\",\n \"symbols\": [\n \"<string>\"\n ],\n \"productId\": \"<string>\",\n \"states\": [],\n \"eventSeries\": \"<string>\",\n \"eventCategory\": \"<string>\",\n \"clearingSym\": \"<string>\",\n \"startTimeGte\": \"<string>\",\n \"startTimeLte\": \"<string>\",\n \"endTimeGte\": \"<string>\",\n \"endTimeLte\": \"<string>\",\n \"filter\": {\n \"whereClause\": \"<string>\",\n \"fieldFilters\": [\n {\n \"field\": \"<string>\",\n \"stringValue\": \"<string>\",\n \"stringList\": {\n \"values\": [\n \"<string>\"\n ]\n }\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.prod.polymarketexchange.com/v1/refdata/instruments")
.header("Content-Type", "application/json")
.body("{\n \"pageSize\": 123,\n \"pageToken\": \"<string>\",\n \"symbols\": [\n \"<string>\"\n ],\n \"productId\": \"<string>\",\n \"states\": [],\n \"eventSeries\": \"<string>\",\n \"eventCategory\": \"<string>\",\n \"clearingSym\": \"<string>\",\n \"startTimeGte\": \"<string>\",\n \"startTimeLte\": \"<string>\",\n \"endTimeGte\": \"<string>\",\n \"endTimeLte\": \"<string>\",\n \"filter\": {\n \"whereClause\": \"<string>\",\n \"fieldFilters\": [\n {\n \"field\": \"<string>\",\n \"stringValue\": \"<string>\",\n \"stringList\": {\n \"values\": [\n \"<string>\"\n ]\n }\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prod.polymarketexchange.com/v1/refdata/instruments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"pageSize\": 123,\n \"pageToken\": \"<string>\",\n \"symbols\": [\n \"<string>\"\n ],\n \"productId\": \"<string>\",\n \"states\": [],\n \"eventSeries\": \"<string>\",\n \"eventCategory\": \"<string>\",\n \"clearingSym\": \"<string>\",\n \"startTimeGte\": \"<string>\",\n \"startTimeLte\": \"<string>\",\n \"endTimeGte\": \"<string>\",\n \"endTimeLte\": \"<string>\",\n \"filter\": {\n \"whereClause\": \"<string>\",\n \"fieldFilters\": [\n {\n \"field\": \"<string>\",\n \"stringValue\": \"<string>\",\n \"stringList\": {\n \"values\": [\n \"<string>\"\n ]\n }\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"instruments": [
{
"symbol": "<string>",
"tickSize": 123,
"baseCurrency": "<string>",
"multiplier": 123,
"minimumTradeQty": "<string>",
"startDate": {
"year": 123,
"month": 123,
"day": 123
},
"expirationDate": {
"year": 123,
"month": 123,
"day": 123
},
"terminationDate": {
"year": 123,
"month": 123,
"day": 123
},
"tradingSchedule": [
{
"daysOfWeek": [
123
],
"timeOfDay": {
"hours": 123,
"minutes": 123,
"seconds": 123
},
"duration": "<string>",
"hideMarketData": true,
"expireAllOrders": true
}
],
"description": "<string>",
"clearingHouse": "<string>",
"minimumUnaffiliatedFirms": "<string>",
"nonTradable": true,
"jsonAttributes": "<string>",
"productId": "<string>",
"priceLimit": {
"low": "<string>",
"high": "<string>",
"lowSet": true,
"highSet": true,
"relativeLow": 123,
"relativeHigh": 123,
"relativeLowSet": true,
"relativeHighSet": true
},
"orderSizeLimit": {
"low": "<string>",
"high": "<string>",
"lowSet": true,
"highSet": true,
"totalNotionalLow": "<string>",
"totalNotionalHigh": "<string>",
"totalNotionalLowSet": true,
"totalNotionalHighSet": true
},
"expirationTime": {
"hours": 123,
"minutes": 123,
"seconds": 123
},
"tradeSettlementPeriod": "<string>",
"priceScale": "<string>",
"fractionalQtyScale": "<string>",
"settlementCurrency": "<string>",
"settlementPriceScale": "<string>",
"metadata": {},
"eventAttributes": {
"question": "<string>",
"payoutValue": "<string>",
"eventDisplayName": "<string>",
"eventId": "<string>",
"strikeValue": "<string>",
"evaluationType": "<string>",
"strikeUnit": "<string>",
"calculationMethod": "<string>",
"timeSpecifier": "<string>",
"positionAccountabilityValue": "<string>"
},
"createTime": "2023-11-07T05:31:56Z",
"updateTime": "2023-11-07T05:31:56Z"
}
],
"nextPageToken": "<string>",
"eof": true
}Body
Request for listing instruments with optional filters and pagination.
Results per page (default: 50, max: 1000)
Pagination cursor from previous response
Filter by specific instrument symbols
Filter by product ID
Filter tradable vs non-tradable instruments
TRADABLE_FILTER_TRADABLE, TRADABLE_FILTER_NON_TRADABLE, TRADABLE_FILTER_ALL Filter by instrument states (e.g., INSTRUMENT_STATE_OPEN)
PENDING: Initial state for a newly created instrument which has not yet begun trading.
CLOSED: No order entry, modification, cancellation, or matching. Day orders expired.
OPEN: Continuous order entry and matching.
PREOPEN: Orders accepted, no matching. Dutch Auction on transition to OPEN.
MATCH_AND_CLOSE_AUCTION: Like PREOPEN, matches on transition out.
SUSPENDED: Cancel only. No entry, modification, or matching.
HALTED: Like SUSPENDED, no cancels allowed.
EXPIRED: All resting orders expired, no new orders.
TERMINATED: Order book removed, all orders and positions closed.
INSTRUMENT_STATE_CLOSED, INSTRUMENT_STATE_OPEN, INSTRUMENT_STATE_PREOPEN, INSTRUMENT_STATE_SUSPENDED, INSTRUMENT_STATE_EXPIRED, INSTRUMENT_STATE_TERMINATED, INSTRUMENT_STATE_HALTED, INSTRUMENT_STATE_MATCH_AND_CLOSE_AUCTION, INSTRUMENT_STATE_PENDING Filter by event series (e.g., 'nfl', 'nba', 'cbb')
Filter by event category (e.g., 'SPR', 'POL', 'CRY')
Filter by clearing symbol prefix (e.g., 'AEC-NFL')
Filter instruments starting on or after this date (format: 'YYYY-MM-DD')
Filter instruments starting on or before this date
Filter instruments expiring on or after this date
Filter instruments expiring on or before this date
Advanced filter with whereClause and/or fieldFilters (ANDed together if both provided)
Show child attributes
Show child attributes