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

# GAP

Gap statistics and gap fills

## Get Gap Doc

> Endpoint to return documentation of the gap analysis raw output fields.

```json
{"openapi":"3.1.0","info":{"title":"StatAlpha API","version":"0.4.0"},"tags":[{"name":"GAP","description":"Gap statistics and gap fills"}],"paths":{"/stats/gap/doc":{"get":{"tags":["GAP"],"summary":"Get Gap Doc","description":"Endpoint to return documentation of the gap analysis raw output fields.","operationId":"get_gap_doc_stats_gap_doc_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}}}}
```

## GET /stats/gap

> Get Gap Data

```json
{"openapi":"3.1.0","info":{"title":"StatAlpha API","version":"0.4.0"},"tags":[{"name":"GAP","description":"Gap statistics and gap fills"}],"paths":{"/stats/gap":{"get":{"tags":["GAP"],"summary":"Get Gap Data","operationId":"get_gap_data_stats_gap_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":"fill_cutoff","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Time cutoff (UTC) for fill check, e.g., '16:30'","title":"Fill Cutoff"},"description":"Time cutoff (UTC) for fill check, e.g., '16:30'"},{"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')"}],"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/gap/summary

> Get Gap Summary

```json
{"openapi":"3.1.0","info":{"title":"StatAlpha API","version":"0.4.0"},"tags":[{"name":"GAP","description":"Gap statistics and gap fills"}],"paths":{"/stats/gap/summary":{"get":{"tags":["GAP"],"summary":"Get Gap Summary","operationId":"get_gap_summary_stats_gap_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":"fill_cutoff","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Time cutoff (UTC) for fill check, e.g., '16:30'","title":"Fill Cutoff"},"description":"Time cutoff (UTC) for fill check, e.g., '16:30'"},{"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')"}],"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/gap/top

> Get Top Gaps

```json
{"openapi":"3.1.0","info":{"title":"StatAlpha API","version":"0.4.0"},"tags":[{"name":"GAP","description":"Gap statistics and gap fills"}],"paths":{"/stats/gap/top":{"get":{"tags":["GAP"],"summary":"Get Top Gaps","operationId":"get_top_gaps_stats_gap_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":"top_n","in":"query","required":false,"schema":{"type":"integer","default":10,"title":"Top N"}},{"name":"fill_cutoff","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Time cutoff (UTC) for fill check, e.g., '16:30'","title":"Fill Cutoff"},"description":"Time cutoff (UTC) for fill check, e.g., '16:30'"},{"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')"}],"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/gap/top-fills

> Get Fastest Gap Fills

```json
{"openapi":"3.1.0","info":{"title":"StatAlpha API","version":"0.4.0"},"tags":[{"name":"GAP","description":"Gap statistics and gap fills"}],"paths":{"/stats/gap/top-fills":{"get":{"tags":["GAP"],"summary":"Get Fastest Gap Fills","operationId":"get_fastest_gap_fills_stats_gap_top_fills_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":"top_n","in":"query","required":false,"schema":{"type":"integer","default":10,"title":"Top N"}},{"name":"fill_cutoff","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Time cutoff (UTC) for fill check, e.g., '16:30'","title":"Fill Cutoff"},"description":"Time cutoff (UTC) for fill check, e.g., '16:30'"},{"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')"}],"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/gap.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.