Модуль moexalgo.tickers

class moexalgo.tickers._Ticker(secid: str, boardid: str | None = None)

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

Базовый класс для работы с инструментами.

_PATH

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

Type:: str

_secid

Идентификатор инструмента.

Type:: str

_boardid

Идентификатор рынка.

Type:: str

_r_market

Ссылка на объект рынка.

Type:: weakref.ref

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

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

candles : Callable: Возвращает итератор свечей инструмента по заданным параметрам.

orderbook : Callable: Возвращает текущий стакан лучших цен.

Пример

# Получение информации об акции
>>> from moexalgo import tickers
>>> ticker = tickers.get('SBER')

>>> print(ticker)

# Получение информации об инструменте
>>> info = ticker.info()
>>> print(info)

    # Получение рыночной информации и статистики об инструменте
>>> marketdata = ticker.marketdata()
>>> print(marketdata)

    # Получение свечей инструмента по заданным параметрам
>>> candles = ticker.candles(start='2021-01-01', end='2021-01-10')
>>> for candle in candles:
...     print(candle)

    # Получение текущего стакана лучших цен
>>> orderbook = ticker.orderbook()
>>> print(orderbook)

property _market: Market

Раздел рынка в который входит инструмент.

Результат:: Раздел рынка.
Тип результата:: Market

Возвращает итератор свечей инструмента по заданным параметрам.

Параметры:

start (Union[str, date]) – Дата начала диапазона выдачи данных. (start может быть равен end, тогда вернутся записи за один день)
end (Union[str, date]) – Дата конца диапазона выдачи данных.
period (Union[str, int, CandlePeriod], optional) –
Период свечи, by default None.

Если int, то интерпретируется в следующем формате: - 1 - 1 минута - 10 - 10 минут - 60 - 1 час - 24 - 1 день - 7 - 1 неделя - 31 - 1 месяц

Если str, то интерпретируется в следующем формате: - „1min“ - 1 минута - „10min“ - 10 минут - „1h“ - 1 час - „1d“ - 1 день - „1w“ - 1 неделя - „1m“ - 1 месяц
offset (int, optional) – Начальная позиция в последовательности записей, by default 0.
cs (Session, optional) – Клиентская сессия, если используется, by default None.
latest (bool, optional) – Включает режим выдачи последних latest записей в наборе, by default False.
use_dataframe (bool, optional) – Изменяет тип возвращаемого объекта, by default True. Если True, то возвращает pd.DataFrame, иначе итератор.

Результат:

return – Итератор свечей.

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

Union[iter[Candle], pd.DataFrame]

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

Возвращает информацию об инструменте, словарь или pd.DataFrame

Параметры:

fields (tuple[str]) – Поля для отображения
use_dataframe (bool) – Изменяет тип возвращаемого объекта, by default True. Если True, то возвращает pd.DataFrame, иначе словарь.

Результат:

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

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

Union[dict, pd.DataFrame]

marketdata(*fields, use_dataframe: bool = True) → dict | DataFrame

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

Параметры:

fields (tuple[str]) – Поля для отображения
use_dataframe (bool) – Изменяет тип возвращаемого объекта, by default True. Если True, то возвращает pd.DataFrame, иначе словарь.

Результат:

return – Рыночная информация и статистика об инструменте.

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

Union[dict, pd.DataFrame]

orderbook(cs: Session | None = None, use_dataframe: bool = True) → iter | DataFrame

Возвращает текущий стакан лучших цен.

Параметры:

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

Результат:

return – Стакан лучших цен.

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

Union[iter, pd.DataFrame]