Get an instrument by id or ticker
curl --request GET \
--url https://api.example.com/api/v1/instruments/{id_or_ticker}import requests
url = "https://api.example.com/api/v1/instruments/{id_or_ticker}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v1/instruments/{id_or_ticker}', 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.example.com/api/v1/instruments/{id_or_ticker}",
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.example.com/api/v1/instruments/{id_or_ticker}"
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.example.com/api/v1/instruments/{id_or_ticker}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/instruments/{id_or_ticker}")
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{
"fractional_enabled": true,
"updated_time": 1795750000123,
"id": "598471892347",
"ticker": "NFL-GAMEWINNER-26NOV28LARSF-LAR",
"series_ticker": "NFL-GAMEWINNER",
"event_ticker": "26NOV28LARSF",
"group_ticker": "NFL-GAMEWINNER-26NOV28LARSF",
"title": "Rams win",
"proposition": "Los Angeles Rams win the game.",
"disclaimers": "Professional football players may not trade this instrument.",
"contract_size": "1.00",
"price_level_structure": "LINEAR_CENT",
"min_order_size": "0.05",
"position_limit_per_instrument": "25000",
"speedbump_ms": "100",
"status": "OPEN",
"list_time": 1795730000000,
"open_time": 1795750000000,
"close_time": 123,
"expected_open_time": 1795750000000,
"expected_close_time": 1795914000000,
"settlement_outcome": "<string>",
"settlement_value": "<string>",
"settlement_time": 123,
"open_interest": "1250.00",
"total_volume": "8400.00",
"additional_metadata": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"asBoolean": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asShort": 123,
"asJsonObject": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"asBoolean": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asShort": 123,
"empty": true,
"asJsonObject": "<unknown>",
"asJsonArray": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"empty": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asShort": 123,
"asBoolean": true,
"asJsonObject": "<unknown>",
"asJsonArray": "<unknown>",
"asJsonPrimitive": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"boolean": true,
"asBoolean": true,
"number": true,
"string": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asShort": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asJsonObject": "<unknown>",
"asJsonArray": "<unknown>",
"asJsonPrimitive": "<unknown>",
"asJsonNull": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"asBoolean": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asShort": 123,
"asJsonObject": "<unknown>",
"asJsonArray": "<unknown>",
"asJsonPrimitive": "<unknown>",
"asJsonNull": "<unknown>",
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
},
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
},
"asJsonNull": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"asBoolean": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asShort": 123,
"asJsonObject": "<unknown>",
"asJsonArray": "<unknown>",
"asJsonPrimitive": "<unknown>",
"asJsonNull": "<unknown>",
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
},
"": "<unknown>",
"asSingleElement": "<unknown>",
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
},
"asJsonPrimitive": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"boolean": true,
"asBoolean": true,
"number": true,
"string": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asShort": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asJsonObject": "<unknown>",
"asJsonArray": "<unknown>",
"asJsonPrimitive": "<unknown>",
"asJsonNull": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"asBoolean": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asShort": 123,
"asJsonObject": "<unknown>",
"asJsonArray": "<unknown>",
"asJsonPrimitive": "<unknown>",
"asJsonNull": "<unknown>",
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
},
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
},
"asJsonNull": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"asBoolean": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asShort": 123,
"asJsonObject": "<unknown>",
"asJsonArray": "<unknown>",
"asJsonPrimitive": "<unknown>",
"asJsonNull": "<unknown>",
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
},
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
},
"": "<unknown>"
},
"asJsonArray": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"empty": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asShort": 123,
"asBoolean": true,
"asJsonObject": "<unknown>",
"asJsonArray": "<unknown>",
"asJsonPrimitive": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"boolean": true,
"asBoolean": true,
"number": true,
"string": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asShort": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asJsonObject": "<unknown>",
"asJsonArray": "<unknown>",
"asJsonPrimitive": "<unknown>",
"asJsonNull": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"asBoolean": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asShort": 123,
"asJsonObject": "<unknown>",
"asJsonArray": "<unknown>",
"asJsonPrimitive": "<unknown>",
"asJsonNull": "<unknown>",
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
},
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
},
"asJsonNull": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"asBoolean": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asShort": 123,
"asJsonObject": "<unknown>",
"asJsonArray": "<unknown>",
"asJsonPrimitive": "<unknown>",
"asJsonNull": "<unknown>",
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
},
"": "<unknown>",
"asSingleElement": "<unknown>",
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
},
"asJsonPrimitive": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"boolean": true,
"asBoolean": true,
"number": true,
"string": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asShort": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asJsonObject": "<unknown>",
"asJsonArray": "<unknown>",
"asJsonPrimitive": "<unknown>",
"asJsonNull": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"asBoolean": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asShort": 123,
"asJsonObject": "<unknown>",
"asJsonArray": "<unknown>",
"asJsonPrimitive": "<unknown>",
"asJsonNull": "<unknown>",
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
},
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
},
"asJsonNull": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"asBoolean": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asShort": 123,
"asJsonObject": "<unknown>",
"asJsonArray": "<unknown>",
"asJsonPrimitive": "<unknown>",
"asJsonNull": "<unknown>",
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
},
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
}
}{
"error": {
"code": "INVALID_PARAMETER",
"message": "cursor is invalid or belongs to another resource type",
"field": "cursor"
}
}{
"error": {
"code": "INVALID_PARAMETER",
"message": "cursor is invalid or belongs to another resource type",
"field": "cursor"
}
}Reference
Get an instrument by id or ticker
Returns one instrument. Requires MARKET_DATA permission.
GET
/
api
/
v1
/
instruments
/
{id_or_ticker}
Get an instrument by id or ticker
curl --request GET \
--url https://api.example.com/api/v1/instruments/{id_or_ticker}import requests
url = "https://api.example.com/api/v1/instruments/{id_or_ticker}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v1/instruments/{id_or_ticker}', 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.example.com/api/v1/instruments/{id_or_ticker}",
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.example.com/api/v1/instruments/{id_or_ticker}"
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.example.com/api/v1/instruments/{id_or_ticker}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/instruments/{id_or_ticker}")
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{
"fractional_enabled": true,
"updated_time": 1795750000123,
"id": "598471892347",
"ticker": "NFL-GAMEWINNER-26NOV28LARSF-LAR",
"series_ticker": "NFL-GAMEWINNER",
"event_ticker": "26NOV28LARSF",
"group_ticker": "NFL-GAMEWINNER-26NOV28LARSF",
"title": "Rams win",
"proposition": "Los Angeles Rams win the game.",
"disclaimers": "Professional football players may not trade this instrument.",
"contract_size": "1.00",
"price_level_structure": "LINEAR_CENT",
"min_order_size": "0.05",
"position_limit_per_instrument": "25000",
"speedbump_ms": "100",
"status": "OPEN",
"list_time": 1795730000000,
"open_time": 1795750000000,
"close_time": 123,
"expected_open_time": 1795750000000,
"expected_close_time": 1795914000000,
"settlement_outcome": "<string>",
"settlement_value": "<string>",
"settlement_time": 123,
"open_interest": "1250.00",
"total_volume": "8400.00",
"additional_metadata": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"asBoolean": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asShort": 123,
"asJsonObject": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"asBoolean": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asShort": 123,
"empty": true,
"asJsonObject": "<unknown>",
"asJsonArray": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"empty": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asShort": 123,
"asBoolean": true,
"asJsonObject": "<unknown>",
"asJsonArray": "<unknown>",
"asJsonPrimitive": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"boolean": true,
"asBoolean": true,
"number": true,
"string": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asShort": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asJsonObject": "<unknown>",
"asJsonArray": "<unknown>",
"asJsonPrimitive": "<unknown>",
"asJsonNull": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"asBoolean": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asShort": 123,
"asJsonObject": "<unknown>",
"asJsonArray": "<unknown>",
"asJsonPrimitive": "<unknown>",
"asJsonNull": "<unknown>",
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
},
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
},
"asJsonNull": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"asBoolean": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asShort": 123,
"asJsonObject": "<unknown>",
"asJsonArray": "<unknown>",
"asJsonPrimitive": "<unknown>",
"asJsonNull": "<unknown>",
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
},
"": "<unknown>",
"asSingleElement": "<unknown>",
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
},
"asJsonPrimitive": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"boolean": true,
"asBoolean": true,
"number": true,
"string": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asShort": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asJsonObject": "<unknown>",
"asJsonArray": "<unknown>",
"asJsonPrimitive": "<unknown>",
"asJsonNull": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"asBoolean": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asShort": 123,
"asJsonObject": "<unknown>",
"asJsonArray": "<unknown>",
"asJsonPrimitive": "<unknown>",
"asJsonNull": "<unknown>",
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
},
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
},
"asJsonNull": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"asBoolean": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asShort": 123,
"asJsonObject": "<unknown>",
"asJsonArray": "<unknown>",
"asJsonPrimitive": "<unknown>",
"asJsonNull": "<unknown>",
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
},
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
},
"": "<unknown>"
},
"asJsonArray": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"empty": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asShort": 123,
"asBoolean": true,
"asJsonObject": "<unknown>",
"asJsonArray": "<unknown>",
"asJsonPrimitive": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"boolean": true,
"asBoolean": true,
"number": true,
"string": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asShort": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asJsonObject": "<unknown>",
"asJsonArray": "<unknown>",
"asJsonPrimitive": "<unknown>",
"asJsonNull": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"asBoolean": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asShort": 123,
"asJsonObject": "<unknown>",
"asJsonArray": "<unknown>",
"asJsonPrimitive": "<unknown>",
"asJsonNull": "<unknown>",
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
},
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
},
"asJsonNull": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"asBoolean": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asShort": 123,
"asJsonObject": "<unknown>",
"asJsonArray": "<unknown>",
"asJsonPrimitive": "<unknown>",
"asJsonNull": "<unknown>",
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
},
"": "<unknown>",
"asSingleElement": "<unknown>",
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
},
"asJsonPrimitive": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"boolean": true,
"asBoolean": true,
"number": true,
"string": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asShort": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asJsonObject": "<unknown>",
"asJsonArray": "<unknown>",
"asJsonPrimitive": "<unknown>",
"asJsonNull": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"asBoolean": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asShort": 123,
"asJsonObject": "<unknown>",
"asJsonArray": "<unknown>",
"asJsonPrimitive": "<unknown>",
"asJsonNull": "<unknown>",
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
},
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
},
"asJsonNull": {
"jsonArray": true,
"jsonObject": true,
"jsonPrimitive": true,
"jsonNull": true,
"asBoolean": true,
"asDouble": 123,
"asFloat": 123,
"asLong": 123,
"asInt": 123,
"asByte": 123,
"asCharacter": "<string>",
"asShort": 123,
"asJsonObject": "<unknown>",
"asJsonArray": "<unknown>",
"asJsonPrimitive": "<unknown>",
"asJsonNull": "<unknown>",
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
},
"asNumber": {},
"asString": "<string>",
"asBigDecimal": "<string>",
"asBigInteger": {
"lowestSetBit": 123,
"probablePrime": true,
"int": 123,
"toomSlice": "<unknown>",
"lower": "<unknown>",
"upper": "<unknown>"
}
}
}{
"error": {
"code": "INVALID_PARAMETER",
"message": "cursor is invalid or belongs to another resource type",
"field": "cursor"
}
}{
"error": {
"code": "INVALID_PARAMETER",
"message": "cursor is invalid or belongs to another resource type",
"field": "cursor"
}
}Path Parameters
Instrument ID or exact ticker. An all-digit value is read as an ID; anything else as a ticker.
Response
Instrument. Deleted instruments stay readable with their last status.
Whether fractional contract quantities are enabled.
Example:
true
Time of the instrument's latest change, in Unix epoch milliseconds. The updated_time filters compare this value.
Example:
1795750000123
Instrument id, as a canonical decimal string. Use this id to place orders.
Example:
"598471892347"
Unique instrument ticker. Treat it as an opaque identifier.
Example:
"NFL-GAMEWINNER-26NOV28LARSF-LAR"
Ticker of the series this instrument belongs to.
Example:
"NFL-GAMEWINNER"
Ticker of the event this instrument belongs to.
Example:
"26NOV28LARSF"
Ticker of the group of instruments that share this series and event.
Example:
"NFL-GAMEWINNER-26NOV28LARSF"
Human-readable display name.
Example:
"Rams win"
Plain-language criteria for the YES outcome.
Example:
"Los Angeles Rams win the game."
Compliance or eligibility disclaimer, or null when there is none.
Example:
"Professional football players may not trade this instrument."
USDC notional per contract, as a decimal string. Its numeric value is 1.
Example:
"1.00"
Tick-size schedule for order prices: LINEAR_CENT, DECI_CENT, or TAPERED_DECI_CENT.
Example:
"LINEAR_CENT"
Minimum order quantity in contracts, as a decimal string.
Example:
"0.05"
Maximum position in contracts that a firm may hold in this instrument, as a decimal string.
Example:
"25000"
Speed-bump delay applied to aggressive orders, in milliseconds, as a decimal string. Null or 0 means no speed bump.
Example:
"100"
Lifecycle status: LISTED, OPEN, PAUSE, CLOSED, DETERMINED, SETTLED, AMENDED, or DELISTED. Orders are accepted only while OPEN.
Example:
"OPEN"
Time of the first transition to LISTED, in Unix epoch milliseconds. Null until listed.
Example:
1795730000000
Time of the first transition to OPEN, in Unix epoch milliseconds. Null until opened.
Example:
1795750000000
Time of the most recent transition to CLOSED, in Unix epoch milliseconds. Null until closed.
Estimated open time for display, in Unix epoch milliseconds, or null. Non-binding: trading opens only when status becomes OPEN.
Example:
1795750000000
Estimated close time for display, in Unix epoch milliseconds, or null. Non-binding: trading closes only when status becomes CLOSED.
Example:
1795914000000
Determined outcome: YES, NO, or SCALAR. Null before the instrument is determined.
Payout per contract in USDC, from 0 through 1, as a decimal string. Null before the instrument is determined.
Time of the transition to SETTLED, in Unix epoch milliseconds. Null until settled.
Current open interest in contracts, as a decimal string. Null when the instrument has never traded.
Example:
"1250.00"
Total traded volume in contracts, as a decimal string. Null when the instrument has never traded.
Example:
"8400.00"
Market-specific instrument metadata as a JSON object. The fields vary by market.
Show child attributes
Show child attributes
Was this page helpful?