list_portfolios names each portfolio’s playbooks and charts, and the snapshot returns their full settings.
Playbooks
read
A playbook’s sheet for a date: its symbols, its input columns with their type, scope,
carry_forward, optional and options, and the values for that date. One playbook serves every date. A carry_forward column shows its latest value on or before the date, marked carried and with the date it was recorded. needs_input lists the cells with no value, except the blank cells of an optional input. Fill them in with record_input_values. Each value also gives previous_value and previous_date (the entry recorded just before it) and since (the first date of the unbroken run of equal values that ends at it). A column also shows its emphasis, and each value an emphasized flag: true when the rule you set on that input holds for the value against the previous entry (for example, lower than it). It states your rule and doesn’t call a change good or bad. carried, previous_value, previous_date and emphasized appear only when they apply. Key arguments: playbook_id (from list_portfolios), optional date (without it, the playbook’s own date, which is today in US Eastern unless a date is pinned).write, destructive
Creates a playbook or changes it, a sheet with a row per symbol and a column per input. A playbook doesn’t need a copy for each day. A new playbook follows today in US Eastern;
default_date pins its own date, and null goes back to following today. remove alone drops those inputs or symbols. A list that leaves a member out is refused until you name it in remove. Key arguments: playbook_id (to change one), portfolio_id (to create), name, description, source (positions, watchlist or custom), watchlist_id, symbols, inputs, default_date, remove.write, destructive
Deletes a playbook. This can’t be undone. Recorded values stay with their inputs. Key arguments:
playbook_id.Charts
write, destructive
Creates a saved chart or changes it: inputs plotted as lines and level markers as horizontal markers, for the symbols its source names, over 7 to 180 days.
get_portfolio_snapshot shows its settings. remove alone drops those inputs, level markers or symbols. Key arguments: chart_id (to change one), portfolio_id (to create), name, inputs, level_markers, source, watchlist_id, symbols, symbol, days (7, 14, 30, 60, 90 or 180), remove.write, destructive
Deletes a saved chart. This can’t be undone. Key arguments:
chart_id.Next steps
Playbooks
Read your recorded values per date in one sheet.
Input tools
Define Inputs and record values.