> 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/orb.md).

# ORB

Opening Range Breakout statistics

## Orb Doc

> Returns documentation for the fields in the ORB analysis output.

```json
{"openapi":"3.1.0","info":{"title":"StatAlpha API","version":"0.4.0"},"tags":[{"name":"ORB","description":"Opening Range Breakout statistics"}],"paths":{"/stats/orb/doc":{"get":{"tags":["ORB"],"summary":"Orb Doc","description":"Returns documentation for the fields in the ORB analysis output.","operationId":"orb_doc_stats_orb_doc_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}}}}
```

## GET /stats/orb

> Get Opening Range Breakout

```json
{"openapi":"3.1.0","info":{"title":"StatAlpha API","version":"0.4.0"},"tags":[{"name":"ORB","description":"Opening Range Breakout statistics"}],"paths":{"/stats/orb":{"get":{"tags":["ORB"],"summary":"Get Opening Range Breakout","operationId":"get_opening_range_breakout_stats_orb_get","parameters":[{"name":"symbol","in":"query","required":true,"schema":{"type":"string","title":"Symbol"}},{"name":"date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trading date (YYYY-MM-DD) to analyse","title":"Date"},"description":"Trading date (YYYY-MM-DD) to analyse"},{"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":"start_time","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Daily UTC start time (e.g., '13:30')","default":"13:30","title":"Start Time"},"description":"Daily UTC start time (e.g., '13:30')"},{"name":"end_time","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Daily UTC end time (e.g., '20:00')","default":"20:00","title":"End Time"},"description":"Daily UTC end time (e.g., '20:00')"},{"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":"orb_minutes","in":"query","required":false,"schema":{"type":"integer","description":"Length of opening range in minutes (e.g., 1, 2, 5, 15)","default":5,"title":"Orb Minutes"},"description":"Length of opening range in minutes (e.g., 1, 2, 5, 15)"},{"name":"include_extended_hours","in":"query","required":false,"schema":{"type":"boolean","description":"If True, include pre- and after-market data in breakout detection","default":false,"title":"Include Extended Hours"},"description":"If True, include pre- and after-market data in breakout detection"},{"name":"orb_reentry_candles","in":"query","required":false,"schema":{"type":"integer","description":"Number of consecutive candles required to confirm reentry into the ORB zone after breakout","default":2,"title":"Orb Reentry Candles"},"description":"Number of consecutive candles required to confirm reentry into the ORB zone after breakout"}],"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/orb/summary

> Get Opening Range Summary

```json
{"openapi":"3.1.0","info":{"title":"StatAlpha API","version":"0.4.0"},"tags":[{"name":"ORB","description":"Opening Range Breakout statistics"}],"paths":{"/stats/orb/summary":{"get":{"tags":["ORB"],"summary":"Get Opening Range Summary","operationId":"get_opening_range_summary_stats_orb_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":"start_time","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Daily UTC start time (e.g., '13:30')","default":"13:30","title":"Start Time"},"description":"Daily UTC start time (e.g., '13:30')"},{"name":"end_time","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Daily UTC end time (e.g., '20:00')","default":"20:00","title":"End Time"},"description":"Daily UTC end time (e.g., '20:00')"},{"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":"orb_minutes","in":"query","required":false,"schema":{"type":"integer","description":"Length of opening range in minutes (e.g., 1, 2, 5, 15)","default":5,"title":"Orb Minutes"},"description":"Length of opening range in minutes (e.g., 1, 2, 5, 15)"},{"name":"include_extended_hours","in":"query","required":false,"schema":{"type":"boolean","description":"If True, include pre- and after-market data in breakout detection","default":false,"title":"Include Extended Hours"},"description":"If True, include pre- and after-market data in breakout detection"},{"name":"orb_reentry_candles","in":"query","required":false,"schema":{"type":"integer","description":"Number of consecutive candles required to confirm reentry into the ORB zone after breakout","default":2,"title":"Orb Reentry Candles"},"description":"Number of consecutive candles required to confirm reentry into the ORB zone after breakout"}],"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/orb/top

