algierex 1.0.0__py3-none-any.whl

algierex/__init__.py

@@ -0,0 +1,33 @@
+"""Python SDK for the Algierex market data API: the Algerian exchange's
+prices, sessions, Dzair index, OAT yield curve, exchange rates, company
+events and news.
+
+    from algierex import Algierex
+    client = Algierex()  # reads ALGIEREX_API_KEY
+    prices = client.get_prices("SAI", from_="2026-01-01")
+"""
+
+from ._client import Algierex
+from ._core import (
+    AlgierexError,
+    AuthenticationError,
+    BadRequestError,
+    NotFoundError,
+    PaymentRequiredError,
+    RateLimitError,
+    to_frame,
+)
+from ._types import *  # noqa: F401,F403  (response TypedDicts)
+
+__version__ = "1.0.0"
+
+__all__ = [
+    "Algierex",
+    "AlgierexError",
+    "AuthenticationError",
+    "BadRequestError",
+    "NotFoundError",
+    "PaymentRequiredError",
+    "RateLimitError",
+    "to_frame",
+]

algierex/_client.py

@@ -0,0 +1,167 @@
+"""The Algierex API client. Generated by sdk/generate.mjs from the OpenAPI spec. Do not edit; run `npm run sdk`."""
+
+from __future__ import annotations
+
+import urllib.parse
+from typing import Iterator, List, Literal, Optional
+
+from ._core import _Core
+from ._types import CalendarEvent, FxLatest, FxRow, IndexDay, NewsItem, PriceDay, Session, Ticker, YieldCurve
+
+
+def _quote(value: str) -> str:
+    return urllib.parse.quote(str(value), safe="")
+
+
+class Algierex(_Core):
+    """Client for the Algierex market data API (https://algierex.com/api/v1).
+
+    client = Algierex()  # reads ALGIEREX_API_KEY
+    prices = client.get_prices("SAI", from_="2026-01-01")
+    """
+
+    def list_tickers(self) -> List[Ticker]:
+        """List securities.
+
+        Every listed security with its names in English, French and Arabic,
+        sector, ISIN and capital facts.
+        """
+        return self._data("/tickers")
+
+    def get_prices(self, ticker: str, *, from_: Optional[str] = None, to: Optional[str] = None, page_size: Optional[int] = None) -> List[PriceDay]:
+        """Daily prices for one security.
+
+        One row per trading day, oldest first, across every market the security
+        has traded in. Several trade lines in one session (common for OATs) are
+        merged into one day: volumes add up and the last price is the close.
+
+        Args:
+            ticker: Symbol, for example SAI. Not case sensitive.
+            from_: First date to include (YYYY-MM-DD).
+            to: Last date to include (YYYY-MM-DD).
+            page_size: Rows per request, 1 to 1000 (default 1000). Paging is automatic.
+        """
+        return list(self.iter_prices(ticker, from_=from_, to=to, page_size=page_size))
+
+    def iter_prices(self, ticker: str, *, from_: Optional[str] = None, to: Optional[str] = None, page_size: Optional[int] = None) -> Iterator[PriceDay]:
+        """Like get_prices, but yields rows as pages arrive, for long histories."""
+        return self._pages(f"/prices/{_quote(ticker)}", {"from": from_, "to": to}, page_size)
+
+    def list_sessions(self, *, market: Optional[Literal["main", "bond", "sme", "oat"]] = None, from_: Optional[str] = None, to: Optional[str] = None, page_size: Optional[int] = None) -> List[Session]:
+        """Market sessions.
+
+        One market's sessions with their totals, oldest first. Premium and PI
+        securities trade in main market sessions.
+
+        Args:
+            market: main (equities), sme (growth market), bond (corporate bonds) or oat (Treasury bonds).
+            from_: First date to include (YYYY-MM-DD).
+            to: Last date to include (YYYY-MM-DD).
+            page_size: Rows per request, 1 to 1000 (default 1000). Paging is automatic.
+        """
+        return list(self.iter_sessions(market=market, from_=from_, to=to, page_size=page_size))
+
+    def iter_sessions(self, *, market: Optional[Literal["main", "bond", "sme", "oat"]] = None, from_: Optional[str] = None, to: Optional[str] = None, page_size: Optional[int] = None) -> Iterator[Session]:
+        """Like list_sessions, but yields rows as pages arrive, for long histories."""
+        return self._pages("/sessions", {"market": market, "from": from_, "to": to}, page_size)
+
+    def get_dzair_index(self, *, from_: Optional[str] = None, to: Optional[str] = None, page_size: Optional[int] = None) -> List[IndexDay]:
+        """Dzair index.
+
+        The Dzair index close for each session date, oldest first.
+
+        Args:
+            from_: First date to include (YYYY-MM-DD).
+            to: Last date to include (YYYY-MM-DD).
+            page_size: Rows per request, 1 to 1000 (default 1000). Paging is automatic.
+        """
+        return list(self.iter_dzair_index(from_=from_, to=to, page_size=page_size))
+
+    def iter_dzair_index(self, *, from_: Optional[str] = None, to: Optional[str] = None, page_size: Optional[int] = None) -> Iterator[IndexDay]:
+        """Like get_dzair_index, but yields rows as pages arrive, for long histories."""
+        return self._pages("/index/dzair", {"from": from_, "to": to}, page_size)
+
+    def get_yield_curve(self, *, date: Optional[str] = None) -> YieldCurve:
+        """OAT yield curve.
+
+        A Nelson-Siegel curve fitted to Algerian Treasury bonds (OATs) that
+        actually traded in the last 60 OAT sessions, with the bonds behind it.
+        Each bond counts at its most recent trade in that window, so a point can
+        be up to 60 sessions old. `fit` is null when fewer than five bonds
+        traded.
+
+        Args:
+            date: The curve as of the last OAT session on or before this date. Omit for the latest.
+        """
+        return self._data("/yield-curve", {"date": date})
+
+    def list_fx(self) -> List[FxLatest]:
+        """Latest exchange rates.
+
+        The latest rate per currency and source, in dinars per unit. `official`
+        is the Bank of Algeria rate; `exchangedz` is the parallel market.
+        """
+        return self._data("/fx")
+
+    def get_fx_history(self, code: str, *, source: Optional[Literal["official", "exchangedz"]] = None, from_: Optional[str] = None, to: Optional[str] = None, page_size: Optional[int] = None) -> List[FxRow]:
+        """Exchange rate history.
+
+        One currency's daily rates from one source, oldest first, in dinars per
+        unit. Official rates the upstream feed sent inverted are left out.
+
+        Args:
+            code: Currency code, for example USD or EUR.
+            source: official (Bank of Algeria) or exchangedz (parallel market).
+            from_: First date to include (YYYY-MM-DD).
+            to: Last date to include (YYYY-MM-DD).
+            page_size: Rows per request, 1 to 1000 (default 1000). Paging is automatic.
+        """
+        return list(self.iter_fx_history(code, source=source, from_=from_, to=to, page_size=page_size))
+
+    def iter_fx_history(self, code: str, *, source: Optional[Literal["official", "exchangedz"]] = None, from_: Optional[str] = None, to: Optional[str] = None, page_size: Optional[int] = None) -> Iterator[FxRow]:
+        """Like get_fx_history, but yields rows as pages arrive, for long histories."""
+        return self._pages(f"/fx/{_quote(code)}", {"source": source, "from": from_, "to": to}, page_size)
+
+    def get_calendar(self, *, from_: Optional[str] = None, to: Optional[str] = None, ticker: Optional[str] = None, locale: Optional[Literal["en", "fr", "ar"]] = None, page_size: Optional[int] = None) -> List[CalendarEvent]:
+        """Company events calendar.
+
+        General meetings, dividend and coupon payments, subscription periods and
+        listings, past and upcoming, ordered by date. The same calendar the
+        website shows: dates taken from news items, merged with a curated
+        calendar, without duplicates.
+
+        Args:
+            from_: First date to include (YYYY-MM-DD).
+            to: Last date to include (YYYY-MM-DD).
+            ticker: Only events for this security. Not case sensitive.
+            locale: Language of labels and titles: en, fr or ar. Text missing in that language falls back to the French original.
+            page_size: Rows per request, 1 to 1000 (default 1000). Paging is automatic.
+        """
+        return list(self.iter_calendar(from_=from_, to=to, ticker=ticker, locale=locale, page_size=page_size))
+
+    def iter_calendar(self, *, from_: Optional[str] = None, to: Optional[str] = None, ticker: Optional[str] = None, locale: Optional[Literal["en", "fr", "ar"]] = None, page_size: Optional[int] = None) -> Iterator[CalendarEvent]:
+        """Like get_calendar, but yields rows as pages arrive, for long histories."""
+        return self._pages("/calendar", {"from": from_, "to": to, "ticker": ticker, "locale": locale}, page_size)
+
+    def list_news(self, *, ticker: Optional[str] = None, source: Optional[Literal["cosob-visa", "cosob-decision", "cosob-communique", "sgbv-avis", "sgbv-press", "bank-of-algeria", "issuer-ir", "editorial"]] = None, from_: Optional[str] = None, to: Optional[str] = None, locale: Optional[Literal["en", "fr", "ar"]] = None, include_routine: Optional[bool] = None, page_size: Optional[int] = None) -> List[NewsItem]:
+        """News.
+
+        News from COSOB, the exchange, the Bank of Algeria and issuers, newest
+        first, with a summary in the asked language and a link to the full
+        article on Algierex. Routine trading-parameter notices are left out
+        unless `includeRoutine=true`.
+
+        Args:
+            ticker: Only news about this security. Not case sensitive.
+            source: Only news from one origin.
+            from_: First publication day to include (YYYY-MM-DD, Algiers time).
+            to: Last publication day to include (YYYY-MM-DD, Algiers time).
+            locale: Language of labels and titles: en, fr or ar. Text missing in that language falls back to the French original.
+            include_routine: Also return routine trading-parameter notices.
+            page_size: Rows per request, 1 to 1000 (default 1000). Paging is automatic.
+        """
+        return list(self.iter_news(ticker=ticker, source=source, from_=from_, to=to, locale=locale, include_routine=include_routine, page_size=page_size))
+
+    def iter_news(self, *, ticker: Optional[str] = None, source: Optional[Literal["cosob-visa", "cosob-decision", "cosob-communique", "sgbv-avis", "sgbv-press", "bank-of-algeria", "issuer-ir", "editorial"]] = None, from_: Optional[str] = None, to: Optional[str] = None, locale: Optional[Literal["en", "fr", "ar"]] = None, include_routine: Optional[bool] = None, page_size: Optional[int] = None) -> Iterator[NewsItem]:
+        """Like list_news, but yields rows as pages arrive, for long histories."""
+        return self._pages("/news", {"ticker": ticker, "source": source, "from": from_, "to": to, "locale": locale, "includeRoutine": include_routine}, page_size)

