Classify Snapshot Route
curl --request POST \
--url https://api.example.com/api/internal/regime/v2/snapshots/classify \
--header 'Content-Type: application/json' \
--data '
{
"as_of": "2023-11-07T05:31:56Z",
"effective_for_session": "2023-12-25",
"logic_version": "<string>",
"feature_version": "<string>",
"asset_scope": {
"kind": "market_index",
"primary_asset": "SPY",
"universe": [
"<string>"
]
},
"variant": "corrected",
"vix_percentile": 50,
"realized_vol_percentile": 50,
"realized_vol_change_z": 123,
"range_percentile": 50,
"drawdown_pct": 123,
"tail_loss_z": 123,
"return_20d_z": 123,
"trend_persistence": 0.5,
"breadth_pct": 50,
"breadth_change_pct": 123,
"avg_correlation": 0,
"correlation_change_z": 123,
"intraday_trend_strength": 0.5,
"opening_drive_z": 123,
"failed_auction": true,
"noise_z": 123,
"source_refs": [
{
"source": "<string>",
"source_id": "<string>",
"artifact_id": "<string>",
"as_of": "2023-11-07T05:31:56Z",
"notes": "<string>"
}
]
}
'import requests
url = "https://api.example.com/api/internal/regime/v2/snapshots/classify"
payload = {
"as_of": "2023-11-07T05:31:56Z",
"effective_for_session": "2023-12-25",
"logic_version": "<string>",
"feature_version": "<string>",
"asset_scope": {
"kind": "market_index",
"primary_asset": "SPY",
"universe": ["<string>"]
},
"variant": "corrected",
"vix_percentile": 50,
"realized_vol_percentile": 50,
"realized_vol_change_z": 123,
"range_percentile": 50,
"drawdown_pct": 123,
"tail_loss_z": 123,
"return_20d_z": 123,
"trend_persistence": 0.5,
"breadth_pct": 50,
"breadth_change_pct": 123,
"avg_correlation": 0,
"correlation_change_z": 123,
"intraday_trend_strength": 0.5,
"opening_drive_z": 123,
"failed_auction": True,
"noise_z": 123,
"source_refs": [
{
"source": "<string>",
"source_id": "<string>",
"artifact_id": "<string>",
"as_of": "2023-11-07T05:31:56Z",
"notes": "<string>"
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
as_of: '2023-11-07T05:31:56Z',
effective_for_session: '2023-12-25',
logic_version: '<string>',
feature_version: '<string>',
asset_scope: {kind: 'market_index', primary_asset: 'SPY', universe: ['<string>']},
variant: 'corrected',
vix_percentile: 50,
realized_vol_percentile: 50,
realized_vol_change_z: 123,
range_percentile: 50,
drawdown_pct: 123,
tail_loss_z: 123,
return_20d_z: 123,
trend_persistence: 0.5,
breadth_pct: 50,
breadth_change_pct: 123,
avg_correlation: 0,
correlation_change_z: 123,
intraday_trend_strength: 0.5,
opening_drive_z: 123,
failed_auction: true,
noise_z: 123,
source_refs: [
{
source: '<string>',
source_id: '<string>',
artifact_id: '<string>',
as_of: '2023-11-07T05:31:56Z',
notes: '<string>'
}
]
})
};
fetch('https://api.example.com/api/internal/regime/v2/snapshots/classify', 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/internal/regime/v2/snapshots/classify",
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([
'as_of' => '2023-11-07T05:31:56Z',
'effective_for_session' => '2023-12-25',
'logic_version' => '<string>',
'feature_version' => '<string>',
'asset_scope' => [
'kind' => 'market_index',
'primary_asset' => 'SPY',
'universe' => [
'<string>'
]
],
'variant' => 'corrected',
'vix_percentile' => 50,
'realized_vol_percentile' => 50,
'realized_vol_change_z' => 123,
'range_percentile' => 50,
'drawdown_pct' => 123,
'tail_loss_z' => 123,
'return_20d_z' => 123,
'trend_persistence' => 0.5,
'breadth_pct' => 50,
'breadth_change_pct' => 123,
'avg_correlation' => 0,
'correlation_change_z' => 123,
'intraday_trend_strength' => 0.5,
'opening_drive_z' => 123,
'failed_auction' => true,
'noise_z' => 123,
'source_refs' => [
[
'source' => '<string>',
'source_id' => '<string>',
'artifact_id' => '<string>',
'as_of' => '2023-11-07T05:31:56Z',
'notes' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.example.com/api/internal/regime/v2/snapshots/classify"
payload := strings.NewReader("{\n \"as_of\": \"2023-11-07T05:31:56Z\",\n \"effective_for_session\": \"2023-12-25\",\n \"logic_version\": \"<string>\",\n \"feature_version\": \"<string>\",\n \"asset_scope\": {\n \"kind\": \"market_index\",\n \"primary_asset\": \"SPY\",\n \"universe\": [\n \"<string>\"\n ]\n },\n \"variant\": \"corrected\",\n \"vix_percentile\": 50,\n \"realized_vol_percentile\": 50,\n \"realized_vol_change_z\": 123,\n \"range_percentile\": 50,\n \"drawdown_pct\": 123,\n \"tail_loss_z\": 123,\n \"return_20d_z\": 123,\n \"trend_persistence\": 0.5,\n \"breadth_pct\": 50,\n \"breadth_change_pct\": 123,\n \"avg_correlation\": 0,\n \"correlation_change_z\": 123,\n \"intraday_trend_strength\": 0.5,\n \"opening_drive_z\": 123,\n \"failed_auction\": true,\n \"noise_z\": 123,\n \"source_refs\": [\n {\n \"source\": \"<string>\",\n \"source_id\": \"<string>\",\n \"artifact_id\": \"<string>\",\n \"as_of\": \"2023-11-07T05:31:56Z\",\n \"notes\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/api/internal/regime/v2/snapshots/classify")
.header("Content-Type", "application/json")
.body("{\n \"as_of\": \"2023-11-07T05:31:56Z\",\n \"effective_for_session\": \"2023-12-25\",\n \"logic_version\": \"<string>\",\n \"feature_version\": \"<string>\",\n \"asset_scope\": {\n \"kind\": \"market_index\",\n \"primary_asset\": \"SPY\",\n \"universe\": [\n \"<string>\"\n ]\n },\n \"variant\": \"corrected\",\n \"vix_percentile\": 50,\n \"realized_vol_percentile\": 50,\n \"realized_vol_change_z\": 123,\n \"range_percentile\": 50,\n \"drawdown_pct\": 123,\n \"tail_loss_z\": 123,\n \"return_20d_z\": 123,\n \"trend_persistence\": 0.5,\n \"breadth_pct\": 50,\n \"breadth_change_pct\": 123,\n \"avg_correlation\": 0,\n \"correlation_change_z\": 123,\n \"intraday_trend_strength\": 0.5,\n \"opening_drive_z\": 123,\n \"failed_auction\": true,\n \"noise_z\": 123,\n \"source_refs\": [\n {\n \"source\": \"<string>\",\n \"source_id\": \"<string>\",\n \"artifact_id\": \"<string>\",\n \"as_of\": \"2023-11-07T05:31:56Z\",\n \"notes\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/internal/regime/v2/snapshots/classify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"as_of\": \"2023-11-07T05:31:56Z\",\n \"effective_for_session\": \"2023-12-25\",\n \"logic_version\": \"<string>\",\n \"feature_version\": \"<string>\",\n \"asset_scope\": {\n \"kind\": \"market_index\",\n \"primary_asset\": \"SPY\",\n \"universe\": [\n \"<string>\"\n ]\n },\n \"variant\": \"corrected\",\n \"vix_percentile\": 50,\n \"realized_vol_percentile\": 50,\n \"realized_vol_change_z\": 123,\n \"range_percentile\": 50,\n \"drawdown_pct\": 123,\n \"tail_loss_z\": 123,\n \"return_20d_z\": 123,\n \"trend_persistence\": 0.5,\n \"breadth_pct\": 50,\n \"breadth_change_pct\": 123,\n \"avg_correlation\": 0,\n \"correlation_change_z\": 123,\n \"intraday_trend_strength\": 0.5,\n \"opening_drive_z\": 123,\n \"failed_auction\": true,\n \"noise_z\": 123,\n \"source_refs\": [\n {\n \"source\": \"<string>\",\n \"source_id\": \"<string>\",\n \"artifact_id\": \"<string>\",\n \"as_of\": \"2023-11-07T05:31:56Z\",\n \"notes\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"snapshot_id": "<string>",
"logic_version": "<string>",
"feature_version": "<string>",
"as_of": "2023-11-07T05:31:56Z",
"effective_for_session": "2023-12-25",
"asset_scope": {
"kind": "market_index",
"primary_asset": "SPY",
"universe": [
"<string>"
]
},
"horizon_profile": "macro",
"feature_binding": "prior_session",
"risk_state": "calm",
"volatility_change": "compressing",
"directional_pressure": "upside_extended",
"breadth_state": "broad",
"correlation_state": "diversified",
"intraday_structure": "range_bound",
"variant": "corrected",
"unavailable_inputs": [
"<string>"
],
"risk_classifier_version": "risk-v2.0",
"risk_inputs_complete": false,
"provenance": [
{
"source": "<string>",
"source_id": "<string>",
"artifact_id": "<string>",
"as_of": "2023-11-07T05:31:56Z",
"notes": "<string>"
}
],
"legacy_shadow_grid": {
"direction": "<string>",
"volatility": "<string>",
"grid_cell": "<string>",
"logic_version": "<string>",
"variant": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}regime-vnext-internal
Classify Snapshot Route
POST
/
api
/
internal
/
regime
/
v2
/
snapshots
/
classify
Classify Snapshot Route
curl --request POST \
--url https://api.example.com/api/internal/regime/v2/snapshots/classify \
--header 'Content-Type: application/json' \
--data '
{
"as_of": "2023-11-07T05:31:56Z",
"effective_for_session": "2023-12-25",
"logic_version": "<string>",
"feature_version": "<string>",
"asset_scope": {
"kind": "market_index",
"primary_asset": "SPY",
"universe": [
"<string>"
]
},
"variant": "corrected",
"vix_percentile": 50,
"realized_vol_percentile": 50,
"realized_vol_change_z": 123,
"range_percentile": 50,
"drawdown_pct": 123,
"tail_loss_z": 123,
"return_20d_z": 123,
"trend_persistence": 0.5,
"breadth_pct": 50,
"breadth_change_pct": 123,
"avg_correlation": 0,
"correlation_change_z": 123,
"intraday_trend_strength": 0.5,
"opening_drive_z": 123,
"failed_auction": true,
"noise_z": 123,
"source_refs": [
{
"source": "<string>",
"source_id": "<string>",
"artifact_id": "<string>",
"as_of": "2023-11-07T05:31:56Z",
"notes": "<string>"
}
]
}
'import requests
url = "https://api.example.com/api/internal/regime/v2/snapshots/classify"
payload = {
"as_of": "2023-11-07T05:31:56Z",
"effective_for_session": "2023-12-25",
"logic_version": "<string>",
"feature_version": "<string>",
"asset_scope": {
"kind": "market_index",
"primary_asset": "SPY",
"universe": ["<string>"]
},
"variant": "corrected",
"vix_percentile": 50,
"realized_vol_percentile": 50,
"realized_vol_change_z": 123,
"range_percentile": 50,
"drawdown_pct": 123,
"tail_loss_z": 123,
"return_20d_z": 123,
"trend_persistence": 0.5,
"breadth_pct": 50,
"breadth_change_pct": 123,
"avg_correlation": 0,
"correlation_change_z": 123,
"intraday_trend_strength": 0.5,
"opening_drive_z": 123,
"failed_auction": True,
"noise_z": 123,
"source_refs": [
{
"source": "<string>",
"source_id": "<string>",
"artifact_id": "<string>",
"as_of": "2023-11-07T05:31:56Z",
"notes": "<string>"
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
as_of: '2023-11-07T05:31:56Z',
effective_for_session: '2023-12-25',
logic_version: '<string>',
feature_version: '<string>',
asset_scope: {kind: 'market_index', primary_asset: 'SPY', universe: ['<string>']},
variant: 'corrected',
vix_percentile: 50,
realized_vol_percentile: 50,
realized_vol_change_z: 123,
range_percentile: 50,
drawdown_pct: 123,
tail_loss_z: 123,
return_20d_z: 123,
trend_persistence: 0.5,
breadth_pct: 50,
breadth_change_pct: 123,
avg_correlation: 0,
correlation_change_z: 123,
intraday_trend_strength: 0.5,
opening_drive_z: 123,
failed_auction: true,
noise_z: 123,
source_refs: [
{
source: '<string>',
source_id: '<string>',
artifact_id: '<string>',
as_of: '2023-11-07T05:31:56Z',
notes: '<string>'
}
]
})
};
fetch('https://api.example.com/api/internal/regime/v2/snapshots/classify', 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/internal/regime/v2/snapshots/classify",
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([
'as_of' => '2023-11-07T05:31:56Z',
'effective_for_session' => '2023-12-25',
'logic_version' => '<string>',
'feature_version' => '<string>',
'asset_scope' => [
'kind' => 'market_index',
'primary_asset' => 'SPY',
'universe' => [
'<string>'
]
],
'variant' => 'corrected',
'vix_percentile' => 50,
'realized_vol_percentile' => 50,
'realized_vol_change_z' => 123,
'range_percentile' => 50,
'drawdown_pct' => 123,
'tail_loss_z' => 123,
'return_20d_z' => 123,
'trend_persistence' => 0.5,
'breadth_pct' => 50,
'breadth_change_pct' => 123,
'avg_correlation' => 0,
'correlation_change_z' => 123,
'intraday_trend_strength' => 0.5,
'opening_drive_z' => 123,
'failed_auction' => true,
'noise_z' => 123,
'source_refs' => [
[
'source' => '<string>',
'source_id' => '<string>',
'artifact_id' => '<string>',
'as_of' => '2023-11-07T05:31:56Z',
'notes' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.example.com/api/internal/regime/v2/snapshots/classify"
payload := strings.NewReader("{\n \"as_of\": \"2023-11-07T05:31:56Z\",\n \"effective_for_session\": \"2023-12-25\",\n \"logic_version\": \"<string>\",\n \"feature_version\": \"<string>\",\n \"asset_scope\": {\n \"kind\": \"market_index\",\n \"primary_asset\": \"SPY\",\n \"universe\": [\n \"<string>\"\n ]\n },\n \"variant\": \"corrected\",\n \"vix_percentile\": 50,\n \"realized_vol_percentile\": 50,\n \"realized_vol_change_z\": 123,\n \"range_percentile\": 50,\n \"drawdown_pct\": 123,\n \"tail_loss_z\": 123,\n \"return_20d_z\": 123,\n \"trend_persistence\": 0.5,\n \"breadth_pct\": 50,\n \"breadth_change_pct\": 123,\n \"avg_correlation\": 0,\n \"correlation_change_z\": 123,\n \"intraday_trend_strength\": 0.5,\n \"opening_drive_z\": 123,\n \"failed_auction\": true,\n \"noise_z\": 123,\n \"source_refs\": [\n {\n \"source\": \"<string>\",\n \"source_id\": \"<string>\",\n \"artifact_id\": \"<string>\",\n \"as_of\": \"2023-11-07T05:31:56Z\",\n \"notes\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/api/internal/regime/v2/snapshots/classify")
.header("Content-Type", "application/json")
.body("{\n \"as_of\": \"2023-11-07T05:31:56Z\",\n \"effective_for_session\": \"2023-12-25\",\n \"logic_version\": \"<string>\",\n \"feature_version\": \"<string>\",\n \"asset_scope\": {\n \"kind\": \"market_index\",\n \"primary_asset\": \"SPY\",\n \"universe\": [\n \"<string>\"\n ]\n },\n \"variant\": \"corrected\",\n \"vix_percentile\": 50,\n \"realized_vol_percentile\": 50,\n \"realized_vol_change_z\": 123,\n \"range_percentile\": 50,\n \"drawdown_pct\": 123,\n \"tail_loss_z\": 123,\n \"return_20d_z\": 123,\n \"trend_persistence\": 0.5,\n \"breadth_pct\": 50,\n \"breadth_change_pct\": 123,\n \"avg_correlation\": 0,\n \"correlation_change_z\": 123,\n \"intraday_trend_strength\": 0.5,\n \"opening_drive_z\": 123,\n \"failed_auction\": true,\n \"noise_z\": 123,\n \"source_refs\": [\n {\n \"source\": \"<string>\",\n \"source_id\": \"<string>\",\n \"artifact_id\": \"<string>\",\n \"as_of\": \"2023-11-07T05:31:56Z\",\n \"notes\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/internal/regime/v2/snapshots/classify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"as_of\": \"2023-11-07T05:31:56Z\",\n \"effective_for_session\": \"2023-12-25\",\n \"logic_version\": \"<string>\",\n \"feature_version\": \"<string>\",\n \"asset_scope\": {\n \"kind\": \"market_index\",\n \"primary_asset\": \"SPY\",\n \"universe\": [\n \"<string>\"\n ]\n },\n \"variant\": \"corrected\",\n \"vix_percentile\": 50,\n \"realized_vol_percentile\": 50,\n \"realized_vol_change_z\": 123,\n \"range_percentile\": 50,\n \"drawdown_pct\": 123,\n \"tail_loss_z\": 123,\n \"return_20d_z\": 123,\n \"trend_persistence\": 0.5,\n \"breadth_pct\": 50,\n \"breadth_change_pct\": 123,\n \"avg_correlation\": 0,\n \"correlation_change_z\": 123,\n \"intraday_trend_strength\": 0.5,\n \"opening_drive_z\": 123,\n \"failed_auction\": true,\n \"noise_z\": 123,\n \"source_refs\": [\n {\n \"source\": \"<string>\",\n \"source_id\": \"<string>\",\n \"artifact_id\": \"<string>\",\n \"as_of\": \"2023-11-07T05:31:56Z\",\n \"notes\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"snapshot_id": "<string>",
"logic_version": "<string>",
"feature_version": "<string>",
"as_of": "2023-11-07T05:31:56Z",
"effective_for_session": "2023-12-25",
"asset_scope": {
"kind": "market_index",
"primary_asset": "SPY",
"universe": [
"<string>"
]
},
"horizon_profile": "macro",
"feature_binding": "prior_session",
"risk_state": "calm",
"volatility_change": "compressing",
"directional_pressure": "upside_extended",
"breadth_state": "broad",
"correlation_state": "diversified",
"intraday_structure": "range_bound",
"variant": "corrected",
"unavailable_inputs": [
"<string>"
],
"risk_classifier_version": "risk-v2.0",
"risk_inputs_complete": false,
"provenance": [
{
"source": "<string>",
"source_id": "<string>",
"artifact_id": "<string>",
"as_of": "2023-11-07T05:31:56Z",
"notes": "<string>"
}
],
"legacy_shadow_grid": {
"direction": "<string>",
"volatility": "<string>",
"grid_cell": "<string>",
"logic_version": "<string>",
"variant": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Body
application/json
Point-in-time features used by deterministic vNext classification.
Available options:
macro, swing, intraday Show child attributes
Show child attributes
Available options:
prior_session, prior_bar Required range:
0 <= x <= 100Required range:
0 <= x <= 100Required range:
0 <= x <= 100Required range:
0 <= x <= 1Required range:
0 <= x <= 100Required range:
-1 <= x <= 1Required range:
0 <= x <= 1Show child attributes
Show child attributes
Response
Successful Response
Show child attributes
Show child attributes
Available options:
macro, swing, intraday Available options:
prior_session, prior_bar Available options:
calm, normal, elevated, stress, unavailable Available options:
compressing, stable, expanding, unavailable Available options:
upside_extended, downside_extended, balanced, persistent_trend Available options:
broad, narrow, deteriorating, recovering, unavailable Available options:
diversified, correlated, turbulent, unavailable Available options:
range_bound, trend_day, opening_drive, failed_auction, high_noise, unavailable Show child attributes
Show child attributes
Legacy 2x3 grid retained for diagnostics, never direct vNext policy.
Show child attributes
Show child attributes