stonepy 0.2.2__tar.gz → 0.2.3__tar.gz

{stonepy-0.2.2 → stonepy-0.2.3}/CHANGELOG.md

@@ -7,6 +7,38 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.3] - 2026-06-28
+
+### Added
+
+- A live contract-test suite (`tests/live/`) that exercises the generated client against the real
+  CIAPI demo account, run nightly and on demand by a new `live` GitHub Actions workflow. It is
+  skipped unless `STONEX_*` credentials are configured, so the normal test run is unaffected. It
+  caught the two response-parsing fixes below and a set of model mismatches tracked in
+  [#24](https://github.com/aaronmgn/stonepy/issues/24).
+
+### Fixed
+
+- Response models now parse CIAPI's v2 camelCase JSON. The generated models alias fields with the
+  catalog's PascalCase, but the v2 endpoints return camelCase, so with `extra="ignore"` the typed
+  client silently dropped the body to all-`None` (for example `watchlist.get_watchlists` and the
+  `client_preference` lookups returned empty). `ResponseModel` now matches response keys to field
+  aliases case-insensitively, at every nesting level.
+- Datetime fields now parse the ISO 8601 values v2 endpoints return (for example
+  `2026-06-29T21:05:00Z`), in addition to the v1 WCF `/Date(ms)/` format.
+- Correct four response field types the frozen catalog mistypes, verified against the live API, so
+  the affected endpoints parse instead of raising: news story ids are strings (Reuters URNs), a
+  news payload is a list of stories, a market carries a list of spreads, and market state is a
+  single enum. This fixes `news.get_news`, `news.get_news_headlines`,
+  `news.get_market_report_headlines`, `market.get_market_information`, and
+  `market.list_market_information_search`
+  ([#24](https://github.com/aaronmgn/stonepy/issues/24)).
+- `user_account.get_client_and_trading_account()` now returns the populated account data. The
+  endpoint returns the `AccountResult` fields flat at the top level, but the declared response
+  model wrapped them under an `account_result` key, so the typed client always parsed an all-`None`
+  result. The method now returns `AccountResult` directly (a return-type change)
+  ([#24](https://github.com/aaronmgn/stonepy/issues/24)).
+
 ## [0.2.2] - 2026-06-28
 
 ### Fixed
@@ -165,7 +197,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Generated endpoint bindings, DTO models, synchronous and asynchronous clients, retry handling,
   rate-limit handling, and typed resource groups.
 
-[Unreleased]: https://github.com/aaronmgn/stonepy/compare/v0.2.2...HEAD
+[Unreleased]: https://github.com/aaronmgn/stonepy/compare/v0.2.3...HEAD
+[0.2.3]: https://github.com/aaronmgn/stonepy/releases/tag/v0.2.3
 [0.2.2]: https://github.com/aaronmgn/stonepy/releases/tag/v0.2.2
 [0.2.1]: https://github.com/aaronmgn/stonepy/releases/tag/v0.2.1
 [0.2.0]: https://github.com/aaronmgn/stonepy/releases/tag/v0.2.0

{stonepy-0.2.2 → stonepy-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stonepy
-Version: 0.2.2
+Version: 0.2.3
 Summary: Python client for the StoneX (CIAPI) v2 trading API
 Project-URL: Homepage, https://github.com/aaronmgn/stonepy
 Project-URL: Repository, https://github.com/aaronmgn/stonepy

{stonepy-0.2.2 → stonepy-0.2.3}/pyproject.toml

@@ -80,6 +80,9 @@ files = ["src", "tests"]
 [tool.pytest.ini_options]
 addopts = "-q"
 testpaths = ["tests"]
+markers = [
+    "live: exercises endpoints against the real CIAPI demo account (needs STONEX_* creds; skipped otherwise)",
+]
 
 [tool.coverage.run]
 source = ["src/stonepy"]

{stonepy-0.2.2 → stonepy-0.2.3}/src/stonepy/__init__.py

@@ -18,7 +18,7 @@ from stonepy._core.errors import (
 )
 from stonepy.client import AsyncStoneXClient, StoneXClient
 
-__version__ = "0.2.2"
+__version__ = "0.2.3"
 
 __all__ = [
     "AsyncStoneXClient",

{stonepy-0.2.2 → stonepy-0.2.3}/src/stonepy/_core/codec.py

@@ -43,9 +43,16 @@ def parse_wcf_date(value: Any) -> datetime | None:
         ms = value
     elif isinstance(value, str):
         m = _WCF_RE.fullmatch(value)
-        if not m:
-            raise ValueError(f"not a WCF date: {value!r}")
-        ms = int(m.group(1))
+        if m:
+            ms = int(m.group(1))
+        else:
+            # CIAPI v2 endpoints return ISO 8601 (e.g. "2026-06-29T21:05:00Z") rather than the
+            # v1 WCF "/Date(ms)/" format; accept both so one codec serves both API versions.
+            try:
+                parsed = datetime.fromisoformat(value.replace("Z", "+00:00"))
+            except ValueError:
+                raise ValueError(f"not a WCF date: {value!r}") from None
+            return _ensure_timezone_aware(parsed)
     else:
         raise ValueError(f"not a WCF date: {value!r}")
     if ms == WCF_MINVALUE_MS:

{stonepy-0.2.2 → stonepy-0.2.3}/src/stonepy/_core/config.py

@@ -11,7 +11,7 @@ from stonepy._core.logging import safe_repr
 from stonepy._core.status import StatusDecoder, default_status_decoder
 
 _T = TypeVar("_T")
-_FALLBACK_VERSION = "0.2.2"
+_FALLBACK_VERSION = "0.2.3"
 
 
 def _default_user_agent() -> str:

{stonepy-0.2.2 → stonepy-0.2.3}/src/stonepy/_core/models.py

@@ -2,7 +2,9 @@
 
 from __future__ import annotations
 
-from pydantic import BaseModel, ConfigDict
+from typing import Any
+
+from pydantic import BaseModel, ConfigDict, model_validator
 
 from stonepy._core.codec import StoneXDateTime
 
@@ -42,10 +44,34 @@ class ResponseModel(StoneXModel):
 
     Ignoring extras lets the client tolerate new or undocumented fields the API adds without
     raising, so responses keep parsing across upstream changes.
+
+    Response keys are matched to field aliases case-insensitively: CIAPI's v2 endpoints return
+    camelCase JSON (for example ``clientAccountWatchlists``) while the generated models alias
+    fields with the catalog's PascalCase (``ClientAccountWatchlists``). Without this, an
+    exact-case match would miss every camelCase key and ``extra="ignore"`` would silently drop
+    the data, leaving the parsed model empty. The remap runs at every nesting level because each
+    nested model is itself a ``ResponseModel``.
     """
 
     model_config = ConfigDict(populate_by_name=True, extra="ignore")
 
+    @model_validator(mode="before")
+    @classmethod
+    def _match_keys_case_insensitively(cls, data: Any) -> Any:
+        if not isinstance(data, dict):
+            return data
+        canonical: dict[str, str] = {}
+        for name, field in cls.model_fields.items():
+            target = field.alias or name
+            canonical.setdefault(name.lower(), target)
+            if field.alias:
+                canonical.setdefault(field.alias.lower(), target)
+        remapped: dict[str, Any] = {}
+        for key, value in data.items():
+            target = canonical.get(key.lower(), key) if isinstance(key, str) else key
+            remapped.setdefault(target, value)
+        return remapped
+
 
 class PassthroughResponseModel(StoneXModel):
     """Response model that retains unknown fields (``extra="allow"``).

{stonepy-0.2.2 → stonepy-0.2.3}/src/stonepy/_endpoints/user_account.py

@@ -7,7 +7,7 @@ from stonepy._core.endpoint import AuthPolicy, EndpointSpec, Param
 from stonepy._core.models import ResponseModel
 from stonepy._core.pipeline import CallContext
 from stonepy.models import (
-    AccountInformationResponseDTOv2,
+    AccountResult,
     ApiAccountInformationSaveRequestDTO,
     ApiAccountInformationSaveResponseDTO,
     ApiGetCommunityActionsResponseDTO,
@@ -43,7 +43,7 @@ async def aget_charting_enabled(ctx: CallContext, id: str) -> ResponseModel:
     return await ctx.ainvoke(GET_CHARTING_ENABLED_SPEC, path_params={"id": id})
 
 
-GET_CLIENT_AND_TRADING_ACCOUNT_SPEC: EndpointSpec[AccountInformationResponseDTOv2] = EndpointSpec(
+GET_CLIENT_AND_TRADING_ACCOUNT_SPEC: EndpointSpec[AccountResult] = EndpointSpec(
     name="GetClientAndTradingAccount v2",
     method="GET",
     path="/v2/UserAccount/ClientAndTradingAccount",
@@ -51,11 +51,11 @@ GET_CLIENT_AND_TRADING_ACCOUNT_SPEC: EndpointSpec[AccountInformationResponseDTOv
     idempotent=True,
     auth_policy=AuthPolicy.SESSION,
     rate_limit_bucket="user_account",
-    response_model=AccountInformationResponseDTOv2,
+    response_model=AccountResult,
 )
 
 
-def get_client_and_trading_account(ctx: CallContext) -> AccountInformationResponseDTOv2:
+def get_client_and_trading_account(ctx: CallContext) -> AccountResult:
     """
     Returns the User's ClientAccountId and a list of their TradingAccounts. There are no
     parameters for this call.
@@ -63,7 +63,7 @@ def get_client_and_trading_account(ctx: CallContext) -> AccountInformationRespon
     return ctx.invoke(GET_CLIENT_AND_TRADING_ACCOUNT_SPEC)
 
 
-async def aget_client_and_trading_account(ctx: CallContext) -> AccountInformationResponseDTOv2:
+async def aget_client_and_trading_account(ctx: CallContext) -> AccountResult:
     """
     Returns the User's ClientAccountId and a list of their TradingAccounts. There are no
     parameters for this call.

{stonepy-0.2.2 → stonepy-0.2.3}/src/stonepy/_generator/emit_contract.py

@@ -15,13 +15,12 @@ from stonepy._generator.catalog import (
     TypeRecord,
     is_enum_record,
     python_name,
-    python_type,
 )
 from stonepy._generator.emit_endpoints import _is_idempotent as _endpoint_is_idempotent
 from stonepy._generator.emit_endpoints import _params as _endpoint_params
 from stonepy._generator.emit_endpoints import endpoint_spec_name, resolved_path, target_module
 from stonepy._generator.emit_models import _cyclic_ref_fields, _lookup_enum_records
-from stonepy._generator.render import BANNER, field_name, format_python
+from stonepy._generator.render import BANNER, field_name, format_python, resolved_field_annotation
 
 __all__ = ["emit_contract_tests"]
 
@@ -418,7 +417,7 @@ def _model_payload(
         if _is_optional_property(prop) or raw_name in optional_here:
             continue
 
-        annotation = python_type(prop, known_names)
+        annotation = resolved_field_annotation(rec.name, prop, known_names)
         sample = _sample_value(
             annotation,
             enum_samples=enum_samples,
@@ -450,7 +449,7 @@ def _construct_payload(
         if name is None or _is_optional_property(prop) or raw_name in optional_here:
             continue
 
-        annotation = python_type(prop, known_names)
+        annotation = resolved_field_annotation(rec.name, prop, known_names)
         payload[name] = _construct_sample_value(
             annotation,
             enum_samples=enum_samples,

{stonepy-0.2.2 → stonepy-0.2.3}/src/stonepy/_generator/emit_endpoints.py

@@ -57,6 +57,16 @@ _OPTIONAL_PARAM_OVERRIDES: dict[tuple[str, str], frozenset[str]] = {
     ("cfd", "ListCfdMarkets"): frozenset({"marketName", "marketCode"}),
 }
 
+# Per-endpoint response-model corrections for catalog gaps where the declared response type does not
+# match the live wire shape. Verified against the live CIAPI demo. Keyed by (target_module, endpoint
+# name); the value is the catalog data-type the endpoint actually returns.
+_RESPONSE_MODEL_OVERRIDES: dict[tuple[str, str], str] = {
+    # The account lookup returns the AccountResult fields flat at the top level (clientAccounts,
+    # tradingAccounts, legalParties, ...), not wrapped under an "AccountResult" key as the declared
+    # AccountInformationResponseDTO v2 expects, so the wrapper always parsed to all-None.
+    ("user_account", "GetClientAndTradingAccount v2"): "AccountResult",
+}
+
 # Per-endpoint path corrections for catalog gaps the systematic v2 de-doubling in resolved_path()
 # cannot cover (the documented uri_template is itself wrong). Each value was verified against the
 # live CIAPI demo by matching the response to the endpoint's typed DTO shape. Keyed by
@@ -275,8 +285,11 @@ def _binding(
     function_name = _function_name(rec)
     known_models = set(known_model_names) if known_model_names is not None else None
     request_model = _known_type(rec.request_type, known_models)
-    response_model = _response_model_type(rec.response_type, known_models)
-    unresolved_response_model = _unresolved_response_model(rec.response_type, known_models)
+    response_type_name = _RESPONSE_MODEL_OVERRIDES.get(
+        (target_module(rec.target), rec.name), rec.response_type
+    )
+    response_model = _response_model_type(response_type_name, known_models)
+    unresolved_response_model = _unresolved_response_model(response_type_name, known_models)
     optional_overrides = _OPTIONAL_PARAM_OVERRIDES.get(
         (target_module(rec.target), rec.name), frozenset()
     )

{stonepy-0.2.2 → stonepy-0.2.3}/src/stonepy/_generator/render.py

@@ -236,6 +236,41 @@ class _RenderedField:
         self.doc = doc
 
 
+# Field-type corrections for catalog data-type errors confirmed against the live API. The frozen
+# catalog mistypes these response fields; each value is the real wire type observed live by the
+# contract suite (optionality is applied separately, so give the base type). Keyed by
+# (catalog type name, property name). See https://github.com/aaronmgn/stonepy/issues/24.
+_FIELD_TYPE_OVERRIDES: dict[tuple[str, str], str] = {
+    # News story ids are Reuters URN strings (e.g. "urn:newsml:reuters.com:..."), not ints.
+    ("NewsHeadlineDTO", "StoryId"): "str",
+    # The news payload is an array of stories, not a single one.
+    ("NewsResponseDTO", "News"): "list[NewsDTO]",
+    # A market carries a list of spreads (by time), not a single spread. Both the full market-info
+    # DTO and the search-result DTO embed the same field.
+    ("ApiMarketInformationDTOv2", "MarketSpreads"): "list[ApiMarketSpreadDTO]",
+    ("MarketSearchResultDTO", "MarketSpreads"): "list[ApiMarketSpreadDTO]",
+    # Market state is a single enum value, not a list.
+    ("MarketPricesDTO", "MarketState"): "MarketState",
+}
+
+
+def resolved_field_annotation(
+    type_name: str, prop: Mapping[str, Any], known_names: set[str]
+) -> str:
+    """Return a field's base annotation, applying confirmed catalog field-type corrections.
+
+    Shared by model rendering and contract-test sample generation so the corrected models and the
+    samples that exercise them agree on the field type.
+    """
+
+    raw_name = prop.get("name")
+    if isinstance(raw_name, str):
+        override = _FIELD_TYPE_OVERRIDES.get((type_name, raw_name))
+        if override is not None:
+            return override
+    return python_type(prop, known_names)
+
+
 def _model_fields(
     rec: TypeRecord,
     known_names: set[str],
@@ -254,7 +289,7 @@ def _model_fields(
             continue
 
         name = _unique_field_name(name, used_names)
-        annotation = python_type(prop, known_names)
+        annotation = resolved_field_annotation(rec.name, prop, known_names)
         optional = (
             all_optional
             or _is_optional_property(prop)

{stonepy-0.2.2 → stonepy-0.2.3}/src/stonepy/models/ApiMarketInformationDTOv2.py

@@ -136,7 +136,7 @@ class ApiMarketInformationDTOv2(ResponseModel):
         default=None, alias="MarketBreakTimes"
     )
     """Breaks throughout each trading day (Day is specified as 'DayOfWeek')"""
-    market_spreads: ApiMarketSpreadDTO | None = Field(default=None, alias="MarketSpreads")
+    market_spreads: list[ApiMarketSpreadDTO] | None = Field(default=None, alias="MarketSpreads")
     """Market spreads during each trading day"""
     guaranteed_order_premium: Decimal | None = Field(default=None, alias="GuaranteedOrderPremium")
     """The premium paid for a guaranteed order"""

{stonepy-0.2.2 → stonepy-0.2.3}/src/stonepy/models/MarketPricesDTO.py

@@ -19,7 +19,7 @@ class MarketPricesDTO(ResponseModel):
     """Bid price"""
     offer_price: Decimal | None = Field(default=None, alias="OfferPrice")
     """Offer price"""
-    market_state: list[MarketState] | None = Field(default=None, alias="MarketState")
+    market_state: MarketState | None = Field(default=None, alias="MarketState")
     """List of market states"""
 
 

{stonepy-0.2.2 → stonepy-0.2.3}/src/stonepy/models/MarketSearchResultDTO.py

@@ -139,7 +139,7 @@ class MarketSearchResultDTO(ResponseModel):
         default=None, alias="MarketBreakTimes"
     )
     """Breaks throughout each trading day (Day is specified as 'DayOfWeek') ."""
-    market_spreads: ApiMarketSpreadDTO | None = Field(default=None, alias="MarketSpreads")
+    market_spreads: list[ApiMarketSpreadDTO] | None = Field(default=None, alias="MarketSpreads")
     """Market spreads during each trading day."""
     guaranteed_order_premium: Decimal | None = Field(default=None, alias="GuaranteedOrderPremium")
     """The premium paid for a guaranteed order."""

{stonepy-0.2.2 → stonepy-0.2.3}/src/stonepy/models/NewsHeadlineDTO.py

@@ -11,7 +11,7 @@ from stonepy._core.models import ResponseModel, StoneXDateTime
 class NewsHeadlineDTO(ResponseModel):
     """A headline for a News story."""
 
-    story_id: int | None = Field(default=None, alias="StoryId")
+    story_id: str | None = Field(default=None, alias="StoryId")
     """The unique identifier for a news story."""
     headline: str | None = Field(default=None, alias="Headline")
     """The news story headline."""

{stonepy-0.2.2 → stonepy-0.2.3}/src/stonepy/models/NewsResponseDTO.py

@@ -16,7 +16,7 @@ if TYPE_CHECKING:
 class NewsResponseDTO(ResponseModel):
     """The response containing the news story details from the GetNews request."""
 
-    news: NewsDTO | None = Field(default=None, alias="News")
+    news: list[NewsDTO] | None = Field(default=None, alias="News")
     """The details of the news story."""
 
 

{stonepy-0.2.2 → stonepy-0.2.3}/src/stonepy/resources/user_account/_sync/get_client_and_trading_account.py

@@ -5,13 +5,13 @@ from __future__ import annotations
 
 from stonepy._core.resource import BaseResource
 from stonepy._endpoints import user_account as _ep
-from stonepy.models import AccountInformationResponseDTOv2
+from stonepy.models import AccountResult
 
 
 class _GetClientAndTradingAccountMixin(BaseResource):
     def get_client_and_trading_account(
         self,
-    ) -> AccountInformationResponseDTOv2:
+    ) -> AccountResult:
         """
         Returns the User's ClientAccountId and a list of their TradingAccounts. There are
         no parameters for this call.

{stonepy-0.2.2 → stonepy-0.2.3}/src/stonepy/resources/user_account/get_client_and_trading_account.py

@@ -4,13 +4,13 @@ from __future__ import annotations
 
 from stonepy._core.resource import BaseResource
 from stonepy._endpoints import user_account as _ep
-from stonepy.models import AccountInformationResponseDTOv2
+from stonepy.models import AccountResult
 
 
 class _GetClientAndTradingAccountMixin(BaseResource):
     async def get_client_and_trading_account(
         self,
-    ) -> AccountInformationResponseDTOv2:
+    ) -> AccountResult:
         """
         Returns the User's ClientAccountId and a list of their TradingAccounts. There are
         no parameters for this call.