Discover authorized datasets and usage
curl --request GET \
--url https://api.tradingoctant.com/v1/discover \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.tradingoctant.com/v1/discover"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.tradingoctant.com/v1/discover', 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.tradingoctant.com/v1/discover",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.tradingoctant.com/v1/discover"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.tradingoctant.com/v1/discover")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tradingoctant.com/v1/discover")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"symbols": [
"<string>"
],
"capabilities": [
"<string>"
],
"quotas": {
"perMinute": 500000,
"perDay": 500000000,
"perMonth": 5000000000
},
"usage": {
"minute": 1,
"day": 1,
"month": 1
},
"datasets": [
{
"capability": "gex.snapshot",
"scope": {
"symbols": [
"<string>"
],
"bases": [
"naive"
],
"replay": false
},
"available": true
}
],
"quotaUnlimited": true
}{
"detail": {
"code": "<string>",
"message": "<string>"
}
}{
"detail": {
"code": "<string>",
"message": "<string>"
}
}{
"detail": {
"code": "<string>",
"message": "<string>"
}
}{
"detail": {
"code": "<string>",
"message": "<string>"
}
}{
"detail": {
"code": "<string>",
"message": "<string>"
}
}Customer REST API
Discover scope and usage
Discover authorized datasets and usage
curl --request GET \
--url https://api.tradingoctant.com/v1/discover \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.tradingoctant.com/v1/discover"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.tradingoctant.com/v1/discover', 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.tradingoctant.com/v1/discover",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.tradingoctant.com/v1/discover"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.tradingoctant.com/v1/discover")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tradingoctant.com/v1/discover")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"symbols": [
"<string>"
],
"capabilities": [
"<string>"
],
"quotas": {
"perMinute": 500000,
"perDay": 500000000,
"perMonth": 5000000000
},
"usage": {
"minute": 1,
"day": 1,
"month": 1
},
"datasets": [
{
"capability": "gex.snapshot",
"scope": {
"symbols": [
"<string>"
],
"bases": [
"naive"
],
"replay": false
},
"available": true
}
],
"quotaUnlimited": true
}{
"detail": {
"code": "<string>",
"message": "<string>"
}
}{
"detail": {
"code": "<string>",
"message": "<string>"
}
}{
"detail": {
"code": "<string>",
"message": "<string>"
}
}{
"detail": {
"code": "<string>",
"message": "<string>"
}
}{
"detail": {
"code": "<string>",
"message": "<string>"
}
}Send the request without query parameters. Inspect
datasets[].scope.symbols, bases and available to see what you can request. Compare minute, day and month counts in usage with the corresponding limits in quotas.
Errors For 401 check or replace the key. For 403 check scope. For 422 check parameters. For 429 honor Retry-After and check usage. Retry later on 503.Authorizations
Response
Successful response