> For the complete documentation index, see [llms.txt](https://statalpha.gitbook.io/statalpha-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://statalpha.gitbook.io/statalpha-docs/api-reference/seasonality.md). # SEASONALITY Seasonality patterns and cycles ## GET /stats/seasonality/weekday > Weekday Seasonality ```json {"openapi":"3.1.0","info":{"title":"StatAlpha API","version":"0.4.0"},"tags":[{"name":"SEASONALITY","description":"Seasonality patterns and cycles"}],"paths":{"/stats/seasonality/weekday":{"get":{"tags":["SEASONALITY"],"summary":"Weekday Seasonality","operationId":"weekday_seasonality_stats_seasonality_weekday_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"type":"string","title":"Symbol"}},{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start date (YYYY-MM-DD)","title":"Start Date"},"description":"Start date (YYYY-MM-DD)"},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End date (YYYY-MM-DD)","title":"End Date"},"description":"End date (YYYY-MM-DD)"},{"name":"time_window","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Predefined time window (e.g., '1M', '3M', '6M', '12M', '24M', '5Y')","default":"12M","title":"Time Window"},"description":"Predefined time window (e.g., '1M', '3M', '6M', '12M', '24M', '5Y')"},{"name":"include_extended_hours","in":"query","required":false,"schema":{"type":"boolean","description":"Include pre/post-market data if True","default":false,"title":"Include Extended Hours"},"description":"Include pre/post-market data if True"},{"name":"use_median","in":"query","required":false,"schema":{"type":"boolean","description":"If true, selects top/worst values using median_return_pct instead of avg_return_pct","default":true,"title":"Use Median"},"description":"If true, selects top/worst values using median_return_pct instead of avg_return_pct"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` ## GET /stats/seasonality/week > Week Seasonality ```json {"openapi":"3.1.0","info":{"title":"StatAlpha API","version":"0.4.0"},"tags":[{"name":"SEASONALITY","description":"Seasonality patterns and cycles"}],"paths":{"/stats/seasonality/week":{"get":{"tags":["SEASONALITY"],"summary":"Week Seasonality","operationId":"week_seasonality_stats_seasonality_week_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"type":"string","title":"Symbol"}},{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start date (YYYY-MM-DD)","title":"Start Date"},"description":"Start date (YYYY-MM-DD)"},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End date (YYYY-MM-DD)","title":"End Date"},"description":"End date (YYYY-MM-DD)"},{"name":"time_window","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Predefined time window (e.g., '1M', '3M', '6M', '12M', '24M', '5Y')","default":"12M","title":"Time Window"},"description":"Predefined time window (e.g., '1M', '3M', '6M', '12M', '24M', '5Y')"},{"name":"include_extended_hours","in":"query","required":false,"schema":{"type":"boolean","description":"Include pre/post-market data if True","default":false,"title":"Include Extended Hours"},"description":"Include pre/post-market data if True"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` ## GET /stats/seasonality/month > Month Seasonality ```json {"openapi":"3.1.0","info":{"title":"StatAlpha API","version":"0.4.0"},"tags":[{"name":"SEASONALITY","description":"Seasonality patterns and cycles"}],"paths":{"/stats/seasonality/month":{"get":{"tags":["SEASONALITY"],"summary":"Month Seasonality","operationId":"month_seasonality_stats_seasonality_month_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"type":"string","title":"Symbol"}},{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start date (YYYY-MM-DD)","title":"Start Date"},"description":"Start date (YYYY-MM-DD)"},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End date (YYYY-MM-DD)","title":"End Date"},"description":"End date (YYYY-MM-DD)"},{"name":"time_window","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Predefined time window (e.g., '1M', '3M', '6M', '12M', '24M', '5Y')","default":"12M","title":"Time Window"},"description":"Predefined time window (e.g., '1M', '3M', '6M', '12M', '24M', '5Y')"},{"name":"include_extended_hours","in":"query","required":false,"schema":{"type":"boolean","description":"Include pre/post-market data if True","default":false,"title":"Include Extended Hours"},"description":"Include pre/post-market data if True"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` ## GET /stats/seasonality/top > Top Seasonality Patterns ```json {"openapi":"3.1.0","info":{"title":"StatAlpha API","version":"0.4.0"},"tags":[{"name":"SEASONALITY","description":"Seasonality patterns and cycles"}],"paths":{"/stats/seasonality/top":{"get":{"tags":["SEASONALITY"],"summary":"Top Seasonality Patterns","operationId":"top_seasonality_patterns_stats_seasonality_top_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"type":"string","title":"Symbol"}},{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start date (YYYY-MM-DD)","title":"Start Date"},"description":"Start date (YYYY-MM-DD)"},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End date (YYYY-MM-DD)","title":"End Date"},"description":"End date (YYYY-MM-DD)"},{"name":"time_window","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Predefined time window (e.g., '1M', '3M', '6M', '12M', '24M', '5Y')","default":"12M","title":"Time Window"},"description":"Predefined time window (e.g., '1M', '3M', '6M', '12M', '24M', '5Y')"},{"name":"type","in":"query","required":true,"schema":{"type":"string","description":"One of: weekday, week, month","title":"Type"},"description":"One of: weekday, week, month"},{"name":"direction","in":"query","required":false,"schema":{"type":"string","description":"Sort direction: top or bottom","default":"top","title":"Direction"},"description":"Sort direction: top or bottom"},{"name":"sort_by","in":"query","required":false,"schema":{"type":"string","description":"Sort by column: median_return_pct, avg_return_pct, green_days_pct or green_weeks_pct or green_months_pct","default":"median_return_pct","title":"Sort By"},"description":"Sort by column: median_return_pct, avg_return_pct, green_days_pct or green_weeks_pct or green_months_pct"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"Number of top entries to return","default":5,"title":"Limit"},"description":"Number of top entries to return"},{"name":"include_extended_hours","in":"query","required":false,"schema":{"type":"boolean","description":"Include pre/post-market data if True","default":false,"title":"Include Extended Hours"},"description":"Include pre/post-market data if True"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` ## GET /stats/seasonality/summary > Seasonality Summary ```json {"openapi":"3.1.0","info":{"title":"StatAlpha API","version":"0.4.0"},"tags":[{"name":"SEASONALITY","description":"Seasonality patterns and cycles"}],"paths":{"/stats/seasonality/summary":{"get":{"tags":["SEASONALITY"],"summary":"Seasonality Summary","operationId":"seasonality_summary_stats_seasonality_summary_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"type":"string","title":"Symbol"}},{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start date (YYYY-MM-DD)","title":"Start Date"},"description":"Start date (YYYY-MM-DD)"},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End date (YYYY-MM-DD)","title":"End Date"},"description":"End date (YYYY-MM-DD)"},{"name":"time_window","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Predefined time window (e.g., '1M', '3M', '6M', '12M', '24M', '5Y')","default":"12M","title":"Time Window"},"description":"Predefined time window (e.g., '1M', '3M', '6M', '12M', '24M', '5Y')"},{"name":"include_extended_hours","in":"query","required":false,"schema":{"type":"boolean","description":"Include pre/post-market data if True","default":false,"title":"Include Extended Hours"},"description":"Include pre/post-market data if True"},{"name":"use_median","in":"query","required":false,"schema":{"type":"boolean","description":"If true, selects top/worst values using median_return_pct instead of avg_return_pct","default":true,"title":"Use Median"},"description":"If true, selects top/worst values using median_return_pct instead of avg_return_pct"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` ## Seasonality Doc > Returns documentation for the fields in the Seasonality analysis output. ```json {"openapi":"3.1.0","info":{"title":"StatAlpha API","version":"0.4.0"},"tags":[{"name":"SEASONALITY","description":"Seasonality patterns and cycles"}],"paths":{"/stats/seasonality/doc":{"get":{"tags":["SEASONALITY"],"summary":"Seasonality Doc","description":"Returns documentation for the fields in the Seasonality analysis output.","operationId":"seasonality_doc_stats_seasonality_doc_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://statalpha.gitbook.io/statalpha-docs/api-reference/seasonality.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.