Модуль moexalgo.market

class moexalgo.market.Market(name: str, boardid: str | None = None)

Базовые классы: object

Представление конкретного раздела биржевого рынка.

Больше информации о FUTOI можно найти на странице: https://moexalgo.github.io/des/futoi/

Этот класс предоставляет доступ к информации о биржевом рынке, а также позволяет оперировать данными конкретного рынка по его уникальному идентификатору.

Параметры:

• name (str) – Название рынка или его символическое имя.

• boardid (str, optional) – Идентификатор рынка, указывающий на специфическую торговую площадку или сегмент рынка. Если не указан, класс попытается автоматически определить идентификатор на основе общих правил.

tickers : Callable[[Session, bool], Union[List[Dict[str, Any]], pandas.DataFrame]]

Возвращает список всех инструментов рынка.

marketdata : Callable[[Session, bool], Union[List[Dict[str, Any]], pandas.DataFrame]]

Возвращает статистическую информацию о всех инструментах рынка.

tradestats : Callable[[Session, bool], Union[Iterator[TradeStat], pandas.DataFrame]]

Возвращает метрики TradeStat по заданным параметрам.

orderstats : Callable[[Session, bool], Union[Iterator[OrderStat], pandas.DataFrame]]

Возвращает метрики OrderStat по заданным параметрам.

obstats : Callable[[Session, bool], Union[Iterator[ObStat], pandas.DataFrame]]

Возвращает метрики ObStat по заданным параметрам.

futoi : Callable[[Session, bool], Union[Iterator[FUTOI], pandas.DataFrame]]

Возвращает метрики FUTOI по заданным параметрам.

Результат:

return – Экземпляр класса Market, представляющий указанный рынок.

Тип результата:

Market

Исключение:

NotImplementedError – Вызывается, если рынок с указанным названием не поддерживается.

Пример

# Получение информации об акции
>>> try:
>>>     market_instance = Market("index", "MOEX")
>>>     print(market_instance)
>>>     market_instance._ensure_loaded()
>>> except NotImplementedError:
>>>     print("Рынок не поддерживается.")

futoi(*, date: str | date | None = None, latest: bool | None = None, offset: int | None = None, cs: Session | None = None, use_dataframe: bool = True) → iter | DataFrame

Возвращает метрики FUTOI по заданным параметрам.

Параметры:

• date (Union[str, date], optional) – Дата данных. Если не указано, данные выдаются за сегодняшнее число.

• latest (bool, optional) – Включает режим выдачи последних записей в наборе.

• offset (int, optional) – Начальная позиция в последовательности записей.

• cs (Session, optional) – Клиентская сессия, если используется.

• use_dataframe (bool, optional) – Изменяет тип возвращаемого объекта, by default True. Если True, то возвращает pd.DataFrame, иначе итератор.

Результат:

return – Итератор или pd.DataFrame метрик FUTOI.

Тип результата:

Union[iter, pd.DataFrame]

Исключение:

NotImplementedError – Вызывается, если FUTOI не поддерживается для данного рынка.

marketdata(cs: Session | None = None, use_dataframe: bool = True) → list[dict] | DataFrame

Возвращает статистическую информацию о всех инструментах рынка.

Параметры:

• cs (Session, optional) – Клиентская сессия, если используется.

• use_dataframe (bool, optional) – Изменяет тип возвращаемого объекта, by default True. Если True, то возвращает pd.DataFrame, иначе список.

Результат:

return – Объекты типа List или pd.DataFrame.

Тип результата:

Union[list[dict], pd.DataFrame]

obstats(*, date: str | date | None = None, latest: bool | None = None, offset: int | None = None, cs: Session | None = None, use_dataframe: bool = True) → iter | DataFrame

Возвращает метрики ObStat по заданным параметрам.

Параметры:

• date (Union[str, date], optional) – Дата данных. Если не указано, данные выдаются за сегодняшнее число.

• latest (bool, optional) – Включает режим выдачи последних записей в наборе.

• offset (int, optional) – Начальная позиция в последовательности записей.

• cs (Session, optional) – Клиентская сессия, если используется.

• use_dataframe (bool, optional) – Изменяет тип возвращаемого объекта, by default True. Если True, то возвращает pd.DataFrame, иначе итератор.

Результат:

return – Итератор или pd.DataFrame метрик ObStat.

Тип результата:

Union[iter, pd.DataFrame]

orderstats(*, date: str | date | None = None, latest: bool | None = None, offset: int | None = None, cs: Session | None = None, use_dataframe: bool = True) → iter | DataFrame

Возвращает метрики OrderStat по заданным параметрам.

Параметры:

• date (Union[str, date], optional) – Дата данных. Если не указано, данные выдаются за сегодняшнее число.

• latest (bool, optional) – Включает режим выдачи последних записей в наборе.

• offset (int, optional) – Начальная позиция в последовательности записей.

• cs (Session, optional) – Клиентская сессия, если используется.

• use_dataframe (bool, optional) – Изменяет тип возвращаемого объекта, by default True. Если True, то возвращает pd.DataFrame, иначе итератор.

Результат:

return – Итератор или pd.DataFrame метрик OrderStat.

Тип результата:

Union[iter, pd.DataFrame]

tickers(cs: Session | None = None, use_dataframe: bool = True) → list[dict] | DataFrame

Возвращает список всех инструментов рынка.

Параметры:

• cs (Session, optional) – Клиентская сессия, если используется.

• use_dataframe (bool, optional) – Изменяет тип возвращаемого объекта, by default True. Если True, то возвращает pd.DataFrame, иначе список.

Результат:

return – Объекты типа List или pd.DataFrame.

Тип результата:

Union[list[dict], pd.DataFrame]

tradestats(*, date: str | date | None = None, latest: bool | None = None, offset: int | None = None, cs: Session | None = None, use_dataframe: bool = True) → iter | DataFrame

Возвращает метрики TradeStat по заданным параметрам.

Параметры:

• date (Union[str, date], optional) – Дата данных. Если не указано, данные выдаются за сегодняшнее число.

• latest (bool, optional) – Включает режим выдачи последних записей в наборе.

• offset (int, optional) – Начальная позиция в последовательности записей.

• cs (Session, optional) – Клиентская сессия, если используется.

• use_dataframe (bool, optional) – Изменяет тип возвращаемого объекта, by default True. Если True, то возвращает pd.DataFrame, иначе итератор.

Результат:

return – Итератор или pd.DataFrame метрик TradeStat.

Тип результата:

Union[iter, pd.DataFrame]

moexalgo.market.market_for(secid: str, boardid: str, cs: Session | None = None) → Market | None

Возвращает рынок, на котором торгуется заданный инструмент.

Параметры:

• secid (str) – Уникальный идентификатор инструмента.

• boardid (str) – Идентификатор рынка, указывающий на специфическую торговую площадку или сегмент рынка.

• cs (Session, optional) – Клиентская сессия, если используется.

Результат:

return – Экземпляр класса Market, представляющий рынок, на котором торгуется заданный инструмент.

Тип результата:

Optional[Market]