Skip to content

list_fields API

Shadow Ingest / API Reference / General-Purpose
list_fields(target: Callable | str) -> list[str]

Returns the documented public fields values for APIs that expose a stable fields parameter.

Before You Run This Example

Supported Targets

Today list_fields(...) is intentionally narrow and documents:

  • gather_daily_price(...)

If you pass an API that does not expose a stable public fields parameter, the SDK raises ValueError.

Copy-Paste Example

import shadow_ingest as si

price_fields = si.list_fields(si.gather_daily_price)
print(price_fields)

Example Output

[
  'open',
  'high',
  'low',
  'close',
  'volume',
  'total_turnover',
  'prev_close',
  'limit_up',
  'limit_down',
  'num_trades',
]

Field Reference For gather_daily_price(...)

Field Meaning
open Opening price for the trading day
high Highest traded price during the trading day
low Lowest traded price during the trading day
close Closing price for the trading day
volume Traded share volume for the trading day
total_turnover Total traded value for the trading day
prev_close Previous trading day's close
limit_up Daily upper price limit
limit_down Daily lower price limit
num_trades Number of trades during the day

Notes

  • list_fields(...) only documents the optional fields values.
  • gather_daily_price(...) still returns identifier columns such as trade_date and stock_code in the final dataframe.
  • If you need to inspect the full current output schema in your own environment, run a small query with fields=None and inspect df.columns.