> Get Orb Top

```json
{"openapi":"3.1.0","info":{"title":"StatAlpha API","version":"0.4.0"},"tags":[{"name":"ORB","description":"Opening Range Breakout statistics"}],"paths":{"/stats/orb/top":{"get":{"tags":["ORB"],"summary":"Get Orb Top","operationId":"get_orb_top_stats_orb_top_get","parameters":[{"name":"date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Trading date (YYYY-MM-DD) to analyse","title":"Date"},"description":"Trading date (YYYY-MM-DD) to analyse"},{"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":"start_time","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Daily UTC start time (e.g., '13:30')","default":"13:30","title":"Start Time"},"description":"Daily UTC start time (e.g., '13:30')"},{"name":"end_time","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Daily UTC end time (e.g., '20:00')","default":"20:00","title":"End Time"},"description":"Daily UTC end time (e.g., '20:00')"},{"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":"orb_minutes","in":"query","required":false,"schema":{"type":"integer","description":"Length of opening range in minutes (e.g., 1, 2, 5, 15)","default":5,"title":"Orb Minutes"},"description":"Length of opening range in minutes (e.g., 1, 2, 5, 15)"},{"name":"top_n","in":"query","required":false,"schema":{"type":"integer","description":"Number of top breakouts to return","default":10,"title":"Top N"},"description":"Number of top breakouts to return"},{"name":"include_extended_hours","in":"query","required":false,"schema":{"type":"boolean","description":"If True, include pre- and after-market data in breakout detection","default":false,"title":"Include Extended Hours"},"description":"If True, include pre- and after-market data in breakout detection"},{"name":"orb_reentry_candles","in":"query","required":false,"schema":{"type":"integer","description":"Number of consecutive candles required to confirm reentry into the ORB zone after breakout","default":2,"title":"Orb Reentry Candles"},"description":"Number of consecutive candles required to confirm reentry into the ORB zone after breakout"}],"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/orb/top-picks

> Get Orb Top Picks

```json
{"openapi":"3.1.0","info":{"title":"StatAlpha API","version":"0.4.0"},"tags":[{"name":"ORB","description":"Opening Range Breakout statistics"}],"paths":{"/stats/orb/top-picks":{"get":{"tags":["ORB"],"summary":"Get Orb Top Picks","operationId":"get_orb_top_picks_stats_orb_top_picks_get","parameters":[{"name":"date","in":"query","required":true,"schema":{"type":"string","description":"Date in YYYY-MM-DD format","title":"Date"},"description":"Date in YYYY-MM-DD format"},{"name":"orb_minutes","in":"query","required":false,"schema":{"type":"integer","description":"Length of opening range in minutes (e.g., 1, 2, 5, 15)","default":5,"title":"Orb Minutes"},"description":"Length of opening range in minutes (e.g., 1, 2, 5, 15)"},{"name":"min_breakout_size","in":"query","required":false,"schema":{"type":"number","description":"Minimum breakout size to consider","default":0.01,"title":"Min Breakout Size"},"description":"Minimum breakout size to consider"},{"name":"include_extended_hours","in":"query","required":false,"schema":{"type":"boolean","description":"If True, include pre- and after-market data in breakout detection","default":false,"title":"Include Extended Hours"},"description":"If True, include pre- and after-market data in breakout detection"},{"name":"orb_reentry_candles","in":"query","required":false,"schema":{"type":"integer","description":"Number of consecutive candles required to confirm reentry into the ORB zone after breakout","default":2,"title":"Orb Reentry Candles"},"description":"Number of consecutive candles required to confirm reentry into the ORB zone after breakout"}],"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"}}}}
```


---

# 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/orb.md?ask=<question>&goal=<endgoal>
```

`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.