// 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 types, allowed values, sections, 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.

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

Field Object

Field	Type	Description
`name`	`string`	Dot-notation field name (e.g. `rsi_zone`, `trend.direction`, `volume.percentile`)
`type`	`string`	Field type: `categorical`, `numeric`, `boolean`, or `string`
`section`	`string`	Which response section this field belongs to (e.g. `momentum`, `trend`, `volume`)
`values`	`array`	For categorical fields: the allowed band values in order. Absent for non-categorical fields.
`range`	`array`	For numeric fields: `[min, max]`. Absent for non-numeric fields.
`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

{
  "fields": [
    {
      "name": "rsi_zone",
      "type": "categorical",
      "section": "momentum",
      "values": ["deep_oversold", "oversold", "neutral_low", "neutral", "neutral_high", "overbought", "deep_overbought"],
      "description": "Current RSI zone"
    },
    {
      "name": "trend.direction",
      "type": "categorical",
      "section": "trend",
      "values": ["strong_uptrend", "uptrend", "neutral", "downtrend", "strong_downtrend"],
      "description": "Current trend direction"
    },
    {
      "name": "volume.percentile",
      "type": "numeric",
      "section": "volume",
      "range": [0, 100],
      "description": "Volume rank in 1-year history"
    },
    {
      "name": "sector",
      "type": "string",
      "section": "identification",
      "description": "Sector or category"
    }
  ],
  "total_fields": 62
}

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
Documentation: Build UI dropdowns or auto-complete from the schema