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

# StatAlpha Documentation

Welcome to the StatAlpha documentation.

StatAlpha helps traders, analysts, and developers explore statistically grounded market behavior through a web console and an API.

## What You Can Do

Use StatAlpha to analyze patterns such as:

* Opening Range Breakouts (ORB)
* Fair Value Gaps (FVG)
* Break of Structure (BOS)
* Previous Day High / Low Breaks (PDHLB)
* Overnight and intraday continuation patterns
* Seasonality and trend behavior
* Gap behavior and fills

## Web Quickstart

1. Open the web console:

   ```
   https://web.statalpha.market
   ```
2. Sign in with your StatAlpha account.
3. Open the dashboard and choose an analytics module.
4. Enter a symbol, timeframe, and optional filters.
5. Run the analysis and review the returned statistics.

Your account page shows your current plan, API access status, history access, and remaining request usage.

## API Quickstart

Direct API access requires an API-enabled StatAlpha account. Standard API login uses Auth0 Device Authorization Flow.

Example: retrieve a Fair Value Gap summary for AAPL on a 15-minute timeframe over the past 12 months.

```bash
curl -s \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  "https://api.statalpha.market/stats/fvg/summary?symbol=AAPL&timeframe=15m&time_window=12M"
```

Base URL:

```
https://api.statalpha.market
```

## Key Topics

| Topic                                                                                     | Description                                           |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| [Authentication](/statalpha-docs/using-the-api/authentication.md)                         | How to sign in and use API access tokens              |
| [Rate Limits & Plans](/statalpha-docs/using-the-api/rate-limits.md)                       | Web/API access, history limits, and request limits    |
| [Stats Overview](/statalpha-docs/stats/intro.md)                                          | Statistical logic and use cases for StatAlpha metrics |
| [API Parameters](https://github.com/marius-vovcu/StatAlpha/blob/dev/docs/api/overview.md) | Common parameters, query filters, and conventions     |
| [API Reference](/statalpha-docs/api-reference.md)                                         | Endpoint reference generated from OpenAPI             |

## Support

If you need help with your account, API access, or plan limits, contact StatAlpha support.


---

# 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/readme.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.