Модуль moexalgo.futures

class moexalgo.futures.Futures(secid: str, boardid: str | None = None)

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

Класс для работы с фьючерсами. Больше информации о фьючерсных инструментах можно найти на странице: https://moexalgo.github.io/des/supercandles/#_2

_PATH

Путь к данным.

Type:

str

_TYPE

Тип инструмента.

Type:

str

_LIMIT

Количество записей в результате, если не указано другое значение (по умолчанию 25 000).

Type:

int

info : Callable

Возвращает информацию об инструменте.

tradestats : Callable

Возвращает метрики TradeStat.

obstats : Callable

Возвращает метрики ObStat.

hi2 : Callable

Возвращает метрики Hi2.

Пример

# Получение информации о фьючерсном инструменте
>>> from moexalgo import futures
>>> fut = futures.get('AFM4')
>>> info = fut.info()
>>> print(info)

# Получение метрик `TradeStat` по заданным параметрам (по другим статистикам аналогично)
>>> from moexalgo import futures
>>> fut = futures.get('AFM4')
>>> tradestats = fut.tradestats(start='2021-01-01', end='2021-01-10')
>>> print(tradestats)
hi2(*, start: str | date, end: str | date, latest: bool | None = None, offset: int | None = None, cs: Session | None = None, use_dataframe: bool = True) → iter | DataFrame

Возвращает метрики Hi2 (индекс рыночной концентрации) по заданным параметрам. Чтобы узнать больше о метрике Hi2, посетите страницу: https://moexalgo.github.io/des/hi2/

Параметры:

  • start (Union[str, date]) – Дата начала диапазона выдачи данных. (start может быть равен end, тогда вернутся записи за один день)

  • end (Union[str, date]) – Дата конца диапазона выдачи данных.

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

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

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

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

Результат:

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

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

Union[iter, pd.DataFrame]

info(*fields: tuple[str], use_dataframe: bool = True) → dict | DataFrame

Возвращает информацию об инструменте.

Параметры:

  • fields (str) – Поля для отображения.

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

Результат:

return – Информация об инструменте

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

Union[dict, pd.DataFrame]

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

Возвращает метрики ObStat (статистику по стакану) по заданным параметрам. Больше информации о метрике ObStat можно найти на странице: https://moexalgo.github.io/des/supercandles/#obstats_1

Параметры:

  • start (Union[str, date]) – Дата начала диапазона выдачи данных. (start может быть равен end, тогда вернутся записи за один день)

  • end (Union[str, date]) – Дата конца диапазона выдачи данных.

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

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

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

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

Результат:

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

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

Union[iter, pd.DataFrame]

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

Возвращает метрики TradeStat (статистику по сделкам) по заданным параметрам. Больше информации о метрике TradeStat можно найти на странице: https://moexalgo.github.io/des/supercandles/#tradestats_1

Параметры:

  • start (Union[str, date]) – Дата начала диапазона выдачи данных. (start может быть равен end, тогда вернутся записи за один день)

  • end (Union[str, date]) – Дата конца диапазона выдачи данных.

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

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

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

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

Результат:

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

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

Union[iter, pd.DataFrame]

moexalgo.futures.get(name: str) → Futures

Получение фьючерсного инструмента.

Параметры:

name (str) – Наименование фьючерсного инструмента.

Результат:

return – Фьючерсный инструмент.

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

Futures

Пример

# Получение фьючерсного инструмента
>>> from moexalgo import futures
>>> fut = futures.get('AFM4')
>>> info = fut.info()
>>> print(info)