TickerDocs
Tools

list_screen_columns

Lists every column a screen or a View can name, with its meaning, its unit and the plan that includes it.

When to use it

Inputs

  • offset (integer): Skip this many columns. The catalog comes back in parts: when an answer is cut, meta.next gives the offset for the next part. Leave it out for the first part.
  • search (string or array of strings): One or more words, as one string like price demand or a list like ["price", "demand"]: only the columns whose name, group or meaning contains one of them. Leave it out for the whole catalog.
  • view (string, default columns): columns (the default): the columns. presets: the preset screens instead, each with its key, name, predicate, sort, the columns it shows, the plan its filter needs and whether your plan holds it. Pass a key to screen_events as preset to run it. One of columns, presets.

Examples

What can I screen events on?

{}

Show me the rest of the column list.

{ "offset": 83 }

What comes back

  • The catalog in parts: the first part is the start of the list. A cut part comes back as data with meta.truncated, meta.returned_rows, meta.total_rows and meta.next, the offset to call with for the next part.
  • One row per column: namespace, column_name, data_type, label, unit and description, which says what the column means and when it is empty.
  • The namespaces: ea holds the event's market numbers, e the event's own facts like its dates, pa the performer's numbers, p the performer's name, and v the venue's name, place and capacity.
  • In a predicate, name a column as namespace.column_name, like ea.median_price_pct_7d, never by its label.
  • enum_values lists the allowed values of a column that takes a fixed set.
  • locked is true for a column your plan does not include, with required_tier, the plan that includes it. A locked column stays on the list so you can see what a plan adds.

Limits and quota

  • Reads only: it changes nothing.
  • Free: it spends no quota.
  • The whole catalog takes a few calls. Read it once and keep it.

On this page