1
0
fin-defs/fin_defs/__init__.py

518 lines
17 KiB
Python
Raw Normal View History

2024-07-08 17:02:28 +00:00
"""# Finance Definitions.
Python library defining base types for financial processing.
Defines a base `Asset` type, and various subtypes, for universal representation
of these assets.
Defined hierarchy:
* `Asset`
- `Currency`
+ `FiatCurrency`
+ `CryptoCurrency`
- `Stock`
- `Index`
- `Commodity`
2024-07-08 17:02:28 +00:00
"""
2024-05-27 21:03:16 +00:00
import dataclasses
import datetime
import re
from decimal import Decimal
2024-08-08 16:07:34 +00:00
import abc
2024-05-27 21:03:16 +00:00
import enforce_typing
2024-07-17 19:59:20 +00:00
from ._version import __version__ # noqa: F401
2024-05-27 21:03:16 +00:00
## Ids
RE_TICKER_FORMAT = r'^[A-Z0-9_]+$'
2024-06-04 20:19:54 +00:00
RE_TICKER_FORMAT_FLEXIBLE = r'^[^:\s](?:[^:]*[^:\s])?$'
2024-05-27 21:03:16 +00:00
RE_CRYPTO_TICKER_FORMAT = r'^\S+$'
@enforce_typing.enforce_types
@dataclasses.dataclass(frozen=True)
class StockExchange:
"""Unified Stock Exchange identifiers.
Fields:
- `name`: Human-readable name.
- `mic`: Official MIC identifier.
- `bloomberg_id`: Identifier for lookup on Bloomberg.
- `crunchbase_id`: Identifier for lookup on Crunchbase.
- `yahoo_id`: Identifier for lookup on Yahoo! Finance.
- `eod_id`: Identifier for lookup on EOD.
"""
2024-05-27 21:03:16 +00:00
name: str
mic: str
bloomberg_id: str | None = None
crunchbase_id: str | None = None
yahoo_id: str | None = None
eod_id: str | None = None
@enforce_typing.enforce_types
@dataclasses.dataclass(frozen=True)
class Asset:
2024-05-27 21:32:55 +00:00
"""An identifier representing some abstract financial asset.
Subtypes represent the various asset types in existence, for example fiat
currencies, stocks or even crypto currencies.
"""
2024-05-27 21:03:16 +00:00
def names(self) -> list[str]:
"""Returns a list of human readable names for this `Asset`."""
2024-05-27 21:03:16 +00:00
return COMMON_NAMES.get(self, [])
def to_polygon_id(self) -> str:
2024-08-02 03:42:19 +00:00
"""Formats this asset to the [`polygon.io`](https://polygon.io)
identifier format.
Inverse of `from_polygon_id`.
"""
2024-05-27 21:03:16 +00:00
# TODO: Support currency pairs not involving USD.
if isinstance(self, Stock):
return f'{self.ticker}'
if isinstance(self, Index):
return f'I:{self.ticker}'
if isinstance(self, FiatCurrency):
return f'C:{self.iso_code}USD'
if isinstance(self, CryptoCurrency):
return f'X:{self.ccxt_symbol}USD'
# Else
msg = f'Unknown self type: {self}'
raise Exception(msg)
@staticmethod
def from_polygon_id(polygon_id: str) -> 'Asset':
2024-08-02 03:42:19 +00:00
"""Parses an asset from the [`polygon.io`](https://polygon.io)
identifier format.
Inverse of `to_polygon_id`.
"""
2024-05-27 21:03:16 +00:00
if polygon_id.startswith('I:'):
return Index(polygon_id.removeprefix('I:'))
if polygon_id.startswith('X:'):
return CryptoCurrency(
polygon_id.removeprefix('X:').removesuffix('USD'),
None,
)
if polygon_id.startswith('C:'):
return FiatCurrency(polygon_id.removeprefix('C:').removesuffix('USD'))
return Stock.from_polygon_id(polygon_id)
2024-08-08 16:07:34 +00:00
@abc.abstractmethod
def raw_short_name(self) -> str:
"""A short name or ticker that does not nessisarily uniquely identify
the asset, but may be commonly used within the industry."""
2024-08-02 03:42:19 +00:00
def to_string_id(self) -> str:
"""Formats the asset id using the fin_defs asset format."""
if isinstance(self, Stock):
return f'stock:{self.ticker}.{self.exchange.mic}'
2024-08-02 03:42:19 +00:00
if isinstance(self, FiatCurrency):
return f'fiat:{self.iso_code}'
2024-08-02 03:42:19 +00:00
if isinstance(self, CryptoCurrency):
return f'crypto:{self.ccxt_symbol}'
2024-08-02 03:42:19 +00:00
if isinstance(self, Index):
return f'index:{self.ticker}'
if isinstance(self, Commodity):
return f'commodity:{self.alpha_vantage_id}'
2024-08-02 03:42:19 +00:00
raise NotImplementedError('Unsupported asset type: ' + str(self))
@staticmethod
def from_string_id(asset_id: str) -> 'Asset':
"""Parses an `Asset` using the fin_defs asset format."""
if ':' in asset_id:
prefix, ticker = asset_id.split(':')
else:
prefix, ticker = None, asset_id
if known_symbol := WELL_KNOWN_SYMBOLS.get(ticker, None):
return known_symbol
if prefix == 'stock':
if m := re.match(r'^(\w+)(?:\.(\w+))?$', ticker):
exchange = EXCHANGES_BY_IDS[m.group(2) or 'NYSE'] # TODO?
return Stock(m.group(1), exchange)
if prefix == 'currency':
return FiatCurrency(ticker)
if prefix == 'fiat':
return FiatCurrency(ticker)
if prefix == 'index':
return Index(ticker)
if prefix == 'crypto':
return CryptoCurrency(ticker, None) # TODO
msg = f'Unsupported asset format: {asset_id}'
raise NotImplementedError(msg)
def __str__(self):
return self.to_string_id()
2024-05-27 21:03:16 +00:00
@enforce_typing.enforce_types
@dataclasses.dataclass(frozen=True)
class Currency(Asset):
pass
@enforce_typing.enforce_types
@dataclasses.dataclass(frozen=True, eq=True, order=True)
class FiatCurrency(Currency):
iso_code: str
def __post_init__(self):
if not re.match(RE_TICKER_FORMAT, self.iso_code):
msg = f'iso_code was not in correct format: {self.iso_code}'
raise ValueError(msg)
2024-08-08 16:07:34 +00:00
def raw_short_name(self) -> str:
return self.iso_code
2024-05-27 21:03:16 +00:00
@enforce_typing.enforce_types
@dataclasses.dataclass(frozen=True, eq=True)
class CryptoCurrency(Currency):
ccxt_symbol: str
coingecko_id: str | None
def __post_init__(self):
2024-07-08 17:02:44 +00:00
"""TODO
2024-05-27 21:03:16 +00:00
if not re.match(RE_CRYPTO_TICKER_FORMAT, self.ccxt_symbol):
msg = f'ccxt_symbol was not in correct format: {self.ccxt_symbol}'
raise ValueError(msg)
2024-07-08 17:02:44 +00:00
"""
2024-05-27 21:03:16 +00:00
2024-08-08 16:07:34 +00:00
def raw_short_name(self) -> str:
return self.ccxt_symbol
2024-05-27 21:03:16 +00:00
@enforce_typing.enforce_types
@dataclasses.dataclass(frozen=True, eq=True)
class Stock(Asset):
ticker: str
exchange: StockExchange
2024-07-29 14:32:56 +00:00
nordnet_id: int | None = None
2024-05-27 21:03:16 +00:00
def __post_init__(self):
if not re.match(RE_TICKER_FORMAT_FLEXIBLE, self.ticker):
msg = f'ticker was not in correct format: {self.ticker}'
raise ValueError(msg)
@staticmethod
def from_polygon_id(polygon_id: str, stock_exchange: StockExchange) -> 'Stock':
return Stock(polygon_id, stock_exchange)
2024-08-08 16:07:34 +00:00
def raw_short_name(self) -> str:
return self.ticker
2024-05-27 21:03:16 +00:00
@enforce_typing.enforce_types
@dataclasses.dataclass(frozen=True, eq=True)
class Index(Asset):
ticker: str
def __post_init__(self):
if not re.match(RE_TICKER_FORMAT_FLEXIBLE, self.ticker):
msg = f'ticker was not in correct format: {self.ticker}'
raise ValueError(msg)
2024-08-08 16:07:34 +00:00
def raw_short_name(self) -> str:
return self.ticker
2024-05-27 21:03:16 +00:00
@enforce_typing.enforce_types
@dataclasses.dataclass(frozen=True, eq=True)
class Commodity(Asset):
alpha_vantage_id: str
def __post_init__(self):
if not re.match(RE_TICKER_FORMAT, self.alpha_vantage_id):
msg = f'alpha_vantage_id was not in correct format: {self.alpha_vantage_id}'
raise ValueError(msg)
2024-08-08 16:07:34 +00:00
def raw_short_name(self) -> str:
return self.alpha_vantage_id # TODO
2024-05-27 21:03:16 +00:00
Commodity.CRUDE_OIL_WTI = Commodity('WTI')
Commodity.CRUDE_OIL_BRENT = Commodity('BRENT')
Commodity.NATURAL_GAS = Commodity('NATURAL_GAS')
Commodity.COPPER = Commodity('COPPER')
Commodity.WHEAT = Commodity('WHEAT')
Commodity.CORN = Commodity('CORN')
Commodity.COTTON = Commodity('COTTON')
Commodity.SUGAR = Commodity('SUGAR')
Commodity.COFFEE = Commodity('COFFEE')
# Well known
DKK = FiatCurrency('DKK')
USD = FiatCurrency('USD')
EUR = FiatCurrency('EUR')
BTC = CryptoCurrency('BTC', coingecko_id='bitcoin')
MPC = CryptoCurrency('MPC', coingecko_id='partisia-blockchain')
SPX = Index('SPX')
NDX = Index('NDX')
USDT = CryptoCurrency('USDT', coingecko_id='tether')
2024-05-27 21:03:16 +00:00
COMMON_NAMES: dict[Asset, list[str]] = {
FiatCurrency('USD'): ['U.S. Dollar'],
FiatCurrency('DKK'): ['Danske Kroner', 'Danish Crowns'],
FiatCurrency('EUR'): ['Euro'],
FiatCurrency('JPY'): ['Japanese Yen'],
FiatCurrency('CAD'): ['Canadian Dollar'],
FiatCurrency('GBP'): ['British Pound'],
FiatCurrency('CNY'): ['Renminbi'],
FiatCurrency('PLN'): ['Polish Zloty'],
FiatCurrency('ILS'): ['Israeli new Shekel'],
FiatCurrency('CHF'): ['Swiss Franc'],
FiatCurrency('ZAR'): ['South African Rand'],
FiatCurrency('CZK'): ['Czech Koruna'],
SPX: ['Standard and Poor 500', 'S&P 500'],
NDX: ['Nasdaq 100'],
BTC: ['Bitcoin BTC'],
MPC: ['Partisia Blockchain MPC Token'],
CryptoCurrency('ETH', coingecko_id='ethereum'): ['Ethereum Ether'],
CryptoCurrency('DOGE', coingecko_id='dogecoin'): ['Dogecoin'],
CryptoCurrency('SOL', coingecko_id='solana'): ['Solana SOL'],
CryptoCurrency('ADA', coingecko_id='cardano'): ['Cardano ADA'],
CryptoCurrency('BNB', coingecko_id='bnb'): ['Binance BNB'],
CryptoCurrency('MATIC', coingecko_id='polygon'): ['Polygon MATIC'],
2024-05-27 21:03:16 +00:00
# Stable-coins
CryptoCurrency('DAI', coingecko_id='dai'): ['DAI'],
CryptoCurrency('USDC', coingecko_id='usdc'): ['USD Coin'],
2024-07-17 20:16:30 +00:00
USDT: ['Tether USDT'],
2024-05-27 21:03:16 +00:00
}
WELL_KNOWN_SYMBOLS = (
{
sym: FiatCurrency(sym)
for sym in [
'USD',
'DKK',
'EUR',
'JPY',
'CAD',
'GBP',
'CNY',
'PLN',
'ILS',
'CHF',
'ZAR',
'CZK',
]
}
2024-07-08 17:02:44 +00:00
| {'XXBT': BTC}
2024-08-08 16:07:34 +00:00
| {k.raw_short_name(): k for k in COMMON_NAMES}
2024-05-27 21:03:16 +00:00
| {'SPX500': SPX, 'SP500': SPX, 'Nasdaq 100': NDX}
)
NYSE = StockExchange(
name='New York Stock Exchange',
mic='XNYS',
bloomberg_id='UN',
crunchbase_id='NYSE',
)
EXCHANGES = [
NYSE,
StockExchange(name='Nasdaq', mic='XNAS', bloomberg_id='US', crunchbase_id='NASDAQ'),
StockExchange(
name='Hong Kong Exchanges And Clearing',
mic='XHKG',
bloomberg_id='HK',
crunchbase_id='SEHK',
),
StockExchange(
name='Moscow Exchange',
mic='MISC',
bloomberg_id='RX',
yahoo_id='ME',
eod_id='MCX',
crunchbase_id='MOEX',
),
StockExchange(name='Shanghai Stock Exchange', mic='XSHG'),
StockExchange(name='Euronext Amsterdam', mic='XAMS'),
StockExchange(name='Euronext Brussels', mic='XBRU'),
StockExchange(name='Euronext Dublin', mic='XMSM'),
StockExchange(name='Euronext Lisbon', mic='XLIS'),
StockExchange(name='Euronext Milan', mic='XMIL'),
StockExchange(name='Euronext Oslo', mic='XOSL'),
StockExchange(name='Euronext Paris', mic='XPAR'),
StockExchange(name='Japan Exchange Group', mic='XJPX'),
StockExchange(name='Shenzhen Stock Exchange', mic='XSHE'),
StockExchange(name='Indian National Stock Exchange', mic='XNSE'),
StockExchange(
name='Bombay Stock Exchange',
mic='XBOM',
bloomberg_id='IB',
crunchbase_id='BOM',
yahoo_id='BO',
),
StockExchange(name='Toronto Stock Exchange', mic='XTSE'),
StockExchange(name='London Stock Exchange', mic='XLON'),
StockExchange(name='Saudi Stock Exchange', mic='XSAU'),
StockExchange(name='German Stock Exchange', mic='XFRA'),
StockExchange(name='SIX Swiss Exchange', mic='XSWX'),
StockExchange(name='Nasdaq Copenhagen Stock Exchange', mic='XCSE'),
StockExchange(name='Nasdaq Stockholm Stock Exchange', mic='XSTO'),
StockExchange(name='Nasdaq Helsinki Stock Exchange', mic='XHEL'),
StockExchange(name='Nasdaq Tallinn Stock Exchange', mic='XTAL'),
StockExchange(name='Nasdaq Riga Stock Exchange', mic='XRIS'),
StockExchange(name='Nasdaq Vilnius Stock Exchange', mic='XLIT'),
StockExchange(name='Nasdaq Iceland Stock Exchange', mic='XICE'),
StockExchange(name='Korea Exchange', mic='XKOS'),
StockExchange(name='Taiwan Stock Exchange', mic='XTAI'),
StockExchange(name='Australian Securities Exchange', mic='XASX'),
StockExchange(name='Johannesburg Stock Exchange', mic='XJSE'),
StockExchange(name='Tehran Stock Exchange', mic='XTEH'),
2024-07-08 17:02:44 +00:00
StockExchange(name='Over The Counter (Unlisted)', mic='OTC'), # TODO: Unofficial
2024-06-13 22:32:54 +00:00
StockExchange(name='NYSE Arca', mic='ARCX'),
StockExchange(name='BATS Global Markets', mic='BATS'),
StockExchange(name='NYSE American', mic='XASE'),
2024-07-18 23:15:32 +00:00
StockExchange(name='Xetra (Frankfurt Stock Exchange)', mic='XETR'),
2024-05-27 21:03:16 +00:00
]
EXCHANGES_BY_IDS = {}
if True:
def add_by_id(exchange: StockExchange, key: str):
exchange_id = getattr(exchange, key)
if exchange_id is not None:
if exchange_id in EXCHANGES_BY_IDS:
msg = f'Exchange {exchange_id} is already present'
raise ValueError(msg)
EXCHANGES_BY_IDS[exchange_id] = exchange
for exchange in EXCHANGES:
add_by_id(exchange, 'mic')
add_by_id(exchange, 'bloomberg_id')
add_by_id(exchange, 'crunchbase_id')
add_by_id(exchange, 'yahoo_id')
add_by_id(exchange, 'eod_id')
del exchange
del add_by_id
@enforce_typing.enforce_types
@dataclasses.dataclass(frozen=True, slots=True)
class AssetInformation:
"""Extensive information about a given asset."""
asset: Asset
full_name: str
description: str | None = None
asset_base: Asset | None = None
sec_cik: str | None = None
# TODO: FIGI types? (https://www.openfigi.com/)
@enforce_typing.enforce_types
@dataclasses.dataclass(frozen=True, eq=True, slots=True)
class AssetAmount:
"""Decimal with associated asset unit.
Fields:
- `asset`: Asset unit of amount.
- `amount`: Amount of given asset.
"""
2024-05-27 21:03:16 +00:00
asset: Asset
amount: Decimal
def __str__(self):
specificity = '2' if self.amount >= 0.10 else '3'
return ('{:.' + specificity + 'f} {}').format(self.amount, self.asset)
def __mul__(self, other: Decimal):
if not isinstance(other, Decimal):
msg = f'other must be decimal, but was {type(other)}'
raise TypeError(msg)
return AssetAmount(self.asset, self.amount * other)
def __add__(self, other):
if not isinstance(other, AssetAmount):
msg = f'other must be AssetAmount, but was {type(other)}'
raise TypeError(msg)
if self.asset != other.asset:
msg = (
f'AssetAmount must have same asset, but: {self.asset} != {other.asset}'
)
raise ValueError(msg)
return AssetAmount(self.asset, self.amount + other.amount)
def __sub__(self, other):
if not isinstance(other, AssetAmount):
msg = f'other must be AssetAmount, but was {type(other)}'
raise TypeError(msg)
if self.asset != other.asset:
msg = (
f'AssetAmount must have same asset, but: {self.asset} != {other.asset}'
)
raise ValueError(msg)
return AssetAmount(self.asset, self.amount - other.amount)
def __truediv__(self, other):
if isinstance(other, AssetAmount):
if self.asset != other.asset:
msg = f'AssetAmount must have same asset, but: {self.asset} != {other.asset}'
raise ValueError(msg)
return self.amount / other.amount
return AssetAmount(self.asset, self.amount / other)
def __lt__(self, other):
if not isinstance(other, AssetAmount):
msg = f'other must be AssetAmount, but was {type(other)}'
raise TypeError(msg)
if self.asset != other.asset:
msg = (
f'AssetAmount must have same asset, but: {self.asset} != {other.asset}'
)
raise ValueError(msg)
return self.amount < other.amount
@dataclasses.dataclass(frozen=True, eq=True)
class ExchangeRateSample(Asset):
"""Single exchange rate sample with a timestamp and various stats."""
timestamp: datetime.date | datetime.datetime
base_asset: Asset
2024-05-27 21:03:16 +00:00
_average: Decimal | None = None
last: Decimal | None = None
open: Decimal | None = None
close: Decimal | None = None
high: Decimal | None = None
low: Decimal | None = None
volume: Decimal | None = None
market_cap: Decimal | None = None
@property
def average(self) -> Decimal:
if self._average:
return self._average
return (self.high + self.low) / 2
def replace_timestamp(self, timestamp):
return dataclasses.replace(self, timestamp=timestamp)
def invert_exchange_rate(self):
one = Decimal('1')
return dataclasses.replace(
self,
_average=one / self._average if self._average else None,
last=one / self.last if self.last else None,
open=one / self.open if self.open else None,
close=one / self.close if self.close else None,
high=one / self.low if self.low else None,
low=one / self.high if self.high else None,
# TODO: Support volume
# TODO: Support market_cap
)