// endpoints

Schema

Discover all queryable fields, types, and allowed values

GET https://api.tickerdb.com/v1/schema/fields

Returns all queryable fields available in the TickerDB API, including their canonical names, types, categories, allowed values, and descriptions. Use this endpoint to discover what you can filter on in the Search endpoint or query in Summary.

Always Free

This endpoint is free on all tiers and does not count against your rate limits. Useful for agents that need to dynamically discover available fields before constructing queries.

Canonical Names

Treat the field names returned here as the canonical names for LLMs and generated clients. They are flat snake_case names like momentum_rsi_zone, extremes_condition, trend_direction, and volume_percentile. Search uses these directly. Summary documents nested response objects with dotted paths like trend.direction, and watchlist diffs use short technical names plus dotted fundamentals.* names. Some endpoints still accept dotted or short aliases for backwards compatibility.

Values Match Runtime

The categorical values returned here use the same public band catalog as the docs and runtime responses. If you want the human explanation behind a label like deeply_overvalued or contracting_positive, jump to Categorical Bands.

Derived Insider Fields

Public insider fields stay derived-only. Schema and search expose insider_zone, insider_net_direction, and insider_quarter. Raw transaction counts and share totals are intentionally omitted from public responses.

Parameters

This endpoint takes no parameters.

Response

Field	Type	Description
`fields`	`array`	Array of field descriptor objects
`total_fields`	`integer`	Total number of queryable fields
`categories`	`array`	Available field categories
`operators`	`array`	Operators supported by `/v1/search`

Field Object

Field	Type	Description
`name`	`string`	Canonical flat snake_case field name (e.g. `momentum_rsi_zone`, `extremes_condition`, `trend_direction`, `volume_percentile`)
`type`	`string`	Underlying field type: `text`, `integer`, `numeric`, `boolean`, or `bigint`
`category`	`string`	Which category this field belongs to (e.g. `momentum`, `trend`, `volume`)
`values`	`array`	Allowed categorical values, when applicable
`description`	`string`	Human-readable description of the field

Example Request

curl

curl https://api.tickerdb.com/v1/schema/fields \
  -H "Authorization: Bearer YOUR_API_KEY"

Example Response

JSON

{
  "total_fields": 136,
  "categories": ["metadata", "trend", "momentum", "extremes", "volatility", "volume", "support", "resistance", "range", "fundamentals", "insider", "sector_context"],
  "operators": ["eq", "neq", "in", "gt", "gte", "lt", "lte"],
  "fields": [
    {
      "name": "ticker",
      "type": "text",
      "category": "metadata",
      "description": "Ticker symbol"
    },
    {
      "name": "momentum_rsi_zone",
      "type": "text",
      "category": "momentum",
      "values": ["deep_oversold", "oversold", "neutral_low", "neutral", "neutral_high", "overbought", "deep_overbought"],
      "description": "Current RSI zone"
    },
    {
      "name": "trend_direction",
      "type": "text",
      "category": "trend",
      "values": ["strong_uptrend", "uptrend", "neutral", "downtrend", "strong_downtrend"],
      "description": "Current trend direction"
    },
    {
      "name": "volume_percentile",
      "type": "numeric",
      "category": "volume",
      "description": "Volume rank in 1-year history"
    }
  ]
}

Use Cases

Dynamic query builders: Let agents discover available fields and construct filters programmatically
Validation: Confirm valid field names and values before calling /v1/search
Event queries: Use the same canonical names for /v1/summary/:ticker?field=... event lookups, including fields like extremes_condition
Documentation: Build UI dropdowns or auto-complete from the schema