tidata 0.1.0__tar.gz

tidata-0.1.0/PKG-INFO

@@ -0,0 +1,87 @@
+Metadata-Version: 2.4
+Name: tidata
+Version: 0.1.0
+Summary: Python client for the TradeInsight API — yfinance-compatible Ticker.history()
+License: MIT
+Project-URL: Homepage, https://github.com/TradeInsight-Info/tidata
+Project-URL: Bug Tracker, https://github.com/TradeInsight-Info/tidata/issues
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.28
+Requires-Dist: pandas>=1.5
+Provides-Extra: test
+Requires-Dist: pytest>=7; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: responses>=0.23; extra == "test"
+
+# trading-data-py
+
+Python client for the [TradeInsight](https://tradeinsight.info) Trading Data Service API.
+Provides a `Ticker` class with a `history()` method that returns a pandas DataFrame
+with yfinance-compatible column names.
+
+## Installation
+
+```bash
+pip install trading-data-py
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/tradeinsight/trading-data-py.git
+cd trading-data-py
+pip install -e .
+```
+
+## Quick Start
+
+Set your API key in the environment:
+
+```bash
+export TRADING_DATA_API_KEY=your_key_here
+```
+
+Then use the client:
+
+```python
+from trading_data import Ticker
+
+# API key is read from TRADING_DATA_API_KEY env var automatically
+t = Ticker("AAPL")
+
+# Adjusted prices (yfinance-compatible)
+df = t.history(start="2024-01-01", end="2024-12-31")
+print(df.head())
+#                  Open        High         Low       Close      Volume  Dividends  Stock Splits
+# Date
+# 2024-01-02  184.210...  185.880...  183.430...  185.200...  79047200.0        0.0           0.0
+
+# Raw (unadjusted) prices
+df_raw = t.history(start="2024-01-01", end="2024-12-31", auto_adjust=False)
+```
+
+## Configuration
+
+| Parameter | Description | Default |
+|-----------|-------------|---------|
+| `symbol` | Ticker symbol (e.g. `"AAPL"`) | required |
+| `api_key` | API key — also reads `TRADING_DATA_API_KEY` env var | `None` |
+| `base_url` | API base URL | `https://api.tradeinsight.info` |
+| `timeout` | HTTP timeout in seconds | `30` |
+
+## Exceptions
+
+| Exception | API error code |
+|-----------|---------------|
+| `TickerNotFoundError` | `TICKER_NOT_FOUND`, `INVALID_TICKER` |
+| `AuthenticationError` | `UNAUTHORIZED`, `INVALID_API_KEY`, `API_KEY_REQUIRED` |
+| `RateLimitError` | `RATE_LIMIT_EXCEEDED`, `TOO_MANY_REQUESTS` |
+| `InvalidParameterError` | `TICKER_REQUIRED`, `INVALID_DATE`, `INVALID_PARAMETER` |
+| `APIError` | Any other error code (base class) |
+
+All exceptions inherit from `APIError` which exposes `.code` and `.message`.
+
+## License
+
+MIT

tidata-0.1.0/README.md

@@ -0,0 +1,71 @@
+# trading-data-py
+
+Python client for the [TradeInsight](https://tradeinsight.info) Trading Data Service API.
+Provides a `Ticker` class with a `history()` method that returns a pandas DataFrame
+with yfinance-compatible column names.
+
+## Installation
+
+```bash
+pip install trading-data-py
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/tradeinsight/trading-data-py.git
+cd trading-data-py
+pip install -e .
+```
+
+## Quick Start
+
+Set your API key in the environment:
+
+```bash
+export TRADING_DATA_API_KEY=your_key_here
+```
+
+Then use the client:
+
+```python
+from trading_data import Ticker
+
+# API key is read from TRADING_DATA_API_KEY env var automatically
+t = Ticker("AAPL")
+
+# Adjusted prices (yfinance-compatible)
+df = t.history(start="2024-01-01", end="2024-12-31")
+print(df.head())
+#                  Open        High         Low       Close      Volume  Dividends  Stock Splits
+# Date
+# 2024-01-02  184.210...  185.880...  183.430...  185.200...  79047200.0        0.0           0.0
+
+# Raw (unadjusted) prices
+df_raw = t.history(start="2024-01-01", end="2024-12-31", auto_adjust=False)
+```
+
+## Configuration
+
+| Parameter | Description | Default |
+|-----------|-------------|---------|
+| `symbol` | Ticker symbol (e.g. `"AAPL"`) | required |
+| `api_key` | API key — also reads `TRADING_DATA_API_KEY` env var | `None` |
+| `base_url` | API base URL | `https://api.tradeinsight.info` |
+| `timeout` | HTTP timeout in seconds | `30` |
+
+## Exceptions
+
+| Exception | API error code |
+|-----------|---------------|
+| `TickerNotFoundError` | `TICKER_NOT_FOUND`, `INVALID_TICKER` |
+| `AuthenticationError` | `UNAUTHORIZED`, `INVALID_API_KEY`, `API_KEY_REQUIRED` |
+| `RateLimitError` | `RATE_LIMIT_EXCEEDED`, `TOO_MANY_REQUESTS` |
+| `InvalidParameterError` | `TICKER_REQUIRED`, `INVALID_DATE`, `INVALID_PARAMETER` |
+| `APIError` | Any other error code (base class) |
+
+All exceptions inherit from `APIError` which exposes `.code` and `.message`.
+
+## License
+
+MIT

tidata-0.1.0/pyproject.toml

@@ -0,0 +1,26 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "tidata"
+version = "0.1.0"
+description = "Python client for the TradeInsight API — yfinance-compatible Ticker.history()"
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.9"
+dependencies = [
+    "requests>=2.28",
+    "pandas>=1.5",
+]
+
+[project.urls]
+Homepage = "https://github.com/TradeInsight-Info/tidata"
+"Bug Tracker" = "https://github.com/TradeInsight-Info/tidata/issues"
+
+[project.optional-dependencies]
+test = ["pytest>=7", "pytest-cov", "responses>=0.23"]
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["tidata*"]

tidata-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

tidata-0.1.0/tests/test_ticker.py

@@ -0,0 +1,488 @@
+"""Pytest suite for tidata.tifinance.Ticker.history()."""
+
+from __future__ import annotations
+
+import json
+
+import pandas as pd
+import pytest
+import responses as resp_lib
+
+from tidata.tifinance import Ticker
+from tidata.tifinance.exceptions import (
+    APIError,
+    AuthenticationError,
+    InvalidParameterError,
+    RateLimitError,
+    TickerNotFoundError,
+)
+
+BASE_URL = "https://api.tradeinsight.info/trading-data/v1"
+OHLC_URL = f"{BASE_URL}/ohlc"
+
+# Dummy key used only in tests — never a real credential
+_TEST_API_KEY = "test-key-for-pytest"  # noqa: S105
+
+# ---------------------------------------------------------------------------
+# Fixtures / helpers
+# ---------------------------------------------------------------------------
+
+_THREE_ROWS = [
+    {
+        "date": "2024-01-02",
+        "open": 185.0,
+        "high": 188.5,
+        "low": 184.0,
+        "close": 187.0,
+        "adj_open": 184.5,
+        "adj_high": 188.0,
+        "adj_low": 183.8,
+        "adj_close": 186.5,
+        "volume": 60_000_000,
+        "adj_volume": 60_000_000,
+        "dividend": 0.0,
+        "split_ratio": 0.0,
+    },
+    {
+        "date": "2024-01-03",
+        "open": 187.0,
+        "high": 190.0,
+        "low": 185.5,
+        "close": 189.0,
+        "adj_open": 186.5,
+        "adj_high": 189.5,
+        "adj_low": 185.0,
+        "adj_close": 188.5,
+        "volume": 55_000_000,
+        "adj_volume": 55_000_000,
+        "dividend": 0.24,
+        "split_ratio": 0.0,
+    },
+    {
+        "date": "2024-01-04",
+        "open": 189.0,
+        "high": 192.0,
+        "low": 187.0,
+        "close": 191.0,
+        "adj_open": 188.5,
+        "adj_high": 191.5,
+        "adj_low": 186.5,
+        "adj_close": 190.5,
+        "volume": 50_000_000,
+        "adj_volume": 50_000_000,
+        "dividend": 0.0,
+        "split_ratio": 4.0,
+    },
+]
+
+
+def _make_ticker(symbol: str = "AAPL") -> Ticker:
+    return Ticker(symbol, api_key=_TEST_API_KEY)
+
+
+def _error_body(code: str, message: str = "error") -> str:
+    return json.dumps({"code": code, "message": message})
+
+
+# ---------------------------------------------------------------------------
+# Happy-path tests
+# ---------------------------------------------------------------------------
+
+
+@resp_lib.activate
+def test_history_happy_path_shape():
+    """Successful /ohlc call returns a DataFrame with the right shape."""
+    resp_lib.add(
+        resp_lib.GET,
+        OHLC_URL,
+        json={"data": _THREE_ROWS},
+        status=200,
+    )
+    ticker = _make_ticker()
+    df = ticker.history(start="2024-01-02", end="2024-01-05")
+
+    assert isinstance(df, pd.DataFrame)
+    assert df.shape == (3, 7)  # 7 columns: Open High Low Close Volume Dividends Stock Splits
+
+
+@resp_lib.activate
+def test_history_happy_path_index():
+    """Index is DatetimeIndex named 'Date', sorted ascending."""
+    resp_lib.add(resp_lib.GET, OHLC_URL, json={"data": _THREE_ROWS}, status=200)
+    df = _make_ticker().history(start="2024-01-02", end="2024-01-05")
+
+    assert df.index.name == "Date"
+    assert isinstance(df.index, pd.DatetimeIndex)
+    assert list(df.index) == sorted(df.index)
+
+
+@resp_lib.activate
+def test_history_happy_path_values():
+    """Spot-check a numeric cell value for the adjusted close."""
+    resp_lib.add(resp_lib.GET, OHLC_URL, json={"data": _THREE_ROWS}, status=200)
+    df = _make_ticker().history(start="2024-01-02", end="2024-01-05")
+
+    assert df.loc[pd.Timestamp("2024-01-02"), "Close"] == pytest.approx(186.5)
+    assert df.loc[pd.Timestamp("2024-01-02"), "Volume"] == 60_000_000
+
+
+@resp_lib.activate
+def test_history_top_level_list_response():
+    """API may return a bare list (not wrapped in {"data": ...})."""
+    resp_lib.add(resp_lib.GET, OHLC_URL, json=_THREE_ROWS, status=200)
+    df = _make_ticker().history(start="2024-01-02", end="2024-01-05")
+    assert df.shape[0] == 3
+
+
+# ---------------------------------------------------------------------------
+# auto_adjust=True (default)
+# ---------------------------------------------------------------------------
+
+
+@resp_lib.activate
+def test_auto_adjust_true_columns():
+    """auto_adjust=True uses adj_* fields → yfinance column names."""
+    resp_lib.add(resp_lib.GET, OHLC_URL, json={"data": _THREE_ROWS}, status=200)
+    df = _make_ticker().history(start="2024-01-02", end="2024-01-05", auto_adjust=True)
+
+    assert set(df.columns) == {"Open", "High", "Low", "Close", "Volume", "Dividends", "Stock Splits"}
+
+
+@resp_lib.activate
+def test_auto_adjust_true_uses_adj_values():
+    """With auto_adjust=True, 'Close' holds adj_close, not raw close."""
+    resp_lib.add(resp_lib.GET, OHLC_URL, json={"data": _THREE_ROWS}, status=200)
+    df = _make_ticker().history(start="2024-01-02", end="2024-01-05", auto_adjust=True)
+
+    # adj_close for 2024-01-02 is 186.5; raw close is 187.0
+    assert df.loc[pd.Timestamp("2024-01-02"), "Close"] == pytest.approx(186.5)
+
+
+# ---------------------------------------------------------------------------
+# auto_adjust=False
+# ---------------------------------------------------------------------------
+
+
+@resp_lib.activate
+def test_auto_adjust_false_columns():
+    """auto_adjust=False uses raw open/high/low/close fields."""
+    resp_lib.add(resp_lib.GET, OHLC_URL, json={"data": _THREE_ROWS}, status=200)
+    df = _make_ticker().history(start="2024-01-02", end="2024-01-05", auto_adjust=False)
+
+    assert set(df.columns) == {"Open", "High", "Low", "Close", "Volume", "Dividends", "Stock Splits"}
+
+
+@resp_lib.activate
+def test_auto_adjust_false_uses_raw_values():
+    """With auto_adjust=False, 'Close' holds the raw close, not adj_close."""
+    resp_lib.add(resp_lib.GET, OHLC_URL, json={"data": _THREE_ROWS}, status=200)
+    df = _make_ticker().history(start="2024-01-02", end="2024-01-05", auto_adjust=False)
+
+    # raw close for 2024-01-02 is 187.0; adj_close is 186.5
+    assert df.loc[pd.Timestamp("2024-01-02"), "Close"] == pytest.approx(187.0)
+
+
+# ---------------------------------------------------------------------------
+# Dividends and Stock Splits
+# ---------------------------------------------------------------------------
+
+
+@resp_lib.activate
+def test_dividends_column_present_and_correct():
+    """'Dividends' column is populated from the 'dividend' field."""
+    resp_lib.add(resp_lib.GET, OHLC_URL, json={"data": _THREE_ROWS}, status=200)
+    df = _make_ticker().history(start="2024-01-02", end="2024-01-05")
+
+    assert "Dividends" in df.columns
+    assert df.loc[pd.Timestamp("2024-01-03"), "Dividends"] == pytest.approx(0.24)
+    assert df.loc[pd.Timestamp("2024-01-02"), "Dividends"] == pytest.approx(0.0)
+
+
+@resp_lib.activate
+def test_stock_splits_column_present_and_correct():
+    """'Stock Splits' column is populated from the 'split_ratio' field."""
+    resp_lib.add(resp_lib.GET, OHLC_URL, json={"data": _THREE_ROWS}, status=200)
+    df = _make_ticker().history(start="2024-01-02", end="2024-01-05")
+
+    assert "Stock Splits" in df.columns
+    assert df.loc[pd.Timestamp("2024-01-04"), "Stock Splits"] == pytest.approx(4.0)
+    assert df.loc[pd.Timestamp("2024-01-02"), "Stock Splits"] == pytest.approx(0.0)
+
+
+# ---------------------------------------------------------------------------
+# Empty response
+# ---------------------------------------------------------------------------
+
+
+@resp_lib.activate
+def test_history_empty_response():
+    """Empty data list returns an empty DataFrame with the canonical schema."""
+    resp_lib.add(resp_lib.GET, OHLC_URL, json={"data": []}, status=200)
+    df = _make_ticker().history(start="2024-01-02", end="2024-01-05")
+
+    assert isinstance(df, pd.DataFrame)
+    assert len(df) == 0
+    assert set(df.columns) == {"Open", "High", "Low", "Close", "Volume", "Dividends", "Stock Splits"}
+
+
+# ---------------------------------------------------------------------------
+# Error-code mapping tests
+# ---------------------------------------------------------------------------
+
+
+@resp_lib.activate
+def test_ticker_not_found_error():
+    """TICKER_NOT_FOUND maps to TickerNotFoundError."""
+    resp_lib.add(
+        resp_lib.GET,
+        OHLC_URL,
+        body=_error_body("TICKER_NOT_FOUND", "Ticker ZZZZ not found"),
+        status=404,
+        content_type="application/json",
+    )
+    with pytest.raises(TickerNotFoundError) as exc_info:
+        _make_ticker("ZZZZ").history(start="2024-01-02", end="2024-01-05")
+
+    assert exc_info.value.code == "TICKER_NOT_FOUND"
+
+
+@resp_lib.activate
+def test_unauthorized_error():
+    """UNAUTHORIZED maps to AuthenticationError."""
+    resp_lib.add(
+        resp_lib.GET,
+        OHLC_URL,
+        body=_error_body("UNAUTHORIZED", "Invalid API key"),
+        status=401,
+        content_type="application/json",
+    )
+    with pytest.raises(AuthenticationError) as exc_info:
+        _make_ticker().history(start="2024-01-02", end="2024-01-05")
+
+    assert exc_info.value.code == "UNAUTHORIZED"
+
+
+@resp_lib.activate
+def test_rate_limit_exceeded_error():
+    """RATE_LIMIT_EXCEEDED maps to RateLimitError."""
+    resp_lib.add(
+        resp_lib.GET,
+        OHLC_URL,
+        body=_error_body("RATE_LIMIT_EXCEEDED", "Too many requests"),
+        status=429,
+        content_type="application/json",
+    )
+    with pytest.raises(RateLimitError) as exc_info:
+        _make_ticker().history(start="2024-01-02", end="2024-01-05")
+
+    assert exc_info.value.code == "RATE_LIMIT_EXCEEDED"
+
+
+@resp_lib.activate
+def test_ticker_required_error():
+    """TICKER_REQUIRED maps to InvalidParameterError."""
+    resp_lib.add(
+        resp_lib.GET,
+        OHLC_URL,
+        body=_error_body("TICKER_REQUIRED", "Ticker is required"),
+        status=400,
+        content_type="application/json",
+    )
+    with pytest.raises(InvalidParameterError) as exc_info:
+        _make_ticker().history(start="2024-01-02", end="2024-01-05")
+
+    assert exc_info.value.code == "TICKER_REQUIRED"
+
+
+@resp_lib.activate
+def test_unknown_error_code_raises_api_error():
+    """An unrecognised error code falls back to the base APIError."""
+    resp_lib.add(
+        resp_lib.GET,
+        OHLC_URL,
+        body=_error_body("SOME_WEIRD_CODE", "Something went wrong"),
+        status=500,
+        content_type="application/json",
+    )
+    with pytest.raises(APIError) as exc_info:
+        _make_ticker().history(start="2024-01-02", end="2024-01-05")
+
+    # Must be base APIError, not a subclass
+    assert type(exc_info.value) is APIError
+    assert exc_info.value.code == "SOME_WEIRD_CODE"
+
+
+@resp_lib.activate
+def test_non_json_error_response():
+    """A non-JSON 500 body still raises APIError with an HTTP_ code."""
+    resp_lib.add(
+        resp_lib.GET,
+        OHLC_URL,
+        body="Internal Server Error",
+        status=500,
+        content_type="text/plain",
+    )
+    with pytest.raises(APIError) as exc_info:
+        _make_ticker().history(start="2024-01-02", end="2024-01-05")
+
+    assert exc_info.value.code.startswith("HTTP_")
+
+
+# ---------------------------------------------------------------------------
+# Ticker initialisation / header tests
+# ---------------------------------------------------------------------------
+
+
+@resp_lib.activate
+def test_api_key_sent_as_header():
+    """The Authorization: Bearer header is included in the request."""
+    resp_lib.add(resp_lib.GET, OHLC_URL, json={"data": []}, status=200)
+    _make_ticker().history(start="2024-01-02", end="2024-01-05")
+
+    assert resp_lib.calls[0].request.headers.get("Authorization") == f"Bearer {_TEST_API_KEY}"
+
+
+def test_symbol_normalised_to_uppercase():
+    """Symbol is normalised to uppercase on construction."""
+    ticker = Ticker("aapl", api_key="k")
+    assert ticker.symbol == "AAPL"
+
+
+# ---------------------------------------------------------------------------
+# period resolution
+# ---------------------------------------------------------------------------
+
+from datetime import date, timedelta
+
+
+def test_period_invalid_raises():
+    with pytest.raises(InvalidParameterError):
+        _make_ticker().history(period="3y")
+
+
+def test_period_all_three_raises():
+    with pytest.raises(ValueError, match="nonsense"):
+        _make_ticker().history(period="1y", start="2022-01-01", end="2023-01-01")
+
+
+@resp_lib.activate
+def test_period_1y_end_is_today():
+    resp_lib.add(resp_lib.GET, OHLC_URL, json={"data": [], "total": 0, "limit": 1000, "offset": 0}, status=200)
+    _make_ticker().history(period="1y")
+    qs = resp_lib.calls[0].request.url
+    assert f"end={date.today().isoformat()}" in qs
+
+
+@resp_lib.activate
+def test_period_1y_start_is_365_days_ago():
+    resp_lib.add(resp_lib.GET, OHLC_URL, json={"data": [], "total": 0, "limit": 1000, "offset": 0}, status=200)
+    _make_ticker().history(period="1y")
+    qs = resp_lib.calls[0].request.url
+    expected = (date.today() - timedelta(days=365)).isoformat()
+    assert f"start={expected}" in qs
+
+
+@resp_lib.activate
+def test_period_with_end_sets_start():
+    """period='1y', end='2023-01-01' -> start=2022-01-01, end=2022-12-31 (exclusive end)."""
+    resp_lib.add(resp_lib.GET, OHLC_URL, json={"data": [], "total": 0, "limit": 1000, "offset": 0}, status=200)
+    _make_ticker().history(period="1y", end="2023-01-01")
+    qs = resp_lib.calls[0].request.url
+    assert "start=2022-01-01" in qs
+    assert "end=2022-12-31" in qs
+
+
+@resp_lib.activate
+def test_period_with_start_sets_end():
+    """period='1y', start='2022-01-01' -> end=2022-12-31."""
+    resp_lib.add(resp_lib.GET, OHLC_URL, json={"data": [], "total": 0, "limit": 1000, "offset": 0}, status=200)
+    _make_ticker().history(period="1y", start="2022-01-01")
+    qs = resp_lib.calls[0].request.url
+    assert "start=2022-01-01" in qs
+    assert "end=2022-12-31" in qs
+
+
+@resp_lib.activate
+def test_period_ytd_start_is_jan_1():
+    resp_lib.add(resp_lib.GET, OHLC_URL, json={"data": [], "total": 0, "limit": 1000, "offset": 0}, status=200)
+    _make_ticker().history(period="ytd")
+    qs = resp_lib.calls[0].request.url
+    jan1 = f"{date.today().year}-01-01"
+    assert f"start={jan1}" in qs
+
+
+@resp_lib.activate
+def test_period_max_same_as_10y():
+    import urllib.parse
+    resp_lib.add(resp_lib.GET, OHLC_URL, json={"data": [], "total": 0, "limit": 1000, "offset": 0}, status=200)
+    _make_ticker().history(period="max")
+    qs_max = resp_lib.calls[0].request.url
+
+    resp_lib.add(resp_lib.GET, OHLC_URL, json={"data": [], "total": 0, "limit": 1000, "offset": 0}, status=200)
+    _make_ticker().history(period="10y")
+    qs_10y = resp_lib.calls[1].request.url
+
+    p_max = dict(urllib.parse.parse_qsl(urllib.parse.urlparse(qs_max).query))
+    p_10y = dict(urllib.parse.parse_qsl(urllib.parse.urlparse(qs_10y).query))
+    assert p_max["start"] == p_10y["start"]
+    assert p_max["end"] == p_10y["end"]
+
+
+# ---------------------------------------------------------------------------
+# interval and actions
+# ---------------------------------------------------------------------------
+
+
+def test_interval_non_1d_raises():
+    with pytest.raises(InvalidParameterError, match="interval"):
+        _make_ticker().history(start="2024-01-02", end="2024-01-05", interval="1wk")
+
+
+@resp_lib.activate
+def test_actions_false_drops_columns():
+    resp_lib.add(resp_lib.GET, OHLC_URL, json={"data": _THREE_ROWS, "total": 3, "limit": 1000, "offset": 0}, status=200)
+    df = _make_ticker().history(start="2024-01-02", end="2024-01-05", actions=False)
+    assert "Dividends" not in df.columns
+    assert "Stock Splits" not in df.columns
+    assert set(df.columns) == {"Open", "High", "Low", "Close", "Volume"}
+
+
+# ---------------------------------------------------------------------------
+# pagination
+# ---------------------------------------------------------------------------
+
+
+def _make_rows(n: int) -> list[dict]:
+    return [
+        {
+            "date": f"2020-01-{(i % 28) + 1:02d}",
+            "adj_open": 100.0, "adj_high": 101.0, "adj_low": 99.0,
+            "adj_close": 100.5, "adj_volume": 1_000_000,
+            "open": 100.0, "high": 101.0, "low": 99.0,
+            "close": 100.5, "volume": 1_000_000,
+            "dividend": 0.0, "split_ratio": 0.0,
+        }
+        for i in range(n)
+    ]
+
+
+@resp_lib.activate
+def test_pagination_concatenates_pages():
+    resp_lib.add(resp_lib.GET, OHLC_URL, json={"data": _make_rows(1000), "total": 2500, "limit": 1000, "offset": 0}, status=200)
+    resp_lib.add(resp_lib.GET, OHLC_URL, json={"data": _make_rows(1000), "total": 2500, "limit": 1000, "offset": 1000}, status=200)
+    resp_lib.add(resp_lib.GET, OHLC_URL, json={"data": _make_rows(500), "total": 2500, "limit": 1000, "offset": 2000}, status=200)
+
+    df = _make_ticker().history(start="2020-01-01", end="2027-01-01")
+    assert len(df) == 2500
+    assert len(resp_lib.calls) == 3
+    assert "offset=0"    in resp_lib.calls[0].request.url
+    assert "offset=1000" in resp_lib.calls[1].request.url
+    assert "offset=2000" in resp_lib.calls[2].request.url
+
+
+@resp_lib.activate
+def test_single_page_no_extra_requests():
+    resp_lib.add(resp_lib.GET, OHLC_URL, json={"data": _THREE_ROWS, "total": 3, "limit": 1000, "offset": 0}, status=200)
+    df = _make_ticker().history(start="2024-01-02", end="2024-01-05")
+    assert df.shape[0] == 3
+    assert len(resp_lib.calls) == 1

tidata-0.1.0/tidata/__init__.py

@@ -0,0 +1 @@
+"""tidata — TradeInsight data library. Use: from tidata.tifinance import Ticker"""

tidata-0.1.0/tidata/tifinance/__init__.py

@@ -0,0 +1,17 @@
+from .ticker import Ticker
+from .exceptions import (
+    APIError,
+    AuthenticationError,
+    InvalidParameterError,
+    RateLimitError,
+    TickerNotFoundError,
+)
+
+__all__ = [
+    "Ticker",
+    "APIError",
+    "AuthenticationError",
+    "InvalidParameterError",
+    "RateLimitError",
+    "TickerNotFoundError",
+]

tidata-0.1.0/tidata/tifinance/exceptions.py

@@ -0,0 +1,48 @@
+"""Typed exceptions for the tidata API client."""
+
+
+class APIError(Exception):
+    """Base exception for all TradeInsight API errors."""
+
+    def __init__(self, code: str, message: str) -> None:
+        self.code = code
+        self.message = message
+        super().__init__(f"[{code}] {message}")
+
+
+class TickerNotFoundError(APIError):
+    """Raised when the requested ticker symbol does not exist."""
+
+
+class AuthenticationError(APIError):
+    """Raised when the API key is missing, invalid, or expired."""
+
+
+class RateLimitError(APIError):
+    """Raised when the API rate limit has been exceeded."""
+
+
+class InvalidParameterError(APIError):
+    """Raised when a required or invalid parameter is supplied."""
+
+
+_CODE_MAP: dict[str, type[APIError]] = {
+    "TICKER_NOT_FOUND": TickerNotFoundError,
+    "TICKER_REQUIRED": InvalidParameterError,
+    "INVALID_TICKER": TickerNotFoundError,
+    "UNAUTHORIZED": AuthenticationError,
+    "FORBIDDEN": AuthenticationError,
+    "INVALID_API_KEY": AuthenticationError,
+    "API_KEY_REQUIRED": AuthenticationError,
+    "RATE_LIMIT_EXCEEDED": RateLimitError,
+    "TOO_MANY_REQUESTS": RateLimitError,
+    "INVALID_DATE": InvalidParameterError,
+    "INVALID_PARAMETER": InvalidParameterError,
+    "DATE_REQUIRED": InvalidParameterError,
+}
+
+
+def from_code(code: str, message: str) -> APIError:
+    """Return the most specific exception class for the given error code."""
+    exc_class = _CODE_MAP.get(code.upper(), APIError)
+    return exc_class(code, message)

tidata-0.1.0/tidata/tifinance/ticker.py

@@ -0,0 +1,263 @@
+"""TradeInsight API client — Ticker class with yfinance-compatible history()."""
+
+from __future__ import annotations
+
+import os
+from datetime import date, timedelta
+from typing import Optional
+
+import pandas as pd
+import requests
+
+from .exceptions import APIError, InvalidParameterError, from_code
+
+_DEFAULT_BASE_URL = "https://api.tradeinsight.info/trading-data/v1"
+
+_ADJ_COLUMN_MAP = {
+    "adj_open": "Open",
+    "adj_high": "High",
+    "adj_low": "Low",
+    "adj_close": "Close",
+    "adj_volume": "Volume",
+}
+
+_RAW_COLUMN_MAP = {
+    "open": "Open",
+    "high": "High",
+    "low": "Low",
+    "close": "Close",
+    "volume": "Volume",
+}
+
+_PERIOD_DELTAS: dict[str, timedelta] = {
+    "1d": timedelta(days=1),
+    "5d": timedelta(days=5),
+    "1mo": timedelta(days=30),
+    "3mo": timedelta(days=91),
+    "6mo": timedelta(days=182),
+    "1y": timedelta(days=365),
+    "2y": timedelta(days=730),
+    "5y": timedelta(days=1825),
+    "10y": timedelta(days=3650),
+    "max": timedelta(days=3650),  # treated as 10y
+}
+
+_VALID_PERIODS = frozenset(_PERIOD_DELTAS) | {"ytd"}
+
+
+def _parse_date(s: str, param_name: str) -> date:
+    try:
+        return date.fromisoformat(s)
+    except ValueError:
+        raise InvalidParameterError(
+            "INVALID_PARAMETER",
+            f"Invalid date for '{param_name}': {s!r}. Expected YYYY-MM-DD.",
+        )
+
+
+def _resolve_dates(
+    period: str | None,
+    start: str | None,
+    end: str | None,
+) -> tuple[str, str]:
+    """Convert period/start/end to an inclusive (start, end) pair for the API.
+
+    yfinance callers pass end as exclusive when they supply it explicitly —
+    we subtract 1 day. Internally computed ends use today as-is (inclusive).
+    """
+    today = date.today()
+
+    if period is not None and start is not None and end is not None:
+        raise ValueError(
+            "Setting period, start and end is nonsense. Set maximum 2 of them."
+        )
+
+    if period is not None:
+        p = period.lower()
+        if p not in _VALID_PERIODS:
+            raise InvalidParameterError(
+                "INVALID_PARAMETER",
+                f"Invalid period '{period}'. Valid: {', '.join(sorted(_VALID_PERIODS))}",
+            )
+
+        if p == "ytd":
+            return date(today.year, 1, 1).isoformat(), today.isoformat()
+
+        delta = _PERIOD_DELTAS[p]
+
+        if end is not None:
+            end_d = _parse_date(end, "end") - timedelta(days=1)  # exclusive -> inclusive
+            return (end_d - delta + timedelta(days=1)).isoformat(), end_d.isoformat()
+        elif start is not None:
+            start_d = _parse_date(start, "start")
+            end_d = min(start_d + delta - timedelta(days=1), today)
+            if end_d < start_d:
+                raise InvalidParameterError(
+                    "INVALID_PARAMETER",
+                    f"'start' ({start}) is in the future; no data available.",
+                )
+            return start_d.isoformat(), end_d.isoformat()
+        else:
+            return (today - delta).isoformat(), today.isoformat()
+
+    if start is None:
+        raise ValueError("Provide 'period' or 'start'.")
+
+    start_d = _parse_date(start, "start")
+    if end is None:
+        return start_d.isoformat(), today.isoformat()
+    else:
+        end_d = _parse_date(end, "end") - timedelta(days=1)  # exclusive -> inclusive
+        return start_d.isoformat(), end_d.isoformat()
+
+
+class Ticker:
+    """Client for a single ticker symbol against the TradeInsight API.
+
+    Parameters
+    ----------
+    symbol:
+        Ticker symbol, e.g. ``"AAPL"``.
+    api_key:
+        API key.  Falls back to the ``TIDATA_API_KEY`` environment variable.
+    base_url:
+        Override the API base URL.
+    timeout:
+        HTTP request timeout in seconds (default: 30).
+    """
+
+    def __init__(
+        self,
+        symbol: str,
+        api_key: Optional[str] = None,
+        base_url: str = _DEFAULT_BASE_URL,
+        timeout: int = 30,
+    ) -> None:
+        self.symbol = symbol.upper().strip()
+        self.api_key: Optional[str] = api_key or os.environ.get("TIDATA_API_KEY")
+        self.base_url = base_url.rstrip("/")
+        self.timeout = timeout
+        self._session = requests.Session()
+        if self.api_key:
+            self._session.headers.update({"Authorization": f"Bearer {self.api_key}"})
+
+    def history(
+        self,
+        period: str | None = None,
+        interval: str = "1d",
+        start: str | None = None,
+        end: str | None = None,
+        auto_adjust: bool = True,
+        actions: bool = True,
+        **kwargs,
+    ) -> pd.DataFrame:
+        """Fetch OHLCV history for this ticker.
+
+        Parameters
+        ----------
+        period:
+            Shorthand time period, e.g. ``"1y"``, ``"6mo"``, ``"ytd"``, ``"max"``.
+            Mutually exclusive with providing both ``start`` and ``end``.
+        interval:
+            Data interval. Only ``"1d"`` is currently supported.
+        start:
+            Start date ``YYYY-MM-DD`` (inclusive).
+        end:
+            End date ``YYYY-MM-DD`` (exclusive, yfinance convention).
+        auto_adjust:
+            When ``True`` (default), return split/dividend-adjusted prices.
+        actions:
+            When ``True`` (default), include Dividends and Stock Splits columns.
+        """
+        if interval != "1d":
+            raise InvalidParameterError(
+                "INVALID_PARAMETER",
+                "only interval='1d' is supported",
+            )
+
+        effective_period = period
+        if effective_period is None and start is None:
+            effective_period = "1mo"
+
+        resolved_start, resolved_end = _resolve_dates(effective_period, start, end)
+
+        params = {
+            "ticker": self.symbol,
+            "start": resolved_start,
+            "end": resolved_end,
+            "adjust_volume": "true" if auto_adjust else "false",
+        }
+        rows = self._fetch_all(params)
+        return self._build_dataframe(rows, auto_adjust=auto_adjust, actions=actions)
+
+    def _fetch_all(self, params: dict) -> list:
+        """Paginate through all result pages and return combined rows."""
+        rows: list = []
+        offset = 0
+        while True:
+            page_params = {**params, "limit": 1000, "offset": offset}
+            response = self._session.get(
+                f"{self.base_url}/ohlc",
+                params=page_params,
+                timeout=self.timeout,
+            )
+            if not response.ok:
+                self._raise_for_error(response)
+            data = response.json()
+            if isinstance(data, list):
+                page = data
+            elif isinstance(data, dict) and "data" in data:
+                page = data["data"]
+            else:
+                page = []
+            rows.extend(page)
+            if len(page) < 1000:
+                break
+            offset += 1000
+        return rows
+
+    def _build_dataframe(
+        self, rows: list, auto_adjust: bool, actions: bool
+    ) -> pd.DataFrame:
+        if not rows:
+            return self._empty_dataframe()
+        df = pd.DataFrame(rows)
+        col_map = _ADJ_COLUMN_MAP if auto_adjust else _RAW_COLUMN_MAP
+        df = df.rename(columns=col_map)
+        df["Dividends"] = pd.to_numeric(
+            df["dividend"] if "dividend" in df.columns else pd.Series(0.0, index=df.index),
+            errors="coerce",
+        ).fillna(0.0)
+        df["Stock Splits"] = pd.to_numeric(
+            df["split_ratio"] if "split_ratio" in df.columns else pd.Series(0.0, index=df.index),
+            errors="coerce",
+        ).fillna(0.0)
+        keep = ["date", "Open", "High", "Low", "Close", "Volume", "Dividends", "Stock Splits"]
+        existing = [c for c in keep if c in df.columns]
+        df = df[existing].copy()
+        df["date"] = pd.to_datetime(df["date"])
+        df = df.rename(columns={"date": "Date"}).set_index("Date")
+        df = df.sort_index()
+        for col in ["Open", "High", "Low", "Close", "Volume"]:
+            if col in df.columns:
+                df[col] = pd.to_numeric(df[col], errors="coerce")
+        if not actions:
+            df = df.drop(columns=["Dividends", "Stock Splits"], errors="ignore")
+        return df
+
+    def _raise_for_error(self, response: requests.Response) -> None:
+        try:
+            body = response.json()
+            code = body.get("code", f"HTTP_{response.status_code}")
+            message = body.get("message", response.text or "Unknown error")
+        except Exception:
+            code = f"HTTP_{response.status_code}"
+            message = response.text or "Unknown error"
+        raise from_code(code, message)
+
+    @staticmethod
+    def _empty_dataframe() -> pd.DataFrame:
+        return pd.DataFrame(
+            columns=["Open", "High", "Low", "Close", "Volume", "Dividends", "Stock Splits"],
+            index=pd.DatetimeIndex([], name="Date"),
+        )

tidata-0.1.0/tidata.egg-info/PKG-INFO

@@ -0,0 +1,87 @@
+Metadata-Version: 2.4
+Name: tidata
+Version: 0.1.0
+Summary: Python client for the TradeInsight API — yfinance-compatible Ticker.history()
+License: MIT
+Project-URL: Homepage, https://github.com/TradeInsight-Info/tidata
+Project-URL: Bug Tracker, https://github.com/TradeInsight-Info/tidata/issues
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.28
+Requires-Dist: pandas>=1.5
+Provides-Extra: test
+Requires-Dist: pytest>=7; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: responses>=0.23; extra == "test"
+
+# trading-data-py
+
+Python client for the [TradeInsight](https://tradeinsight.info) Trading Data Service API.
+Provides a `Ticker` class with a `history()` method that returns a pandas DataFrame
+with yfinance-compatible column names.
+
+## Installation
+
+```bash
+pip install trading-data-py
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/tradeinsight/trading-data-py.git
+cd trading-data-py
+pip install -e .
+```
+
+## Quick Start
+
+Set your API key in the environment:
+
+```bash
+export TRADING_DATA_API_KEY=your_key_here
+```
+
+Then use the client:
+
+```python
+from trading_data import Ticker
+
+# API key is read from TRADING_DATA_API_KEY env var automatically
+t = Ticker("AAPL")
+
+# Adjusted prices (yfinance-compatible)
+df = t.history(start="2024-01-01", end="2024-12-31")
+print(df.head())
+#                  Open        High         Low       Close      Volume  Dividends  Stock Splits
+# Date
+# 2024-01-02  184.210...  185.880...  183.430...  185.200...  79047200.0        0.0           0.0
+
+# Raw (unadjusted) prices
+df_raw = t.history(start="2024-01-01", end="2024-12-31", auto_adjust=False)
+```
+
+## Configuration
+
+| Parameter | Description | Default |
+|-----------|-------------|---------|
+| `symbol` | Ticker symbol (e.g. `"AAPL"`) | required |
+| `api_key` | API key — also reads `TRADING_DATA_API_KEY` env var | `None` |
+| `base_url` | API base URL | `https://api.tradeinsight.info` |
+| `timeout` | HTTP timeout in seconds | `30` |
+
+## Exceptions
+
+| Exception | API error code |
+|-----------|---------------|
+| `TickerNotFoundError` | `TICKER_NOT_FOUND`, `INVALID_TICKER` |
+| `AuthenticationError` | `UNAUTHORIZED`, `INVALID_API_KEY`, `API_KEY_REQUIRED` |
+| `RateLimitError` | `RATE_LIMIT_EXCEEDED`, `TOO_MANY_REQUESTS` |
+| `InvalidParameterError` | `TICKER_REQUIRED`, `INVALID_DATE`, `INVALID_PARAMETER` |
+| `APIError` | Any other error code (base class) |
+
+All exceptions inherit from `APIError` which exposes `.code` and `.message`.
+
+## License
+
+MIT

tidata-0.1.0/tidata.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+README.md
+pyproject.toml
+tests/test_ticker.py
+tidata/__init__.py
+tidata.egg-info/PKG-INFO
+tidata.egg-info/SOURCES.txt
+tidata.egg-info/dependency_links.txt
+tidata.egg-info/requires.txt
+tidata.egg-info/top_level.txt
+tidata/tifinance/__init__.py
+tidata/tifinance/exceptions.py
+tidata/tifinance/ticker.py

tidata-0.1.0/tidata.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

tidata-0.1.0/tidata.egg-info/requires.txt

@@ -0,0 +1,7 @@
+requests>=2.28
+pandas>=1.5
+
+[test]
+pytest>=7
+pytest-cov
+responses>=0.23

tidata-0.1.0/tidata.egg-info/top_level.txt

@@ -0,0 +1 @@
+tidata