algierex/_core.py

@@ -0,0 +1,183 @@
+"""HTTP core of the Algierex SDK: requests, errors, retries, paging.
+
+Hand-written. The API methods live in _client.py, generated from the
+OpenAPI spec by sdk/generate.mjs.
+"""
+
+from __future__ import annotations
+
+import json
+import os
+import time
+import urllib.error
+import urllib.parse
+import urllib.request
+from typing import Any, Callable, Dict, Iterator, List, Optional
+
+DEFAULT_BASE_URL = "https://algierex.com/api/v1"
+# The API's largest page: fewer calls against the plan's limits.
+DEFAULT_PAGE_SIZE = 1000
+USER_AGENT = "algierex-python"
+
+
+class AlgierexError(Exception):
+    """An error answered by the API, or a failure to reach it."""
+
+    def __init__(self, message: str, status: Optional[int] = None, code: Optional[str] = None):
+        super().__init__(message)
+        self.status = status
+        self.code = code
+
+
+class BadRequestError(AlgierexError):
+    """400: a parameter is not valid."""
+
+
+class AuthenticationError(AlgierexError):
+    """401: the key is missing, wrong, or revoked."""
+
+
+class PaymentRequiredError(AlgierexError):
+    """402: the key's account has no active plan, or its last payment failed."""
+
+
+class NotFoundError(AlgierexError):
+    """404: no such security, currency, route, or date."""
+
+
+class RateLimitError(AlgierexError):
+    """429: the plan's limit is used up. retry_after is in seconds."""
+
+    def __init__(self, message: str, retry_after: float, status: int = 429, code: str = "rate_limited"):
+        super().__init__(message, status, code)
+        self.retry_after = retry_after
+
+
+_ERRORS = {400: BadRequestError, 401: AuthenticationError, 402: PaymentRequiredError, 404: NotFoundError}
+
+
+class _Core:
+    def __init__(
+        self,
+        api_key: Optional[str] = None,
+        *,
+        base_url: str = DEFAULT_BASE_URL,
+        timeout: float = 30.0,
+        max_retries: int = 3,
+        max_retry_wait: float = 60.0,
+        _sleep: Callable[[float], None] = time.sleep,
+    ) -> None:
+        """Create a client.
+
+        api_key: your key (alx_...). Defaults to the ALGIEREX_API_KEY
+            environment variable.
+        max_retries: how many times to wait and retry when a rate limit is
+            hit (429). 0 raises RateLimitError at once.
+        max_retry_wait: the longest single wait, in seconds; a longer
+            Retry-After raises RateLimitError instead of sleeping.
+        """
+        key = api_key or os.environ.get("ALGIEREX_API_KEY")
+        if not key:
+            raise AuthenticationError("No API key. Pass api_key or set ALGIEREX_API_KEY.")
+        self._key = key
+        self._base_url = base_url.rstrip("/")
+        self._timeout = timeout
+        self._max_retries = max_retries
+        self._max_retry_wait = max_retry_wait
+        self._sleep = _sleep
+
+    def _request(self, path: str, params: Optional[Dict[str, Any]] = None) -> Any:
+        query = {k: _param(v) for k, v in (params or {}).items() if v is not None}
+        url = self._base_url + path + ("?" + urllib.parse.urlencode(query) if query else "")
+        attempt = 0
+        while True:
+            req = urllib.request.Request(
+                url,
+                headers={
+                    "Authorization": f"Bearer {self._key}",
+                    "Accept": "application/json",
+                    "User-Agent": USER_AGENT,
+                },
+            )
+            try:
+                with urllib.request.urlopen(req, timeout=self._timeout) as res:
+                    raw = res.read()
+            except urllib.error.HTTPError as err:
+                status = err.code
+                with err:
+                    body = _json_or_none(err.read())
+                error = body.get("error") if isinstance(body, dict) else None
+                error = error if isinstance(error, dict) else {}
+                message = error.get("message") or f"HTTP {status}"
+                code = error.get("code")
+                if status == 429:
+                    retry_after = _seconds(err.headers.get("Retry-After"))
+                    if attempt < self._max_retries and retry_after <= self._max_retry_wait:
+                        attempt += 1
+                        self._sleep(retry_after)
+                        continue
+                    raise RateLimitError(message, retry_after) from None
+                raise _ERRORS.get(status, AlgierexError)(message, status, code) from None
+            except urllib.error.URLError as err:
+                raise AlgierexError(f"Could not reach {self._base_url}: {err.reason}") from None
+            except OSError as err:  # timeouts and dropped connections
+                raise AlgierexError(f"Could not reach {self._base_url}: {err}") from None
+            body = _json_or_none(raw)
+            if body is None:
+                raise AlgierexError(f"The API answered with something that is not JSON ({url}).")
+            return body
+
+    def _data(self, path: str, params: Optional[Dict[str, Any]] = None) -> Any:
+        return self._request(path, params)["data"]
+
+    def _pages(self, path: str, params: Dict[str, Any], page_size: Optional[int]) -> Iterator[Any]:
+        """Every row of a paged route, following nextCursor to the end."""
+        params = dict(params, limit=page_size or DEFAULT_PAGE_SIZE)
+        seen = set()
+        while True:
+            body = self._request(path, params)
+            yield from body["data"]
+            cursor = body.get("nextCursor")
+            if not cursor:
+                return
+            if cursor in seen:
+                raise AlgierexError("The API returned the same page cursor twice; stopping to avoid a loop.")
+            seen.add(cursor)
+            params["cursor"] = cursor
+
+
+def _param(value: Any) -> str:
+    if isinstance(value, bool):
+        return "true" if value else "false"
+    return str(value)
+
+
+def _seconds(value: Optional[str]) -> float:
+    """Retry-After in seconds; 1 when missing or not a number."""
+    try:
+        return max(0.0, float(value)) if value else 1.0
+    except ValueError:
+        return 1.0
+
+
+def _json_or_none(raw: bytes) -> Any:
+    try:
+        return json.loads(raw.decode("utf-8"))
+    except (ValueError, UnicodeDecodeError):
+        return None
+
+
+def to_frame(rows: List[Dict[str, Any]], index: Optional[str] = "date"):
+    """Turn rows into a pandas DataFrame, indexed by date when there is one.
+
+    Needs pandas (pip install "algierex[pandas]").
+    """
+    try:
+        import pandas as pd  # type: ignore[import-not-found]
+    except ImportError as err:  # pragma: no cover
+        raise ImportError('to_frame needs pandas: pip install "algierex[pandas]"') from err
+    frame = pd.DataFrame(rows)
+    if index and index in frame.columns:
+        frame[index] = pd.to_datetime(frame[index])
+        frame = frame.set_index(index)
+    return frame

