Get Instruments

Get all instruments.

GET /v1/info/instruments

Get Instruments

cURL

curl --request GET \
  --url https://api.perpetuals.polymarket.com/v1/info/instruments

import requests

url = "https://api.perpetuals.polymarket.com/v1/info/instruments"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.perpetuals.polymarket.com/v1/info/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.perpetuals.polymarket.com/v1/info/instruments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.perpetuals.polymarket.com/v1/info/instruments"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.perpetuals.polymarket.com/v1/info/instruments")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.perpetuals.polymarket.com/v1/info/instruments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

200

[
  {
    "instrument_id": 123,
    "instrument_type": "perpetual",
    "symbol": "NVDA-USDC",
    "base_asset": "NVDA",
    "quote_asset": "USDC",
    "funding_interval": "1h",
    "quantity_decimals": 2,
    "price_decimals": 2,
    "price_bounds": "0.05",
    "liquidation_fee": "0.025",
    "max_order_count": 200,
    "min_notional": "1.00",
    "max_market_notional": "1000000.00",
    "max_limit_notional": "10000000.00",
    "max_leverage": 20,
    "risk_tiers": [
      {
        "lower_bound": "0",
        "max_leverage": 20
      }
    ]
  }
]

{
  "status": "err",
  "error": "insufficient_margin"
}

{
  "status": "err",
  "error": "insufficient_margin"
}

{
  "status": "err",
  "error": "insufficient_margin"
}

Request Weight: 2

Query Parameters

instrument_id · integer

Instrument ID

instrument_type · enum<string>

Instrument type

Available options: perpetual

category · enum<string>

Instrument category

Available options: equity, commodity, index, crypto

Response

200

application/json

Instruments response.

instrument_id · integer · required

Instrument ID

instrument_type · enum<string> · required

Instrument type

Available options: perpetual

category · enum<string> · required

Instrument category

Available options: equity, commodity, index, crypto

symbol · string · required

Instrument symbol

Example:

"NVDA-USDC"

base_asset · string · required

Base asset name

Example:

"NVDA"

quote_asset · string · required

Quote asset name

Example:

"USDC"

funding_interval · string · required

Funding interval

Example:

"1h"

quantity_decimals · integer · required

Number of decimal places for quantity.

Example:

2

price_decimals · integer · required

Number of decimal places for price. Non-integer prices have a maximum of 5 significant figures; integer prices are allowed regardless of significant figures.

Example:

2

price_bounds · string · required

Price bounds percentage

Example:

"0.05"

liquidation_fee · string · required

Liquidation fee rate

Example:

"0.025"

max_order_count · integer · required

Maximum open order count

Example:

200

min_notional · string · required

Minimum notional value in USD

Example:

"1.00"

max_market_notional · string · required

Maximum market order notional value in USD

Example:

"1000000.00"

max_limit_notional · string · required

Maximum limit order notional value in USD

Example:

"10000000.00"

max_leverage · integer · required

Maximum leverage

Example:

20

risk_tiers · object[] · required

Show child attributes