Series catalog for a company

POST

/api/b2b/series/catalog

curl --request POST \
  --url https://api.stockalloy.com/api/b2b/series/catalog \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "ticker": "DECK", "metric_id": "us-gaap#RevenueFromContractWithCustomerExcludingAssessedTax" }'

• Production

Lists every series (metric × dimension slice × unit) available for a company, with observation counts and period coverage. Use the returned series_key values with the /by-series facts endpoints.

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>

metric_id

Optional XBRL metric ID filter, e.g. us-gaap#Revenues. Facts endpoints require a single-company scope (ticker or cik).

string

Example

{
  "ticker": "DECK",
  "metric_id": "us-gaap#RevenueFromContractWithCustomerExcludingAssessedTax"
}

Responses

200

Series catalog rows.

Media typeapplication/json

object

scope

required

string

Allowed value: company

ticker

string | null

cik

required

string

metric_id

Echoes the request filter.

string | null

count

required

integer

rows

required

Array<object>

object

series_key

string

cik

string

current_ticker

string | null

metric_id

string

metric_label

string

is_consolidated

boolean

dims_key

string | null

axes_count

integer

axis_types

Array<string> | null

dimension_path_raw

string | null

dimension_path_label

string | null

unit_signature

string

unit_class

string

currency

string | null

first_period_end

string | null format: date

last_period_end

string | null format: date

observation_count

integer

latest_period_end

string | null format: date

latest_source_filed_at

string | null format: date

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"
}

503

The verified-facts backend is temporarily unavailable. Transient — retry with backoff. This is an infrastructure condition, not a data gap.

Media typeapplication/json

object

error

required

Human-readable error message.

string

Example

{
  "error": "Facts backend unavailable"
}