algierex/_types.py

@@ -0,0 +1,136 @@
+"""Response types. Generated by sdk/generate.mjs from the OpenAPI spec. Do not edit; run `npm run sdk`."""
+
+from __future__ import annotations
+
+from typing import Any, Dict, List, Literal, Optional, TypedDict
+
+class Ticker(TypedDict):
+    ticker: str  # Symbol, for example SAI.
+    nameEn: str  # Name in English.
+    nameFr: Optional[str]  # Name in French.
+    nameAr: Optional[str]  # Name in Arabic.
+    descEn: Optional[str]  # Short description in English.
+    descFr: Optional[str]  # Short description in French.
+    descAr: Optional[str]  # Short description in Arabic.
+    isin: Optional[str]  # ISIN code.
+    sector: Optional[str]  # Sector, for example pharma or banking.
+    listingDate: Optional[str]  # First listing day.
+    sharesOutstanding: Optional[float]  # Shares issued.
+    parValueDZD: Optional[float]  # Par value in DZD.
+    freeFloatPct: Optional[float]  # Percent of shares free to trade.
+    stateOwnedPct: Optional[float]  # Percent held by the state.
+
+
+class PriceDay(TypedDict):
+    date: str  # Session date.
+    sessionNumber: int  # The exchange's session number.
+    market: Literal["main", "bond", "sme", "oat", "premium", "pi"]  # Market the security traded in that day.
+    close: float  # Closing price in DZD. For OATs, percent of face value.
+    open: Optional[float]  # Opening price, when the bulletin gives one.
+    previousClose: Optional[float]  # Previous close, when the bulletin gives one.
+    volume: float  # Units traded.
+    value: float  # Value traded in DZD.
+    transactions: int  # Number of trades.
+
+
+class Session(TypedDict):
+    date: str  # Session date.
+    sessionNumber: int  # The exchange's session number.
+    market: Literal["main", "bond", "sme", "oat"]  # Market.
+    volume: float  # Units traded in the market that session.
+    value: float  # Value traded in DZD.
+    transactions: int  # Number of trades.
+
+
+class IndexDay(TypedDict):
+    date: str  # Session date.
+    close: float  # Index close.
+    change: float  # Change from the previous close, in points.
+    changePct: float  # Change from the previous close, in percent.
+    previousClose: float  # Previous close.
+
+
+class YieldCurvePointsItem(TypedDict):
+    ticker: str  # OAT symbol.
+    maturityDate: str  # Maturity date.
+    yearsToMaturity: float  # Years from asOf to maturity.
+    yieldRate: float  # Yield in percent at the bond's most recent trade.
+
+
+YieldCurveFitCurveItem = TypedDict("YieldCurveFitCurveItem", {
+    "years": float,  # Maturity in years.
+    "yield": float,  # Fitted yield in percent.
+})
+
+
+# null when fewer than five bonds traded.
+YieldCurveFit = TypedDict("YieldCurveFit", {
+    "beta0": float,  # Long-term level.
+    "beta1": float,  # Short-term component.
+    "beta2": float,  # Curvature (medium-term hump).
+    "lambda": float,  # Decay, in years: where the curvature peaks.
+    "rmse": float,  # Root mean squared error of the fit, in percentage points.
+    "rSquared": float,  # Share of yield variance across the bonds that the curve explains.
+    "shortRate": float,  # Model yield at maturity zero: beta0 + beta1.
+    "longRate": float,  # Model yield at very long maturity: beta0.
+    "curve": List[YieldCurveFitCurveItem],  # The fitted curve sampled across the observed maturities.
+})
+
+
+class YieldCurve(TypedDict):
+    asOf: str  # The OAT session the curve is dated to.
+    staleCount: int  # OATs listed in that session's bulletin with no trade in the last 60 OAT sessions. They are left out of the fit.
+    points: List[YieldCurvePointsItem]  # The bonds behind the fit, shortest maturity first.
+    fit: Optional[YieldCurveFit]  # null when fewer than five bonds traded.
+
+
+class FxLatest(TypedDict):
+    assetCode: str  # Currency code, for example USD.
+    assetType: Literal["CURRENCY", "CRYPTO", "METAL"]  # Kind of asset.
+    source: Literal["official", "exchangedz"]  # official: Bank of Algeria. exchangedz: parallel market.
+    date: str  # Date of the rate.
+    buyRate: float  # Buy rate in DZD per unit.
+    sellRate: float  # Sell rate in DZD per unit.
+
+
+class CalendarEventNews(TypedDict):
+    """The news item the date comes from; null for curated events."""
+
+    source: str  # News origin.
+    sourceId: str  # News id at the origin.
+    title: str  # Title of the news item, in the asked language.
+    url: str  # The article on Algierex.
+
+
+class CalendarEvent(TypedDict):
+    id: str  # Stable id of the event.
+    date: str  # Day of the event.
+    kind: str  # ago: ordinary general meeting. agex: extraordinary general meeting. dividend_payment and coupon_payment: payment day. subscription_open and subscription_close: an offer's subscription period. listing_start: first trading day. session_cancelled: no session that day. result: results publication. deadline: a filing or application deadline. other: anything else.
+    label: str  # What happens, in the asked language.
+    ticker: Optional[str]  # The security, when the event is about one.
+    market: Optional[str]  # The security's market, for curated events.
+    news: Optional[CalendarEventNews]  # The news item the date comes from; null for curated events.
+
+
+class NewsItem(TypedDict):
+    source: str  # cosob-visa: COSOB approval of an offer document. cosob-decision: COSOB decision. cosob-communique: COSOB press release. sgbv-avis: the exchange's official notice. sgbv-press: the exchange's press and information notes. bank-of-algeria: Bank of Algeria publication. issuer-ir: a company's own investor news. editorial: written by Algierex.
+    sourceId: str  # Id at the origin.
+    title: str  # Title in the asked language.
+    summary: Optional[str]  # Short summary in the asked language.
+    ticker: Optional[str]  # The security the item is about.
+    market: Optional[str]  # That security's market.
+    tags: List[str]  # Topics, for example listing or dividend.
+    originalLanguage: Literal["fr", "en", "ar"]  # Language the origin published in.
+    publishedAt: str  # Publication time (UTC).
+    dateIsApprox: bool  # True when the origin gave no exact date.
+    sourceUrl: str  # Page at the origin.
+    pdfUrl: Optional[str]  # The original document, when there is one.
+    url: str  # The article on Algierex, in the asked language.
+
+
+class FxRow(TypedDict):
+    date: str  # Date of the rate.
+    assetCode: str  # Currency code.
+    source: Literal["official", "exchangedz"]  # official: Bank of Algeria. exchangedz: parallel market.
+    buyRate: float  # Buy rate in DZD per unit.
+    sellRate: float  # Sell rate in DZD per unit.

