oxtapus 0.4.1__py3-none-any.whl

oxtapus/__init__.py

@@ -0,0 +1,6 @@
+from oxtapus.fipiran import Fipiran
+from oxtapus.rahavard import Rahavard
+from oxtapus.tgju import TGJU
+from oxtapus.tsetmc import TSETMC
+
+__all__ = ["TSETMC", "Rahavard", "TGJU", "Fipiran"]

oxtapus/fipiran.py

@@ -0,0 +1,36 @@
+import polars as pl
+
+from oxtapus.models.fipiran import DependencyGraph
+from oxtapus.utils.http import get
+from oxtapus.utils.normalize import normalize_nested_dict
+
+
+class Fipiran:
+    def __init__(self) -> None:
+        pass
+
+    def funds(self) -> pl.DataFrame:
+        """
+        .. raw:: html
+
+            <div dir="rtl">
+                ی سری داده‌یِ از صندوق‌هایِ سرمایه-گذاری رو بهت می‌ده.
+            </div>
+        """
+        url = "https://fund.fipiran.ir/api/v1/fund/dependencygraph"
+        r = get(url)
+        items = list(filter(lambda x: self._is_gt(x["netAsset"], 0.0), r[0]["items"]))
+        validated_r = DependencyGraph.model_validate({"items": items})
+        norm_r = normalize_nested_dict(
+            [i.model_dump() for i in validated_r.items], "manager"
+        )
+        return pl.DataFrame(norm_r)
+
+    def _is_gt(self, x, t: float) -> bool:
+        try:
+            number = float(x)
+            if number > t:
+                return True
+            return False
+        except Exception:
+            return False

oxtapus/models/fipiran.py

@@ -0,0 +1,55 @@
+import datetime as dt
+from typing import Optional
+
+from pydantic import BaseModel, Field, field_validator
+
+
+class Manager(BaseModel):
+    address: Optional[str]
+    ceo: Optional[str]
+    cfi_id: Optional[int] = Field(alias="cfiId")
+    cfiLast_modification_datetime: Optional[str] = Field(
+        alias="cfiLastModificationTime"
+    )
+    is_completed: bool = Field(alias="isCompleted")
+    manager_id: Optional[int] = Field(alias="managerId")
+    manager_national_no: Optional[str] = Field(alias="managerNationalCode")
+    manager_seo_register_no: Optional[str] = Field(alias="managerSeoRegisterNo")
+    name: Optional[str]
+    national_id: Optional[str] = Field(alias="nationalId")
+    register_date: Optional[str] = Field(alias="registerDate")
+    register_place: Optional[str] = Field(alias="registerPlace")
+    register_place_id: Optional[str] = Field(alias="registerPlaceId")
+    registered_capital: Optional[int] = Field(alias="registeredCapital")
+    registration_number: Optional[str] = Field(alias="registrationNumber")
+    seoRegisterDate: Optional[str] = Field("seo_register_date")
+    tel: Optional[str]
+    type: Optional[int]
+    web_site: Optional[str] = Field(alias="webSite")
+
+
+class FundItem(BaseModel):
+    date: dt.date
+    initiation_date: dt.date = Field(alias="initiationDate")
+    name: str
+    temp_guarantor_name: Optional[str] = Field(alias="tempGuarantorName")
+    temp_manager_name: str = Field(alias="tempManagerName")
+    type_of_invest: str = Field(alias="typeOfInvest")
+    fund_type: int = Field(alias="fundType")
+    manager: Manager
+    dividend_interval_period: Optional[int] = Field(alias="dividendIntervalPeriod")
+    # guarantor: Optional[str]
+    fund_size: Optional[int] = Field(alias="fundSize")
+    net_asset: Optional[int] = Field(alias="netAsset")
+    reg_no: str = Field(alias="regNo")
+    issue_nav: Optional[int] = Field(alias="issueNav")
+    statistical_nav: Optional[int] = Field(alias="statisticalNav")
+    cancel_nav: Optional[int] = Field(alias="cancelNav")
+
+    @field_validator("date", mode="before")
+    def parse_date(cls, value):
+        return dt.datetime.fromisoformat(str(value)).date()
+
+
+class DependencyGraph(BaseModel):
+    items: list[FundItem]

oxtapus/models/rahavard.py

