Skip to content
StatAlphaDocumentation

INTRADAY API

Response and request schema references are described in API schemas.

Intraday Doc

Returns documentation for the fields in the Intraday analysis output.

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

Intraday Seasonality

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’)
resolution_minutes query No {"type": "integer", "maximum": 240, "minimum": 1, "default": 15}
include_extended_hours query No {"type": "boolean", "default": false} Include pre/post-market data if True
{
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}

Intraday 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’)
resolution_minutes query No {"type": "integer", "maximum": 240, "minimum": 1, "default": 15}
sort_by query No {"type": "string", "default": "median_return_pct"} Sort field: ‘median_return_pct’ or ‘avg_return_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"
}
}
}
}
}

Intraday 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’)
resolution_minutes query No {"type": "integer", "maximum": 240, "minimum": 1, "default": 15}
sort_by query No {"type": "string", "default": "median_return_pct"} Sort field: ‘median_return_pct’ or ‘avg_return_pct’
direction query No {"type": "string", "default": "top"} Sort direction: ‘top’ or ‘bottom’
limit query No {"type": "integer", "maximum": 100, "minimum": 1, "default": 5}
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"
}
}
}
}
}