zvt.contract.api.get_data¶
- zvt.contract.api.get_data(data_schema: Type[Mixin], ids: List[str] = None, entity_ids: List[str] = None, entity_id: str = None, codes: List[str] = None, code: str = None, level: IntervalLevel | str = None, provider: str = None, columns: List = None, col_label: dict = None, return_type: str = 'df', start_timestamp: Timestamp | str = None, end_timestamp: Timestamp | str = None, filters: List = None, session: Session = None, order=None, limit: int = None, distinct=None, index: 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.