Skip to content
StatAlphaDocumentation

ODC API

Response and request schema references are described in API schemas.

Odc Stats

Name In Required Type / constraints Description
symbol query Yes {"type": "string"}
start_date query No {"anyOf": [{"type": "string"}, {"type": "null"}]} Start date (YYYY-MM-DD)
end_date query No {"anyOf": [{"type": "string"}, {"type": "null"}]} End date (YYYY-MM-DD)
start_time query No {"anyOf": [{"type": "string"}, {"type": "null"}]} Daily UTC start time (HH:MM). If omitted, session-aware defaults are used.
end_time query No {"anyOf": [{"type": "string"}, {"type": "null"}]} Daily UTC end time (HH:MM). If omitted, session-aware defaults are used.
time_window query No {"anyOf": [{"type": "string"}, {"type": "null"}], "default": "12M"} Predefined time window (e.g., ‘1M’, ‘3M’, ‘6M’, ‘12M’, ‘24M’, ‘5Y’)
interval_minutes query No {"type": "array", "items": {"type": "integer"}, "default": [5, 10, 15, 30, 60]} Minutes after open to evaluate
include_extended_hours query No {"type": "boolean", "default": false} If True, include pre- and after-market data in breakout detection
{
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}

Odc Doc

Returns documentation for the fields in the ODC analysis output.

{
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}

Odc Errors

Name In Required Type / constraints Description
symbol query Yes {"type": "string"}
start_date query No {"anyOf": [{"type": "string"}, {"type": "null"}]} Start date (YYYY-MM-DD)
end_date query No {"anyOf": [{"type": "string"}, {"type": "null"}]} End date (YYYY-MM-DD)
start_time query No {"anyOf": [{"type": "string"}, {"type": "null"}]} Daily UTC start time (HH:MM). If omitted, session-aware defaults are used.
end_time query No {"anyOf": [{"type": "string"}, {"type": "null"}]} Daily UTC end time (HH:MM). If omitted, session-aware defaults are used.
time_window query No {"anyOf": [{"type": "string"}, {"type": "null"}], "default": "12M"} Predefined time window (e.g., ‘1M’, ‘3M’, ‘6M’, ‘12M’, ‘24M’, ‘5Y’)
interval_minutes query No {"type": "array", "items": {"type": "integer"}, "default": [5, 10, 15, 30, 60]}
include_extended_hours query No {"type": "boolean", "default": false}
{
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}

Odc Flop

Name In Required Type / constraints Description
symbol query Yes {"type": "string"}
start_date query No {"anyOf": [{"type": "string"}, {"type": "null"}]} Start date (YYYY-MM-DD)
end_date query No {"anyOf": [{"type": "string"}, {"type": "null"}]} End date (YYYY-MM-DD)
start_time query No {"anyOf": [{"type": "string"}, {"type": "null"}]} Daily UTC start time (HH:MM). If omitted, session-aware defaults are used.
end_time query No {"anyOf": [{"type": "string"}, {"type": "null"}]} Daily UTC end time (HH:MM). If omitted, session-aware defaults are used.
time_window query No {"anyOf": [{"type": "string"}, {"type": "null"}], "default": "12M"} Predefined time window (e.g., ‘1M’, ‘3M’, ‘6M’, ‘12M’, ‘24M’, ‘5Y’)
interval_minutes query No {"type": "array", "items": {"type": "integer"}, "default": [5, 10, 15, 30, 60]}
limit query No {"type": "integer", "default": 3}
sort query No {"type": "string", "default": "green_follow_rate_pct"}
include_extended_hours query No {"type": "boolean", "default": false}
{
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}

Odc Momentum

Name In Required Type / constraints Description
symbol query Yes {"type": "string"}
start_date query No {"anyOf": [{"type": "string"}, {"type": "null"}]} Start date (YYYY-MM-DD)
end_date query No {"anyOf": [{"type": "string"}, {"type": "null"}]} End date (YYYY-MM-DD)
start_time query No {"anyOf": [{"type": "string"}, {"type": "null"}]} Daily UTC start time (HH:MM). If omitted, session-aware defaults are used.
end_time query No {"anyOf": [{"type": "string"}, {"type": "null"}]} Daily UTC end time (HH:MM). If omitted, session-aware defaults are used.
time_window query No {"anyOf": [{"type": "string"}, {"type": "null"}], "default": "12M"} Predefined time window (e.g., ‘1M’, ‘3M’, ‘6M’, ‘12M’, ‘24M’, ‘5Y’)
interval_minutes query No {"type": "array", "items": {"type": "integer"}, "default": [5, 10, 15, 30, 60]}
include_extended_hours query No {"type": "boolean", "default": false}
{
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}

Odc Summary

Name In Required Type / constraints Description
symbol query Yes {"type": "string"}
start_date query No {"anyOf": [{"type": "string"}, {"type": "null"}]} Start date (YYYY-MM-DD)
end_date query No {"anyOf": [{"type": "string"}, {"type": "null"}]} End date (YYYY-MM-DD)
start_time query No {"anyOf": [{"type": "string"}, {"type": "null"}]} Daily UTC start time (HH:MM). If omitted, session-aware defaults are used.
end_time query No {"anyOf": [{"type": "string"}, {"type": "null"}]} Daily UTC end time (HH:MM). If omitted, session-aware defaults are used.
time_window query No {"anyOf": [{"type": "string"}, {"type": "null"}], "default": "12M"} Predefined time window (e.g., ‘1M’, ‘3M’, ‘6M’, ‘12M’, ‘24M’, ‘5Y’)
interval_minutes query No {"type": "array", "items": {"type": "integer"}, "default": [5, 10, 15, 30, 60]}
include_extended_hours query No {"type": "boolean", "default": false}
{
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}

Odc Top

Name In Required Type / constraints Description
symbol query Yes {"type": "string"}
start_date query No {"anyOf": [{"type": "string"}, {"type": "null"}]} Start date (YYYY-MM-DD)
end_date query No {"anyOf": [{"type": "string"}, {"type": "null"}]} End date (YYYY-MM-DD)
start_time query No {"anyOf": [{"type": "string"}, {"type": "null"}]} Daily UTC start time (HH:MM). If omitted, session-aware defaults are used.
end_time query No {"anyOf": [{"type": "string"}, {"type": "null"}]} Daily UTC end time (HH:MM). If omitted, session-aware defaults are used.
time_window query No {"anyOf": [{"type": "string"}, {"type": "null"}], "default": "12M"} Predefined time window (e.g., ‘1M’, ‘3M’, ‘6M’, ‘12M’, ‘24M’, ‘5Y’)
interval_minutes query No {"type": "array", "items": {"type": "integer"}, "default": [5, 10, 15, 30, 60]}
limit query No {"type": "integer", "default": 3}
sort query No {"type": "string", "default": "green_follow_rate_pct"}
include_extended_hours query No {"type": "boolean", "default": false}
{
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}