algierex-1.0.0.dist-info/METADATA

@@ -0,0 +1,109 @@
+Metadata-Version: 2.4
+Name: algierex
+Version: 1.0.0
+Summary: Python SDK for the Algierex market data API (the Algerian exchange)
+Author-email: Algierex <contact@algierex.com>
+License: MIT
+Project-URL: Homepage, https://algierex.com/developers
+Project-URL: Documentation, https://algierex.com/developers/docs
+Keywords: algeria,algiers,stock exchange,market data,finance,api
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: pandas
+Requires-Dist: pandas>=1.5; extra == "pandas"
+Dynamic: license-file
+
+# algierex (Python)
+
+Python SDK for the [Algierex market data API](https://algierex.com/developers/docs): the Algerian exchange's daily prices back to 1999, sessions, the Dzair index, the OAT yield curve, exchange rates, company events and news.
+
+No dependencies. Python 3.9 or newer.
+
+## Install
+
+```sh
+pip install algierex            # or "algierex[pandas]" for to_frame()
+```
+
+## Get a key
+
+Create a key and choose a plan at [algierex.com/developers](https://algierex.com/developers). Then:
+
+```sh
+export ALGIEREX_API_KEY=alx_...
+```
+
+## Example
+
+```python
+from algierex import Algierex, PaymentRequiredError, to_frame
+
+client = Algierex()  # reads ALGIEREX_API_KEY
+
+try:
+    client.list_tickers()
+except PaymentRequiredError as err:
+    raise SystemExit(f"{err}")  # no active plan: choose one at algierex.com/developers
+
+# Every daily close of Saidal since 2025, as a pandas DataFrame.
+prices = to_frame(client.get_prices("SAI", from_="2025-01-01"))
+print(prices["close"].tail())
+
+# The OAT yield curve on a past date.
+curve = client.get_yield_curve(date="2026-09-30")
+print(curve["asOf"], curve["fit"]["rSquared"] if curve["fit"] else "not enough trades")
+
+# Upcoming company events, in French.
+for event in client.get_calendar(from_="2026-11-01", locale="fr"):
+    print(event["date"], event["ticker"], event["label"])
+```
+
+## Methods
+
+| Method | Route |
+|---|---|
+| `list_tickers()` | `GET /tickers` |
+| `get_prices(ticker, from_=, to=)` | `GET /prices/{ticker}` |
+| `list_sessions(market=, from_=, to=)` | `GET /sessions` |
+| `get_dzair_index(from_=, to=)` | `GET /index/dzair` |
+| `get_yield_curve(date=)` | `GET /yield-curve` |
+| `list_fx()` | `GET /fx` |
+| `get_fx_history(code, source=, from_=, to=)` | `GET /fx/{code}` |
+| `get_calendar(from_=, to=, ticker=, locale=)` | `GET /calendar` |
+| `list_news(ticker=, source=, from_=, to=, locale=, include_routine=)` | `GET /news` |
+
+`from` is a Python keyword, so the parameter is `from_`. Every response is plain JSON (dicts and lists), typed with `TypedDict`s.
+
+## Paging
+
+Paging is automatic: list methods return every row. For long histories, the `iter_*` twin yields rows as pages arrive:
+
+```python
+for day in client.iter_prices("SAI"):
+    ...
+```
+
+`page_size` (1 to 1000, default 1000) sets rows per request; the default keeps calls against your plan's limits low.
+
+## Errors
+
+Every error raises a subclass of `AlgierexError`, with `.status` and `.code`:
+
+| Exception | When |
+|---|---|
+| `BadRequestError` | 400: a parameter is not valid |
+| `AuthenticationError` | 401: the key is missing, wrong, or revoked |
+| `PaymentRequiredError` | 402: no active plan, or the last payment failed |
+| `NotFoundError` | 404: no such security, currency, or date |
+| `RateLimitError` | 429: the plan's limit is used up; `.retry_after` in seconds |
+
+On a 429 the client waits `Retry-After` and retries, up to `max_retries` (default 3) and only for waits up to `max_retry_wait` seconds (default 60). `Algierex(max_retries=0)` raises at once. Server errors (5xx), timeouts (`timeout=30` seconds) and network failures raise `AlgierexError` and are not retried.
+
+## Regenerating
+
+This SDK is generated from the API's OpenAPI spec. From the repository root, after `npm install`: `npm run sdk`.

algierex-1.0.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+algierex/__init__.py,sha256=MtUNGfpWPkrSg7d4Lk4MGt0einnUz-gbhDlQNVV912w,782
+algierex/_client.py,sha256=PBfS7mIFlxB-oGa6FwKlsaJ2l9Q60J8rZlQrUpG0PnI,9836
+algierex/_core.py,sha256=Ghe8jHM_0uOHZ05aT5GM2kiKquZRMARPaGzhdqDhUI0,6777
+algierex/_types.py,sha256=jKP9FJEWo_o7cEwpFUH3feziYoSLMncSJjg5ivJP9qY,6527
+algierex/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+algierex-1.0.0.dist-info/licenses/LICENSE,sha256=jCLkdpnzpfFZw7MrI8Q7zgJBNJ7m0gQbvjRZzO0dxt4,1065
+algierex-1.0.0.dist-info/METADATA,sha256=SgCjtsDwmuW9nMcblPN6McWZI-H0MsuyE-pf7HwxBcc,3983
+algierex-1.0.0.dist-info/WHEEL,sha256=a-udL2m4V_6Yn8b-uKzWb12RjRxwwMo6ohYFM24tpaY,91
+algierex-1.0.0.dist-info/top_level.txt,sha256=ghws0k9rtRiVzmP7fSKLwhiz7omu1uGt_lX8NlDSOXM,9
+algierex-1.0.0.dist-info/RECORD,,

algierex-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

algierex-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Algierex
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

algierex-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+algierex