Модуль moexalgo.currency

class moexalgo.currency.Currency(secid: str, boardid: str | None = None)

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

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

_PATH

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

Type:: str

_TYPE

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

Type:: str

_LIMIT

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

Type:: int

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

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

orderstats : Callable: Возвращает метрики OrderStat.

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

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

Пример

# Получение информации о валютном инструменте
>>> from moexalgo import currency
>>> cur = currency.get('USD000UTSTOM')
>>> info = cur.info()
>>> print(info)

# Получение метрик `TradeStat` по заданным параметрам (по другим статистикам аналогично)
>>> from moexalgo import currency
>>> cur = currency.get('USD000UTSTOM')
>>> tradestats = cur.tradestats(start='2021-01-01', end='2021-01-31')
>>> print(tradestats)

Возвращает метрики 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 (tuple[str]) – Поля для вывода.
use_dataframe (bool) – Изменяет тип возвращаемого объекта, by default True. Если True, то возвращает pd.DataFrame, иначе словарь.

Результат:

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

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

Union[dict, pd.DataFrame]

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

Параметры:

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 метрик ObStat.

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

Union[iter, pd.DataFrame]

Возвращает метрики OrderStat (статистику по заявкам) по заданным параметрам. Больше информации о метрике OrderStat можно найти на странице: https://moexalgo.github.io/des/supercandles/#orderstats_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 метрик OrderStat.

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

Union[iter, pd.DataFrame]

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

Параметры:

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.currency.get(name: str) → Currency

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

Параметры:: name (str) – Наименование инструмента.
Результат:: return – Валютный инструмент.
Тип результата:: Currency

Пример

# Получение валютного инструмента
>>> from moexalgo import currency
>>> usd = currency.get('USD000UTSTOM')
>>> info = usd.info()
>>> print(info)