@@ -0,0 +1,109 @@
+import datetime as dt
+from typing import Optional
+
+from pydantic import BaseModel, field_validator
+
+__all__ = ["Stocks", "BalanceSheet", "IncomeStatements", "CashFlow"]
+
+
+class FSField(BaseModel):
+    title: str
+    english_title: str
+    account: Optional[str] = "-"
+    is_parent: bool
+    parent: Optional[str]
+    index_view: int
+    id: str
+    sign_neg: bool
+    sign_pos: bool
+    neg_nature: bool
+
+
+class FSItems(BaseModel):
+    field: FSField
+    value: float
+
+
+class FinancialViewType(BaseModel):
+    id: str
+
+
+class BalanceSheetData(BaseModel):
+    date: dt.date
+    fiscal_year: dt.date
+    announcement_type: str
+    financial_view_type: FinancialViewType
+    report_id: str
+    id: str
+    items: list[FSItems]
+
+    @field_validator("date", "fiscal_year", mode="before")
+    def parse_date(cls, value):
+        return dt.datetime.strptime(
+            str(value),
+            "%Y-%m-%dT%H:%M:%S%z",
+        ).date()
+
+
+class BalanceSheet(BaseModel):
+    data: list[BalanceSheetData]
+
+
+class IncomeStatementsData(BaseModel):
+    date: dt.date
+    fiscal_year: dt.date
+    announcement_type_id: str
+    financial_view_type_id: str
+    report_id: str
+    capital: int
+    id: str
+    items: list[FSItems]
+
+    @field_validator("date", "fiscal_year", mode="before")
+    def parse_date(cls, value):
+        return dt.datetime.strptime(
+            str(value),
+            "%Y-%m-%dT%H:%M:%S%z",
+        ).date()
+
+
+class IncomeStatements(BaseModel):
+    data: list[IncomeStatementsData]
+
+
+class CashFlowField(BaseModel):
+    title: str
+    english_title: str
+    account: Optional[str] = "-"
+    is_parent: bool
+    index_view: int
+    id: str
+
+
+class CashFlowItems(BaseModel):
+    field: CashFlowField
+    value: float
+
+
+class CashFlowData(BaseModel):
+    date: dt.date
+    fiscal_year: dt.date
+    announcement_type_id: str
+    financial_view_type_id: str
+    report_id: str
+    id: str
+    items: list[CashFlowItems]
+
+
+class CashFlow(BaseModel):
+    data: list[CashFlowData]
+
+
+class StocksData(BaseModel):
+    name: str
+    asset_id: str
+    exchange_id: str
+
+
+class Stocks(BaseModel):
+    data: list[StocksData]

oxtapus/models/tsetmc.py

