> ## Documentation Index
> Fetch the complete documentation index at: https://api.unusualwhales.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> API requests use the base URL https://api.unusualwhales.com and require a bearer token in the `Authorization` header (`Authorization: Bearer <API_KEY>`). Create and manage API tokens at https://unusualwhales.com/dashboard/api.
> For live market data inside an AI tool, use the Unusual Whales MCP server at https://unusualwhales.com/public-api/mcp.
> Instructions for agents using Unusual Whales tools: https://unusualwhales.com/skill.md

# Your first stock screen

> Build API screens for options activity, volatility, momentum, and gamma.

The stock screener allows you to screen all tickers in the market with over 200+ filters. From volatility filters, stock returns
(both percentage as well as log based and std moves), options flow, gex, ta, fundamentals, buyback programs and much more.

Note: Since we return for each ticker over 200 fields in a response we will omit and shorten
the responses in our examples.

## Make your first request

<Steps>
  <Step title="Set up your API key">
    Get the API token from the [API dashboard](https://unusualwhales.com/dashboard/api):

    ```bash wrap theme={null}
    export UW_API_KEY="YOUR_API_KEY"
    ```
  </Step>

  <Step title="Request stocks with at least $1 billion in market capitalization">
    <CodeGroup>
      ```bash cURL wrap theme={null}
      curl --fail-with-body --get 'https://api.unusualwhales.com/api/screener/stocks' \
        --header "Authorization: Bearer $UW_API_KEY" \
        --data-urlencode 'min_marketcap=1000000000' \
        --data-urlencode 'limit=10'
      ```
    </CodeGroup>
  </Step>

  <Step title="Read a result">
    An example response would look like this. As mentioned in the introduction we omitted other fields
    in this example as there are over 200 fields.

    ```json wrap theme={null}
    {
      "data": [
        {
          "ticker": "AAPL",
          "date": "2026-09-18",
          "close": "230.00",
          "marketcap": "3450000000000",
          "call_volume": 120000,
          "put_volume": 50000,
          "total_open_interest": 1500000
        }
      ]
    }
    ```
  </Step>
</Steps>

## Choose your next screen

<Columns cols={2}>
  <Card title="Build and combine filters" href="/docs/guides/stock-screener/filters">
    Translate screening conditions and comparisons between fields into requests.
  </Card>

  <Card title="Options activity" href="/docs/guides/stock-screener/options-activity">
    Find stocks with call and put volume imbalances.
  </Card>

  <Card title="Volatility" href="/docs/guides/stock-screener/volatility">
    Compare IV horizons and price moves relative to IV.
  </Card>
</Columns>
