/openfigi/instruments/search
curl --request POST \
--url https://api.anysite.io/api/openfigi/instruments/search \
--header 'Content-Type: application/json' \
--header 'access-token: <api-key>' \
--data '
{
"query": "<string>",
"count": 2,
"timeout": 300,
"exch_code": "<string>",
"mic_code": "<string>",
"currency": "<string>",
"security_type": "<string>",
"security_type2": "<string>",
"include_unlisted_equities": true,
"state_code": "<string>",
"strike_min": 123,
"strike_max": 123,
"contract_size_min": 123,
"contract_size_max": 123,
"coupon_min": 123,
"coupon_max": 123,
"maturity_start": "<string>",
"maturity_end": "<string>",
"expiration_start": "<string>",
"expiration_end": "<string>"
}
'import requests
url = "https://api.anysite.io/api/openfigi/instruments/search"
payload = {
"query": "<string>",
"count": 2,
"timeout": 300,
"exch_code": "<string>",
"mic_code": "<string>",
"currency": "<string>",
"security_type": "<string>",
"security_type2": "<string>",
"include_unlisted_equities": True,
"state_code": "<string>",
"strike_min": 123,
"strike_max": 123,
"contract_size_min": 123,
"contract_size_max": 123,
"coupon_min": 123,
"coupon_max": 123,
"maturity_start": "<string>",
"maturity_end": "<string>",
"expiration_start": "<string>",
"expiration_end": "<string>"
}
headers = {
"access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: '<string>',
count: 2,
timeout: 300,
exch_code: '<string>',
mic_code: '<string>',
currency: '<string>',
security_type: '<string>',
security_type2: '<string>',
include_unlisted_equities: true,
state_code: '<string>',
strike_min: 123,
strike_max: 123,
contract_size_min: 123,
contract_size_max: 123,
coupon_min: 123,
coupon_max: 123,
maturity_start: '<string>',
maturity_end: '<string>',
expiration_start: '<string>',
expiration_end: '<string>'
})
};
fetch('https://api.anysite.io/api/openfigi/instruments/search', 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.anysite.io/api/openfigi/instruments/search",
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([
'query' => '<string>',
'count' => 2,
'timeout' => 300,
'exch_code' => '<string>',
'mic_code' => '<string>',
'currency' => '<string>',
'security_type' => '<string>',
'security_type2' => '<string>',
'include_unlisted_equities' => true,
'state_code' => '<string>',
'strike_min' => 123,
'strike_max' => 123,
'contract_size_min' => 123,
'contract_size_max' => 123,
'coupon_min' => 123,
'coupon_max' => 123,
'maturity_start' => '<string>',
'maturity_end' => '<string>',
'expiration_start' => '<string>',
'expiration_end' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"access-token: <api-key>"
],
]);
$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.anysite.io/api/openfigi/instruments/search"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"count\": 2,\n \"timeout\": 300,\n \"exch_code\": \"<string>\",\n \"mic_code\": \"<string>\",\n \"currency\": \"<string>\",\n \"security_type\": \"<string>\",\n \"security_type2\": \"<string>\",\n \"include_unlisted_equities\": true,\n \"state_code\": \"<string>\",\n \"strike_min\": 123,\n \"strike_max\": 123,\n \"contract_size_min\": 123,\n \"contract_size_max\": 123,\n \"coupon_min\": 123,\n \"coupon_max\": 123,\n \"maturity_start\": \"<string>\",\n \"maturity_end\": \"<string>\",\n \"expiration_start\": \"<string>\",\n \"expiration_end\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("access-token", "<api-key>")
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.anysite.io/api/openfigi/instruments/search")
.header("access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"count\": 2,\n \"timeout\": 300,\n \"exch_code\": \"<string>\",\n \"mic_code\": \"<string>\",\n \"currency\": \"<string>\",\n \"security_type\": \"<string>\",\n \"security_type2\": \"<string>\",\n \"include_unlisted_equities\": true,\n \"state_code\": \"<string>\",\n \"strike_min\": 123,\n \"strike_max\": 123,\n \"contract_size_min\": 123,\n \"contract_size_max\": 123,\n \"coupon_min\": 123,\n \"coupon_max\": 123,\n \"maturity_start\": \"<string>\",\n \"maturity_end\": \"<string>\",\n \"expiration_start\": \"<string>\",\n \"expiration_end\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.anysite.io/api/openfigi/instruments/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"count\": 2,\n \"timeout\": 300,\n \"exch_code\": \"<string>\",\n \"mic_code\": \"<string>\",\n \"currency\": \"<string>\",\n \"security_type\": \"<string>\",\n \"security_type2\": \"<string>\",\n \"include_unlisted_equities\": true,\n \"state_code\": \"<string>\",\n \"strike_min\": 123,\n \"strike_max\": 123,\n \"contract_size_min\": 123,\n \"contract_size_max\": 123,\n \"coupon_min\": 123,\n \"coupon_max\": 123,\n \"maturity_start\": \"<string>\",\n \"maturity_end\": \"<string>\",\n \"expiration_start\": \"<string>\",\n \"expiration_end\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body[
{
"figi": "<string>",
"@type": "OpenfigiInstrument",
"name": "<string>",
"ticker": "<string>",
"exch_code": "<string>",
"composite_figi": "<string>",
"share_class_figi": "<string>",
"security_type": "<string>",
"security_type2": "<string>",
"market_sector": "<string>",
"security_description": "<string>"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}/openfigi
/openfigi/instruments/search
Search OpenFIGI instruments by free text and facet filters
Price: 1 credit per 100 results
POST
/
api
/
openfigi
/
instruments
/
search
/openfigi/instruments/search
curl --request POST \
--url https://api.anysite.io/api/openfigi/instruments/search \
--header 'Content-Type: application/json' \
--header 'access-token: <api-key>' \
--data '
{
"query": "<string>",
"count": 2,
"timeout": 300,
"exch_code": "<string>",
"mic_code": "<string>",
"currency": "<string>",
"security_type": "<string>",
"security_type2": "<string>",
"include_unlisted_equities": true,
"state_code": "<string>",
"strike_min": 123,
"strike_max": 123,
"contract_size_min": 123,
"contract_size_max": 123,
"coupon_min": 123,
"coupon_max": 123,
"maturity_start": "<string>",
"maturity_end": "<string>",
"expiration_start": "<string>",
"expiration_end": "<string>"
}
'import requests
url = "https://api.anysite.io/api/openfigi/instruments/search"
payload = {
"query": "<string>",
"count": 2,
"timeout": 300,
"exch_code": "<string>",
"mic_code": "<string>",
"currency": "<string>",
"security_type": "<string>",
"security_type2": "<string>",
"include_unlisted_equities": True,
"state_code": "<string>",
"strike_min": 123,
"strike_max": 123,
"contract_size_min": 123,
"contract_size_max": 123,
"coupon_min": 123,
"coupon_max": 123,
"maturity_start": "<string>",
"maturity_end": "<string>",
"expiration_start": "<string>",
"expiration_end": "<string>"
}
headers = {
"access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: '<string>',
count: 2,
timeout: 300,
exch_code: '<string>',
mic_code: '<string>',
currency: '<string>',
security_type: '<string>',
security_type2: '<string>',
include_unlisted_equities: true,
state_code: '<string>',
strike_min: 123,
strike_max: 123,
contract_size_min: 123,
contract_size_max: 123,
coupon_min: 123,
coupon_max: 123,
maturity_start: '<string>',
maturity_end: '<string>',
expiration_start: '<string>',
expiration_end: '<string>'
})
};
fetch('https://api.anysite.io/api/openfigi/instruments/search', 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.anysite.io/api/openfigi/instruments/search",
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([
'query' => '<string>',
'count' => 2,
'timeout' => 300,
'exch_code' => '<string>',
'mic_code' => '<string>',
'currency' => '<string>',
'security_type' => '<string>',
'security_type2' => '<string>',
'include_unlisted_equities' => true,
'state_code' => '<string>',
'strike_min' => 123,
'strike_max' => 123,
'contract_size_min' => 123,
'contract_size_max' => 123,
'coupon_min' => 123,
'coupon_max' => 123,
'maturity_start' => '<string>',
'maturity_end' => '<string>',
'expiration_start' => '<string>',
'expiration_end' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"access-token: <api-key>"
],
]);
$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.anysite.io/api/openfigi/instruments/search"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"count\": 2,\n \"timeout\": 300,\n \"exch_code\": \"<string>\",\n \"mic_code\": \"<string>\",\n \"currency\": \"<string>\",\n \"security_type\": \"<string>\",\n \"security_type2\": \"<string>\",\n \"include_unlisted_equities\": true,\n \"state_code\": \"<string>\",\n \"strike_min\": 123,\n \"strike_max\": 123,\n \"contract_size_min\": 123,\n \"contract_size_max\": 123,\n \"coupon_min\": 123,\n \"coupon_max\": 123,\n \"maturity_start\": \"<string>\",\n \"maturity_end\": \"<string>\",\n \"expiration_start\": \"<string>\",\n \"expiration_end\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("access-token", "<api-key>")
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.anysite.io/api/openfigi/instruments/search")
.header("access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"count\": 2,\n \"timeout\": 300,\n \"exch_code\": \"<string>\",\n \"mic_code\": \"<string>\",\n \"currency\": \"<string>\",\n \"security_type\": \"<string>\",\n \"security_type2\": \"<string>\",\n \"include_unlisted_equities\": true,\n \"state_code\": \"<string>\",\n \"strike_min\": 123,\n \"strike_max\": 123,\n \"contract_size_min\": 123,\n \"contract_size_max\": 123,\n \"coupon_min\": 123,\n \"coupon_max\": 123,\n \"maturity_start\": \"<string>\",\n \"maturity_end\": \"<string>\",\n \"expiration_start\": \"<string>\",\n \"expiration_end\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.anysite.io/api/openfigi/instruments/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"count\": 2,\n \"timeout\": 300,\n \"exch_code\": \"<string>\",\n \"mic_code\": \"<string>\",\n \"currency\": \"<string>\",\n \"security_type\": \"<string>\",\n \"security_type2\": \"<string>\",\n \"include_unlisted_equities\": true,\n \"state_code\": \"<string>\",\n \"strike_min\": 123,\n \"strike_max\": 123,\n \"contract_size_min\": 123,\n \"contract_size_max\": 123,\n \"coupon_min\": 123,\n \"coupon_max\": 123,\n \"maturity_start\": \"<string>\",\n \"maturity_end\": \"<string>\",\n \"expiration_start\": \"<string>\",\n \"expiration_end\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body[
{
"figi": "<string>",
"@type": "OpenfigiInstrument",
"name": "<string>",
"ticker": "<string>",
"exch_code": "<string>",
"composite_figi": "<string>",
"share_class_figi": "<string>",
"security_type": "<string>",
"security_type2": "<string>",
"market_sector": "<string>",
"security_description": "<string>"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
API token from the dashboard
Headers
Body
application/json
Minimum string length:
1Required range:
x >= 1Required range:
20 <= x <= 1500Available options:
Comdty, Corp, Curncy, Equity, Govt, Index, M-Mkt, Mtge, Muni, Pfd Available options:
Call, Put Response
Successful Response
⌘I