# Prefix-search active tickers

`GET https://flow-api.skylit.ai/v1/underlying/search`

API: Flowseeker. Credits: 1.

Case-insensitive prefix search over the active-tickers universe
for the requested date. Use to power autocomplete UIs.

## Authentication

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

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `q` | query | string | yes | Search prefix (1–10 characters, uppercased server-side). |
| `limit` | query | integer | no |  (default `20`; min 1; max 50) |
| `date` | query | string (date) | no | Trading date the request targets, in `YYYY-MM-DD`. Defaults to the current trading date (the most recent session that has settled enough data to be queryable). |

## Example request

```bash
curl "https://flow-api.skylit.ai/v1/underlying/search?q=AAP" \
  -H "Authorization: Bearer $SKYLIT_API_KEY"
```

## Responses

### 200

Matching tickers (capped at 50).

Shape (placeholder values):

```json
{
  "data": [
    {
      "ticker": "SPY",
      "totalPremium": 0,
      "totalVolume": 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."
  }
}
```

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