Detailed scoring for a single trade
curl --request GET \
--url https://flow-api.skylit.ai/v1/score/{trade_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://flow-api.skylit.ai/v1/score/{trade_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://flow-api.skylit.ai/v1/score/{trade_id}', 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://flow-api.skylit.ai/v1/score/{trade_id}",
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://flow-api.skylit.ai/v1/score/{trade_id}"
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://flow-api.skylit.ai/v1/score/{trade_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://flow-api.skylit.ai/v1/score/{trade_id}")
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{
"data": {
"tradeId": "flow_188afe42c3a77af2_0",
"scores": {
"sentiment": 0,
"urgency": 50,
"confidence": 0.5
},
"interpretation": {
"direction": "bullish",
"intent": "<string>",
"description": "<string>"
},
"spreadAnalysis": {
"bid": 123,
"ask": 123,
"mid": 123,
"tradePrice": 123,
"positionInSpread": "above_ask",
"spreadWidth": 123,
"spreadPct": 123
},
"tradeContext": {
"ticker": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"optionType": "call",
"strike": 123,
"expiration": "2023-12-25",
"premium": 123,
"size": 2,
"underlyingPrice": 123,
"tradeType": "sweep",
"dte": 1,
"moneyness": "deep_itm",
"moneynessPct": 123
}
},
"meta": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "d7574836"
}
}Scoring
Detailed scoring for a single trade
Returns sentiment, urgency, and confidence scores for an individual
trade plus a spread-level breakdown and full trade context (ticker,
strike, expiration, sweep/block flags, moneyness). Used to drill
into a single row from /v1/flow/{ticker}.
The trade_id path parameter accepts three formats: the canonical
flow_{hex}_{idx} id returned by the flow feed, a bare hex
timestamp (188afe42c3a77af2), or a raw nanosecond integer.
GET
/
v1
/
score
/
{trade_id}
Detailed scoring for a single trade
curl --request GET \
--url https://flow-api.skylit.ai/v1/score/{trade_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://flow-api.skylit.ai/v1/score/{trade_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://flow-api.skylit.ai/v1/score/{trade_id}', 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://flow-api.skylit.ai/v1/score/{trade_id}",
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://flow-api.skylit.ai/v1/score/{trade_id}"
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://flow-api.skylit.ai/v1/score/{trade_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://flow-api.skylit.ai/v1/score/{trade_id}")
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{
"data": {
"tradeId": "flow_188afe42c3a77af2_0",
"scores": {
"sentiment": 0,
"urgency": 50,
"confidence": 0.5
},
"interpretation": {
"direction": "bullish",
"intent": "<string>",
"description": "<string>"
},
"spreadAnalysis": {
"bid": 123,
"ask": 123,
"mid": 123,
"tradePrice": 123,
"positionInSpread": "above_ask",
"spreadWidth": 123,
"spreadPct": 123
},
"tradeContext": {
"ticker": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"optionType": "call",
"strike": 123,
"expiration": "2023-12-25",
"premium": 123,
"size": 2,
"underlyingPrice": 123,
"tradeType": "sweep",
"dte": 1,
"moneyness": "deep_itm",
"moneynessPct": 123
}
},
"meta": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "d7574836"
}
}Authorizations
Skylit API key in the Authorization header
(Authorization: Bearer fs_live_<key>). X-API-Key is also accepted.
Path Parameters
Trade id (flow_{hex}_{idx}, bare hex timestamp, or raw nanos).
Example:
"flow_188afe42c3a77af2_0"
Was this page helpful?

