Search series (with optional hydration)

POST

/api/b2b/search/series

curl --request POST \
  --url https://api.stockalloy.com/api/b2b/search/series \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "query": "launch backlog", "ticker": "RKLB", "limit": 10, "fetch_top": 1 }'

• Production

Series-only search that enriches each hit with company info and series metadata. Set fetch_top (max 5) to also hydrate the top hits with full series metadata and blob URLs in top_series.

Authorizations

• ApiKeyAuth

Request Body^required

Media typeapplication/json

object

ticker

Stock ticker, e.g. DECK.

string

cik

Zero-padded 10-digit SEC CIK, e.g. 0001011570.

string

tickers

Company set (search endpoints only).

Array<string>

ciks

Company set (search endpoints only).

Array<string>

query

required

string

>= 2 characters

limit

integer

default: 20 >= 1 <= 50

offset

integer

0 <= 200

fetch_top

Hydrate the top N hits with full metadata + blob URLs.

integer

<= 5

Example

{
  "query": "launch backlog",
  "ticker": "RKLB",
  "limit": 10,
  "fetch_top": 1
}

Responses

200

Ranked series results.

Media typeapplication/json

object

scope

string

Allowed values: company company_set cross_company

query

string

ticker

string | null

cik

string | null

limit

integer

offset

integer

count

integer

results

Array<object>

object

series_id

string

series_key

string | null

cik

string | null

ticker

string | null

current_ticker

string | null

company_name

string | null

metric_id

string | null

dims_key

string | null

unit_signature

string | null

title

string | null

subtitle

string | null

series_kind

string | null

rank

number

point_count

integer | null

last_period_end

string | null

meaning_hint

string | null

meaning_disclaimer

string | null

meaning_tooltip

string | null

needs_meaning_tooltip

boolean

top_series

Present when fetch_top > 0.

Array<object>

object

series_id

string

series_key

string | null

cik

string

ticker

string | null

current_ticker

string | null

company_name

string | null

metric_id

string

dims_hash

string

dims_key

string | null

unit_signature

string

title

string | null

subtitle

string | null

y_label

string | null

preferred_scale

string | null

series_kind

string | null

is_active

boolean

first_period_end

string | null

last_period_end

string | null

point_count

integer | null

meaning_hint

string | null

meaning_disclaimer

string | null

meaning_tooltip

string | null

needs_meaning_tooltip

boolean

serving

object

series_version

integer | null

etag

string | null

points_count

integer | null

first_period

string | null

last_period

string | null

built_at

string | null

blob_url

Pre-built series data blob (/s/series/{series_id}/{version}), immutable and cacheable.

string | null

Example

{
  "scope": "company"
}

Headers

X-RateLimit-Limit

integer

Requests allowed per minute for this key.

X-RateLimit-Remaining

integer

Requests remaining in the current minute window.

X-RateLimit-Reset

integer

Unix timestamp (seconds) when the window resets.

400

Invalid request — missing/invalid fields, malformed JSON, or an unsupported scope combination.

Media typeapplication/json

object

error

required

Human-readable error message.

string

Example

{
  "error": "query is required"
}

401

Missing or invalid API key.

Media typeapplication/json

object

error

required

Human-readable error message.

string

Example

{
  "error": "API key required"
}

403

Key revoked/disabled/expired, account disabled, key not entitled for this product, or cross-company search not enabled for this key.

Media typeapplication/json

object

error

required

Human-readable error message.

string

Example

{
  "error": "API key has expired"
}

404

Company not found (unknown ticker or CIK).

Media typeapplication/json

object

error

required

Human-readable error message.

string

Example

{
  "error": "Unknown ticker: ZZZZ"
}

429

Rate limit exceeded (per-minute) or quota exceeded (daily/monthly, account-level or per-key). Distinguish by body shape.

Media typeapplication/json

One of:

object

object

error

required

string

Allowed value: Rate limit exceeded

retryAfter

required

Seconds until the window resets.

integer

limit

required

Requests allowed per minute for this key.

integer

windowMs

required

integer

Allowed value: 60000

object

object

error

required

daily quota exceeded or monthly quota exceeded.

string

quota

required

string

Allowed values: daily monthly

scope

required

account sums usage across all keys on the account; api_key is a per-key cap.

string

Allowed values: account api_key

limit

required

integer

used

required

integer

Examples

Per-minute rate limit

{
  "error": "Rate limit exceeded",
  "retryAfter": 31,
  "limit": 60,
  "windowMs": 60000
}

Monthly quota

{
  "error": "monthly quota exceeded",
  "quota": "monthly",
  "scope": "account",
  "limit": 5000,
  "used": 5000
}

Headers

X-RateLimit-Limit

integer

Requests allowed per minute for this key.

X-RateLimit-Remaining

integer

Requests remaining in the current minute window.

X-RateLimit-Reset

integer

Unix timestamp (seconds) when the window resets.

Retry-After

integer

Seconds to wait before retrying (429 only).

500

Unexpected server error.

Media typeapplication/json

object

error

required

Human-readable error message.

string

Example

{
  "error": "Facts lookup failed"
}