> 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://app.statalpha.io
   ```
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.io/stats/fvg/summary?symbol=AAPL&timeframe=15m&time_window=12M"
```

Base URL:

```
https://api.statalpha.io
```

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