# Bucketed market-wide net call premium / net put premium time series

`GET https://api.skylit.ai/v1/market/tide`

API: Flowseeker. Credits: `interval` ≤ 30D with an intraday `bucket` (`1min`–`30min`), ≤ 360D with `1d`/`1w`; ≤ 5D with `exclude_deep_itm=true`.

Returns the market-wide intraday "tide" — bucketed Net Call
Premium and Net Put Premium series with both per-bucket and
cumulative values, plus an SPY price overlay for context. Two
directional flavors are emitted per bar: the standard `ncp`/`npp`
(call-buying minus call-selling, etc.) and a `manualNcp`/
`manualNpp` variant with the script-trade exclusion logic
relaxed for callers that need raw flow.

## Authentication

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

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `interval` | query | string | no | Trailing window length. Defaults to a single trading day (`1D`); multi-day intervals roll up history at the chosen bucket size. Intraday buckets (`1min`–`30min`) allow at most `30D`; use `1d` or `1w` for longer windows. Priced by range: 3 credits per started 30 days (`360D` = 36). (one of `1D`, `2D`, `3D`, `5D`, `7D`, `14D`, `30D`, `45D`, `60D`, `90D`, `120D`, `180D`, `360D`; default `1D`) |
| `bucket` | query | string | no | Bucket size for the time series. (one of `1min`, `5min`, `15min`, `30min`, `1d`, `1w`; default `5min`) |
| `date` | query | string (date) | no | Trading date anchor (`YYYY-MM-DD`). Defaults to today. |
| `exclude_multi_leg` | query | boolean | no | Exclude multi-leg / spread trades from the directional totals. (default `false`) |
| `exclude_deep_itm` | query | boolean | no | Exclude deep in-the-money trades (`moneyness_percent < -20`) from the directional totals. This reads raw trades rather than the pre-aggregated series: `interval` is capped at `5D` and the call costs 3 credits per trading day. (default `false`) |

## Example request

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

## Responses

### 200

Market tide bars.

Shape (placeholder values):

```json
{
  "data": {
    "interval": "string",
    "bucket": "string",
    "bars": [
      {
        "timestamp": 0,
        "timestampEnd": 0,
        "ncp": 0,
        "npp": 0,
        "ncpCumulative": 0,
        "nppCumulative": 0,
        "manualNcp": 0,
        "manualNpp": 0,
        "manualNcpCumulative": 0,
        "manualNppCumulative": 0,
        "callVolume": 0,
        "putVolume": 0,
        "totalVolume": 0,
        "spyPrice": 0,
        "isGap": false
      }
    ]
  },
  "meta": {
    "timestamp": "string",
    "requestId": "d7574836",
    "nextCursor": "string",
    "nextEndTime": "string"
  }
}
```

### 400

Request validation failed.

invalidParam:

```json
{
  "error": {
    "code": "INVALID_PARAMETER",
    "message": "Invalid value 'bogus' for 'timeframe'. Allowed: 5m, 15m, 1h, 4h, 1d."
  }
}
```

### 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

Unknown, revoked or expired API key (the gateway's `forbidden`), the account's API access is suspended (`account_suspended`) or blocked (`account_blocked`). Not retryable.

badKey:

```json
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Access to this API has been disallowed"
  }
}
```

accountSuspended:

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

### 429

Either the key exceeded its requests-per-minute limit (`X-RateLimit-Limit`; no `Retry-After`, wait until `X-RateLimit-Reset`), or the account is over one of the API's own limits, such as the query budget (queries running at once, fresh queries per second): `TOO_MANY_CONCURRENT_QUERIES` or `RATE_LIMITED` with `Retry-After`. Not charged; retry after the wait.

tooFast:

```json
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Rate limit exceeded."
  }
}
```

queryBudget:

```json
{
  "error": {
    "code": "TOO_MANY_CONCURRENT_QUERIES",
    "message": "This account already has 16 queries running on the shared query engine across all servers (limit ch.concurrent.customer). Cached answers are not affected. Retry after Retry-After; to backfill a day, follow meta.nextCursor instead of splitting time windows. See https://www.skylit.ai/docs/api-reference/rate-limits-and-retries",
    "retry_after": 1,
    "docs_url": "https://www.skylit.ai/docs/api-reference/errors#too_many_concurrent_queries"
  }
}
```

### 500

Unexpected server error (`INTERNAL_ERROR`, `DATABASE_ERROR`). Not charged; safe to retry with exponential backoff.

internal:

```json
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}
```

### 503

Underlying data source temporarily unavailable, the credit balance could not be verified (`credit_check_failed`), or the API is paused for maintenance (`api_paused`, with a `Retry-After` header and a `retry_after` field in seconds). Not charged; 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."
  }
}
```

### 504

The request did not complete within 25 seconds. Not charged; narrow the window or retry.

tooSlow:

```json
{
  "error": {
    "code": "GATEWAY_TIMEOUT",
    "message": "The request took too long and was not completed. It was not charged; narrow the request or retry."
  }
}
```