@@ -0,0 +1,165 @@
+import datetime as dt
+from typing import Optional
+
+from pydantic import BaseModel, Field, field_validator, model_validator
+from pydantic.v1.utils import GetterDict
+
+
+class MarketWatchOrderBook(BaseModel):
+    ob_level: int = Field(alias="n")
+    bid_count: int = Field(alias="zmd")
+    bid_size: float = Field(alias="qmd")
+    bid_price: float = Field(alias="pmd")
+    ask_price: float = Field(alias="pmo")
+    ask_size: float = Field(alias="qmo")
+    ask_count: int = Field(alias="zmo")
+
+
+class ClientTypeAll(BaseModel):
+    ins_code: str = Field(alias="insCode")
+    buy_vol_ind: float = Field(alias="buy_I_Volume")
+    buy_vol_ins: float = Field(alias="buy_N_Volume")
+    buy_count_ind: int = Field(alias="buy_CountI")
+    buy_count_ins: int = Field(alias="buy_CountN")
+    sell_vol_ind: float = Field(alias="sell_I_Volume")
+    sell_vol_ins: float = Field(alias="sell_N_Volume")
+    sell_count_ind: int = Field(alias="sell_CountI")
+    sell_count_ins: int = Field(alias="sell_CountN")
+
+
+class MarketWatch(BaseModel):
+    ins_code: str = Field(alias="insCode")
+    ins_id: str = Field(alias="insID")
+    symbol: str = Field(alias="lva")
+    name: str = Field(alias="lvc")
+    eps: float = Field(alias="eps")
+    pe: float = Field(alias="pe")
+    bid: float = Field(alias="pmd")  #
+    ask: float = Field(alias="pmo")  #
+    open: float = Field(alias="pf")
+    high: float = Field(alias="pmx")
+    low: float = Field(alias="pmn")
+    close: float = Field(alias="pdv")
+    final: float = Field(alias="pcl")
+    y_final: float = Field(alias="py")
+    value: float = Field(alias="qtc")
+    volume: float = Field(alias="qtj")
+    trade_count: float = Field(alias="ztt")
+    max_lim: float = Field(alias="pMax")
+    min_lim: float = Field(alias="pMin")
+    capital: float = Field(alias="ztd")
+    base_volume: float = Field(alias="bv")
+    event_time: float = Field(alias="hEven")
+    order_book: list[MarketWatchOrderBook] = Field(alias="blDs")
+
+    @field_validator("pe", mode="before")
+    def parce_pe(cls, value):
+        try:
+            return float(value)
+        except ValueError:
+            return 0.0
+        except TypeError:
+            return 0.0
+
+
+class HistPrice(BaseModel):
+    date: dt.date = Field(alias="dEven")
+    ins_code: str = Field(alias="insCode")
+    open: float = Field(alias="priceFirst")
+    high: float = Field(alias="priceMax")
+    low: float = Field(alias="priceMin")
+    close: float = Field(alias="pDrCotVal")
+    final: float = Field(alias="pClosing")
+    y_final: float = Field(alias="priceYesterday")
+    volume: float = Field(alias="qTotTran5J")
+    value: float = Field(alias="qTotCap")
+    trade_count: float = Field(alias="zTotTran")
+
+    @field_validator("date", mode="before")
+    def parse_date(cls, value):
+        return dt.datetime.strptime(str(value), "%Y%m%d").date()
+
+
+class EPS(BaseModel):
+    eps: Optional[float] = Field(alias="estimatedEPS")
+    sector_pe: Optional[float] = Field(alias="sectorPE")
+
+
+class Sector(BaseModel):
+    code: str = Field(alias="cSecVal")
+    name: str = Field(alias="lSecVal")
+
+
+class StaticThreshold(BaseModel):
+    min_threshold: float = Field(alias="psGelStaMin")
+    max_threshold: float = Field(alias="psGelStaMax")
+
+
+class InsInfo(BaseModel):
+    ins_code: str = Field(alias="insCode")
+    ins_id: str = Field(alias="instrumentID")
+    isin: str = Field(alias="cIsin")
+    symbol: str = Field(alias="lVal18AFC")
+    name: str = Field(alias="lVal30")
+    name_en: str = Field(alias="lVal18")
+    eps: Optional[float]
+    sector_pe: Optional[float]
+    static_threshold: StaticThreshold = Field(alias="staticThreshold")
+    min_week: float = Field(alias="minWeek")
+    max_week: float = Field(alias="maxWeek")
+    min_year: float = Field(alias="minYear")
+    max_year: float = Field(alias="maxYear")
+    mean_vol_monthly: float = Field(alias="qTotTran5JAvg")
+    pct_float_shares: Optional[str] = Field(alias="kAjCapValCpsIdx")
+    base_vol: int = Field(alias="baseVol")
+    capital: float = Field(alias="zTitad")
+    contract_size: float = Field(alias="contractSize")
+    sector_code: str
+    sector_name: str
+    market_name: str = Field(alias="flowTitle")
+    market_code: int = Field(alias="flow")
+    market_type: str = Field(alias="cgrValCotTitle")
+    group_type: str = Field(alias="cgrValCot")
+
+    @model_validator(mode="before")
+    def flatten_eps_sector(cls, values: GetterDict):
+        eps = values.get("eps")
+        sector = values.get("sector")
+        eps = EPS.model_validate(eps)
+        sector = Sector.model_validate(sector)
+
+        result = {
+            "eps": eps.eps,
+            "sector_pe": eps.sector_pe,
+            "sector_code": sector.code,
+            "sector_name": sector.name,
+        }
+        values.pop("eps")
+        values.pop("sector")
+        result.update(values)
+        return result
+
+
+class SubSector(BaseModel):
+    id: int = Field(alias="cSoSecVal")
+    name: str = Field(alias="lSoSecVal")
+
+
+class InstrumentIdentity(BaseModel):
+    isin: str = Field(alias="cIsin")
+    instrument_id: str = Field(alias="instrumentID")
+    name: str = Field(alias="lSoc30")
+    symbol: str = Field(alias="lVal18AFC")
+    symbol30: str = Field(alias="lVal30")
+    sector: Sector
+    sub_sector: SubSector = Field(alias="subSector")
+
+
+class OrderBook(BaseModel):
+    ob_level: int = Field(alias="number")
+    bid_count: int = Field(alias="zOrdMeDem")
+    bid_volume: float = Field(alias="qTitMeDem")
+    bid_price: float = Field(alias="pMeDem")
+    ask_price: float = Field(alias="pMeOf")
+    ask_volume: float = Field(alias="qTitMeOf")
+    ask_count: int = Field(alias="zOrdMeOf")