List instruments
curl --request GET \
--url https://api.example.com/api/v1/instrumentsimport requests
url = "https://api.example.com/api/v1/instruments"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v1/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.example.com/api/v1/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.example.com/api/v1/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.example.com/api/v1/instruments")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/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{
"data": [
{
"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>"
}
}
}
],
"cursor": "<string>"
}{
"error": {
"code": "INVALID_PARAMETER",
"message": "cursor is invalid or belongs to another resource type",
"field": "cursor"
}
}Reference
List instruments
Returns a page of instruments. Requires MARKET_DATA permission.
GET
/
api
/
v1
/
instruments
List instruments
curl --request GET \
--url https://api.example.com/api/v1/instrumentsimport requests
url = "https://api.example.com/api/v1/instruments"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v1/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.example.com/api/v1/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.example.com/api/v1/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.example.com/api/v1/instruments")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/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{
"data": [
{
"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>"
}
}
}
],
"cursor": "<string>"
}{
"error": {
"code": "INVALID_PARAMETER",
"message": "cursor is invalid or belongs to another resource type",
"field": "cursor"
}
}Query Parameters
Filter by instrument ID. Repeatable.
Case-insensitive substring of the ticker.
Case-insensitive substring of the title.
Case-insensitive substring of the event ticker.
Case-insensitive substring of the series ticker.
Case-insensitive substring of the group ticker.
Filter by lifecycle status. Repeatable. DRAFT returns 400. Deleted instruments are listed with their last status.
Filter by the linked Series category. Repeatable.
Only instruments whose updated_time is after this value, in Unix epoch milliseconds (exclusive).
Only instruments whose updated_time is before this value, in Unix epoch milliseconds (exclusive).
Only instruments whose list_time is after this value, in Unix epoch milliseconds (exclusive).
Only instruments whose list_time is before this value, in Unix epoch milliseconds (exclusive).
Only instruments whose open_time is after this value, in Unix epoch milliseconds (exclusive).
Only instruments whose open_time is before this value, in Unix epoch milliseconds (exclusive).
Only instruments whose close_time is after this value, in Unix epoch milliseconds (exclusive).
Only instruments whose close_time is before this value, in Unix epoch milliseconds (exclusive).
Only instruments whose settlement_time is after this value, in Unix epoch milliseconds (exclusive).
Only instruments whose settlement_time is before this value, in Unix epoch milliseconds (exclusive).
Sort field. Only updated_time is accepted. Without sort, results are ordered newest first by ID.
Sort direction: asc or desc. Default desc. Used only with sort=updated_time.
Page size. Default 100, maximum 1000.
Opaque cursor from the previous page's cursor field. Omit on the first request.
Was this page helpful?