zvt.contract.api.get_data

zvt.contract.api.get_data(data_schema: Type[zvt.contract.schema.Mixin], ids: Optional[List[str]] = None, entity_ids: Optional[List[str]] = None, entity_id: Optional[str] = None, codes: Optional[List[str]] = None, code: Optional[str] = None, level: Optional[Union[zvt.contract.IntervalLevel, str]] = None, provider: Optional[str] = None, columns: Optional[List] = None, col_label: Optional[dict] = None, return_type: str = 'df', start_timestamp: Optional[Union[str, pandas._libs.tslibs.timestamps.Timestamp]] = None, end_timestamp: Optional[Union[str, pandas._libs.tslibs.timestamps.Timestamp]] = None, filters: Optional[List] = None, session: Optional[sqlalchemy.orm.session.Session] = None, order=None, limit: Optional[int] = None, index: Optional[Union[str, list]] = None, drop_index_col=False, time_field: str = 'timestamp')

query data by the arguments

Parameters
  • data_schema

  • ids

  • entity_ids

  • entity_id

  • codes

  • code

  • level

  • provider

  • columns

  • col_label – dict with key(column), value(label)

  • return_type – df, domain or dict. default is df

  • start_timestamp

  • end_timestamp

  • filters

  • session

  • order

  • limit

  • index – index field name, str for single index, str list for multiple index

  • drop_index_col – whether drop the col if it’s in index, default False

  • time_field

Returns

results basing on return_type.