zvt.contract.api.get_entities¶
- zvt.contract.api.get_entities(entity_schema: Type[TradableEntity] = None, entity_type: str = None, exchanges: List[str] = None, ids: List[str] = None, entity_ids: List[str] = None, entity_id: str = None, codes: List[str] = None, code: 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, index: str | list = 'code') List¶
get entities by the arguments
- Parameters:
entity_schema
entity_type
exchanges
ids
entity_ids
entity_id
codes
code
provider
columns
col_label
return_type
start_timestamp
end_timestamp
filters
session
order
limit
index
- Returns: