zvt.contract.api.get_entities

zvt.contract.api.get_entities(entity_schema: Optional[Type[zvt.contract.schema.TradableEntity]] = None, entity_type: Optional[str] = None, exchanges: Optional[List[str]] = None, 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, 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: Union[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