# Sector- or industry-level flow aggregation

`GET https://flow-api.skylit.ai/v1/flow/sector/{sector}`

API: Flowseeker. Credits: 3.

Aggregates options flow across all tickers in a GICS sector. The
`{sector}` path parameter accepts either a sector ETF symbol
(`XLK`, `XLF`, `XLE`, …) or a sector name (`Technology`,
`Financials`, …). Returns sector-level metrics, top-contributor
tickers, and an industry-level breakdown.

## Authentication

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

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `sector` | path | string | yes | Sector ETF symbol (`XLK`, `XLF`, `XLE`, `XLV`, `XLY`, `XLP`, `XLU`, `XLI`, `XLB`, `XLRE`, `XLC`) or full sector name (`Technology`, `Financials`, `Healthcare`, etc.). |
| `date` | query | string (date) | no |  |
| `top_n` | query | integer | no |  (default `10`; min 1; max 50) |

## Example request

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

## Responses

### 200

Sector flow aggregation.

Shape (placeholder values):

```json
{
  "data": {
    "sector": "string",
    "etf": "string",
    "date": "string",
    "metrics": {
      "totalPremium": 0,
      "callPremium": 0,
      "putPremium": 0,
      "netPremium": 0,
      "totalVolume": 0,
      "callVolume": 0,
      "putVolume": 0,
      "netVolume": 0,
      "fir": 0,
      "putCallRatio": 0
    },
    "topContributors": [
      {
        "ticker": "string",
        "netPremium": 0,
        "callPremium": 0,
        "putPremium": 0,
        "pctOfSector": 0
      }
    ],
    "industryBreakdown": [
      {
        "industry": "string",
        "netPremium": 0,
        "totalPremium": 0,
        "pctOfSector": 0,
        "tickerCount": 0
      }
    ],
    "tickerCount": 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."
  }
}
```

### 404

Unknown resource (ticker / sector / window with no data).

noData:

```json
{
  "error": {
    "code": "NOT_FOUND",
    "message": "No trades found for AAPL on 2026-05-27 with timeframe 1d"
  }
}
```

### 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."
  }
}
```