UniverseThemesResponse

  • available
    Type: boolean
    required

    Whether the caller's tier may restrict a scan universe by theme. False for free/expired/anonymous callers, and themes is then empty — the two are reported separately so a client can tell 'upgrade to use this' from 'this week's classification produced nothing'.

  • themes
    Type: array object[] · UniverseTheme[]
    required

    This week's scannable themes. Empty when the caller's tier is not entitled, or when the upstream classification run produced none.

    • label
      Type: string
      required

      The theme name, and the exact string that goes in Universe.Theme.

    • ticker_count
      Type: number
      required

      Securities this theme contributes to a scan universe: core + satellite assignments. NOT num_tickers from /api/v2/stocks/themes, which is core-only — expect the two to differ.

    • color
      Type: string

      Stable hex colour, inherited across runs where membership persists — the same colour the theme performance charts use. Optional.

    • short_label
      Type: string

      Abbreviated name for dense/small-screen contexts. Absent on classification runs predating the field, so always fall back to label.