# Market-wide flow overview for the current trading day

`GET https://flow-api.skylit.ai/v1/market/overview`

API: Flowseeker. Credits: 3.

Returns market-wide call/put premium, total volume, directional
bullish/bearish premium, FIR, premium relative volume vs the
trailing 20-day baseline at the same time of day, and the top 10
tickers by total premium. Optionally narrowed to a comma-separated
ticker filter.

## Authentication

Send your Skylit API key as a bearer token: `Authorization: Bearer <key>`. No other header is accepted.

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `tickers` | query | string | no | Comma-separated list of tickers (e.g. `AAPL,NVDA,SPY`). When omitted, returns true market-wide stats over every ticker. |

## Example request

```bash
curl "https://flow-api.skylit.ai/v1/market/overview" \
  -H "Authorization: Bearer $SKYLIT_API_KEY"
```

## Responses

### 200

Market-wide overview snapshot.

Shape (placeholder values):

```json
{
  "data": {
    "date": "string",
    "totalPremium": 0,
    "totalVolume": 0,
    "callPremium": 0,
    "putPremium": 0,
    "netPremium": 0,
    "callVolume": 0,
    "putVolume": 0,
    "callPutRatio": 0,
    "activeTickers": 0,
    "bullishPremium": 0,
    "bearishPremium": 0,
    "directionalNet": 0,
    "fir": 0,
    "premiumRvol": 0,
    "topTickers": [
      {
        "ticker": "string",
        "totalPremium": 0,
        "totalVolume": 0,
        "callPremium": 0,
        "putPremium": 0,
        "netPremium": 0
      }
    ]
  },
  "meta": {
    "timestamp": "string",
    "requestId": "d7574836"
  }
}
```

### 400

Request validation failed.

invalidParam:

```json
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid parameter 'timeframe': must be one of [1m, 5m, 15m, 1h, 4h, 1d, 1w, 1M]"
  }
}
```

### 401

Missing or invalid API key.

missingKey:

```json
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  }
}
```

### 402

The account's shared Skylit credit balance is lower than this route's cost. Top up to continue. Carries `X-Credits-Remaining: 0`.

Headers: `X-Credits-Remaining`.

outOfCredits:

```json
{
  "error": {
    "code": "insufficient_credits",
    "message": "Out of credits. Top up to continue making requests."
  }
}
```

### 403

API key invalid, revoked or expired, or the account's API access is suspended (`account_suspended`).

accountSuspended:

```json
{
  "error": {
    "code": "account_suspended",
    "message": "API access has been suspended for this account. Contact support."
  }
}
```

### 429

Per-minute rate limit exceeded.

Headers: `Retry-After`.

tooFast:

```json
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Rate limit of 100 req/min exceeded. Retry after 18s."
  }
}
```

### 503

Underlying data source temporarily unavailable, or the credit balance could not be verified (`credit_check_failed`). Safe to retry.

ingestionLag:

```json
{
  "error": {
    "code": "UNAVAILABLE",
    "message": "Live feed is degraded; please retry in a few seconds."
  }
}
```

creditCheckFailed:

```json
{
  "error": {
    "code": "credit_check_failed",
    "message": "Could not verify credit balance. Please retry."
  }
}
```