sahiapi 0.1.0__tar.gz → 0.2.0__tar.gz

sahiapi-0.2.0/CHANGELOG.md

@@ -0,0 +1,69 @@
+# Changelog
+
+All notable changes to this project are documented here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the project aims to
+follow [Semantic Versioning](https://semver.org/) once it reaches `1.0.0`.
+
+## [Unreleased]
+
+## [0.2.0] - 2026-10-22
+
+First public release. Includes everything listed under 0.1.0.
+
+### Added
+- `SahiMaintenanceException` (a `SahiServerException`) for `503 UNDER_MAINTENANCE`,
+  the margin endpoints' daily 04:45–07:00 IST window, with a hint that says so
+  instead of "retry after a short wait".
+
+### Changed
+- `SahiFeed` cache reads are `last_ltp`, `last_quote` and `last_depth` (were
+  `get_ltp`, `get_quote`, `get_depth`), so they no longer share a name with the
+  REST calls `SahiAPI.get_ltp` / `get_quotes` that have a different signature.
+- `get_ltp` / `get_quotes` no longer cap the id list locally. The SDK said 500
+  while the API allows 100, which is the trouble with a limit baked into a
+  release: the server's `400 VALIDATION_FAILED` names the limit, and the
+  docstrings state it.
+- The scrip master downloads from the published URL by default
+  (`https://assets.sahi.com/external/instruments.csv`); `scrip_master_url=` and
+  `SAHI_SCRIP_MASTER_URL` now override it rather than being required.
+- Tick dicts carry every field, in the shape the REST endpoints return: an
+  `optional` field the server did not send is `None` (an index's
+  `last_trade_time`, a stock's `open_interest`), an empty order book is `[]`, an
+  unset counter is `0`. Previously these keys were missing.
+- Licensed under MIT (previously proprietary).
+- The PyPI page is a short overview that points to https://docs.sahi.com/ for
+  guides and the API reference; development notes moved to `CONTRIBUTING.md`.
+
+### Fixed
+- `SahiFeed` sends a `User-Agent` on the WebSocket upgrade. Production refused
+  the handshake without one (HTTP 403), so neither stream connected.
+- A 4xx with no API error envelope (the edge refusing an over-long URL, e.g.
+  hundreds of instrument ids in one `get_ltp`) is a plain `SahiAPIException`
+  that says the request never reached the API, not a `SahiAuthorisationException`
+  with a missing-scope hint.
+
+## [0.1.0] - 2026-10-18
+
+Pre-launch placeholder; yanked on PyPI. Use 0.2.0 or later.
+
+### Added
+- Initial SDK: authentication (`SahiAPI.from_credentials` for the one-call path,
+  `get_access_token` + `SahiAPI(token)` for a shared token, rotation via
+  `set_access_token`), and full REST coverage — orders, portfolio, funds,
+  account, market data (with `get_candle_history`) and the scrip master.
+- `SahiFeed` for the two WebSocket streams: the protobuf tick stream (LTP, quote,
+  depth) and JSON order updates, with reconnect, subscription replay and a local
+  tick cache whose reads raise the stream's error once it has closed fatally.
+- A typed exception hierarchy mapped from `(status, host, code)`. Every API
+  exception (`SahiAPIException`) carries the server `status`, `code`,
+  `message`, a `request_id` and an actionable `hint`, all included in `str()`;
+  a feed exception carries the WebSocket `close_code` instead.
+- Every wire enum as a constant and `SahiAPI` class attribute.
+- `on_connect` on the order stream for the API's Stream + Snapshot bootstrap;
+  transparent reconnect on heartbeat (4408) and slow-consumer (4409) drops.
+- Packaging, CI (ruff, mypy strict, pytest on Python 3.9–3.13) and a
+  trusted-publishing release workflow.
+
+[Unreleased]: https://github.com/aarityatech/sahi-python/compare/sahiapi/v0.2.0...HEAD
+[0.2.0]: https://github.com/aarityatech/sahi-python/compare/sahiapi/v0.1.0...sahiapi/v0.2.0
+[0.1.0]: https://github.com/aarityatech/sahi-python/releases/tag/sahiapi/v0.1.0

sahiapi-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Aaritya Technologies Private Limited
+
+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.

sahiapi-0.2.0/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.5
+Name: sahiapi
+Version: 0.2.0
+Summary: The official Python client library for the Sahi APIs.
+Project-URL: Homepage, https://docs.sahi.com/
+Project-URL: Documentation, https://docs.sahi.com/sdk/python/
+Author-email: Aaritya Technologies <customercare@sahi.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: bse,market-data,nse,options,sahi,stocks,trading
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: httpx>=0.27
+Requires-Dist: protobuf>=4.25
+Requires-Dist: websocket-client>=1.7
+Provides-Extra: dev
+Requires-Dist: mypy>=1.11; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# sahiapi
+
+The official Python SDK for the [Sahi trading APIs](https://docs.sahi.com/).
+
+Build trading and investing workflows in Python: place and manage orders, track
+holdings, positions and funds, pull quotes, candles and option chains, and
+receive live ticks and order updates over WebSocket.
+
+[Sahi](https://www.sahi.com/) © 2026. Released under the [MIT License](https://opensource.org/license/mit).
+
+## Documentation
+
+- [Python SDK documentation](https://docs.sahi.com/sdk/python/)
+- [Sahi API reference](https://docs.sahi.com/)
+- [Authentication and API keys](https://docs.sahi.com/api/v1/reference/authentication/)
+- [Orders API reference](https://docs.sahi.com/api/v1/reference/orders/)
+
+## Features
+
+- **Orders**: place, modify and cancel orders, and read the order book and the
+  trades behind each order.
+- **Portfolio**: holdings and open positions.
+- **Funds**: available balance and margin in use.
+- **Market data**: LTP and quotes for many instruments in one call, historical
+  candles, option expiries and option chains.
+- **Live streams**: `SahiFeed` streams LTP, quotes and market depth, plus
+  order updates, and reconnects and resubscribes on its own.
+- **Typed errors**: every API failure raises an exception carrying the HTTP
+  status, error code, request id and a hint on how to fix it.
+
+## Installation
+
+```bash
+pip install sahiapi
+```
+
+Requires Python 3.9 or newer.
+
+## Quickstart
+
+Create an API key in your Sahi account and approve it for the trading day, then
+connect:
+
+```python
+import os
+from sahiapi import SahiAPI
+
+api = SahiAPI.from_credentials(
+    key_id=os.environ["SAHI_KEY_ID"],
+    secret=os.environ["SAHI_SECRET"],
+)
+print(api.get_profile())
+print(api.get_funds())
+```
+
+### Example: place a limit order
+
+Prices are in paise, so ₹2,499.55 is `249955`.
+
+```python
+response = api.place_order(
+    exchange_segment=SahiAPI.EXCHANGE_SEGMENT_NSE,
+    symbol="RELIANCE",
+    txn_type=SahiAPI.TXN_TYPE_BUY,
+    qty=1,
+    order_type=SahiAPI.ORDER_TYPE_LIMIT,
+    product=SahiAPI.PRODUCT_DELIVERY,
+    validity=SahiAPI.VALIDITY_DAY,
+    price=249955,
+)
+order_id = response["order_ids"][0]
+print(api.get_order_detail(order_id))
+```
+
+See the [Python SDK documentation](https://docs.sahi.com/sdk/python/) for streaming, market data and
+every other endpoint.

sahiapi-0.2.0/README.md

@@ -0,0 +1,76 @@
+# sahiapi
+
+The official Python SDK for the [Sahi trading APIs](https://docs.sahi.com/).
+
+Build trading and investing workflows in Python: place and manage orders, track
+holdings, positions and funds, pull quotes, candles and option chains, and
+receive live ticks and order updates over WebSocket.
+
+[Sahi](https://www.sahi.com/) © 2026. Released under the [MIT License](https://opensource.org/license/mit).
+
+## Documentation
+
+- [Python SDK documentation](https://docs.sahi.com/sdk/python/)
+- [Sahi API reference](https://docs.sahi.com/)
+- [Authentication and API keys](https://docs.sahi.com/api/v1/reference/authentication/)
+- [Orders API reference](https://docs.sahi.com/api/v1/reference/orders/)
+
+## Features
+
+- **Orders**: place, modify and cancel orders, and read the order book and the
+  trades behind each order.
+- **Portfolio**: holdings and open positions.
+- **Funds**: available balance and margin in use.
+- **Market data**: LTP and quotes for many instruments in one call, historical
+  candles, option expiries and option chains.
+- **Live streams**: `SahiFeed` streams LTP, quotes and market depth, plus
+  order updates, and reconnects and resubscribes on its own.
+- **Typed errors**: every API failure raises an exception carrying the HTTP
+  status, error code, request id and a hint on how to fix it.
+
+## Installation
+
+```bash
+pip install sahiapi
+```
+
+Requires Python 3.9 or newer.
+
+## Quickstart
+
+Create an API key in your Sahi account and approve it for the trading day, then
+connect:
+
+```python
+import os
+from sahiapi import SahiAPI
+
+api = SahiAPI.from_credentials(
+    key_id=os.environ["SAHI_KEY_ID"],
+    secret=os.environ["SAHI_SECRET"],
+)
+print(api.get_profile())
+print(api.get_funds())
+```
+
+### Example: place a limit order
+
+Prices are in paise, so ₹2,499.55 is `249955`.
+
+```python
+response = api.place_order(
+    exchange_segment=SahiAPI.EXCHANGE_SEGMENT_NSE,
+    symbol="RELIANCE",
+    txn_type=SahiAPI.TXN_TYPE_BUY,
+    qty=1,
+    order_type=SahiAPI.ORDER_TYPE_LIMIT,
+    product=SahiAPI.PRODUCT_DELIVERY,
+    validity=SahiAPI.VALIDITY_DAY,
+    price=249955,
+)
+order_id = response["order_ids"][0]
+print(api.get_order_detail(order_id))
+```
+
+See the [Python SDK documentation](https://docs.sahi.com/sdk/python/) for streaming, market data and
+every other endpoint.

{sahiapi-0.1.0 → sahiapi-0.2.0}/pyproject.toml

@@ -1,5 +1,6 @@
 [build-system]
-requires = ["hatchling", "hatch-vcs"]
+# 1.27 is the first hatchling to write PEP 639 license metadata.
+requires = ["hatchling>=1.27", "hatch-vcs"]
 build-backend = "hatchling.build"
 
 [project]
@@ -10,11 +11,11 @@ dynamic = ["version"]
 description = "The official Python client library for the Sahi APIs."
 readme = "README.md"
 requires-python = ">=3.9"
-license = { file = "LICENSE" }
-authors = [{ name = "Aaritya Technologies" }]
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Aaritya Technologies", email = "customercare@sahi.com" }]
 keywords = ["sahi", "trading", "stocks", "options", "market-data", "nse", "bse"]
 classifiers = [
-    "Development Status :: 3 - Alpha",
     "Intended Audience :: Developers",
     "Intended Audience :: Financial and Insurance Industry",
     "Operating System :: OS Independent",
@@ -53,8 +54,7 @@ sahiapi-uat = { path = "tools/sahiapi_uat" }
 
 [project.urls]
 Homepage = "https://docs.sahi.com/"
-Documentation = "https://docs.sahi.com/"
-Repository = "https://github.com/aarityatech/sahi-python"
+Documentation = "https://docs.sahi.com/sdk/python/"
 
 [tool.hatch.version]
 source = "vcs"

{sahiapi-0.1.0 → sahiapi-0.2.0}/src/sahiapi/__init__.py

@@ -37,6 +37,7 @@ from .sahi.exceptions import (
     SahiInvalidOrderStateException,
     SahiIpNotAllowedException,
     SahiKeyNotApprovedException,
+    SahiMaintenanceException,
     SahiNotFoundException,
     SahiOrderNotFoundException,
     SahiRateLimitException,
@@ -73,6 +74,7 @@ __all__ = [
     "SahiInvalidOrderStateException",
     "SahiIpNotAllowedException",
     "SahiKeyNotApprovedException",
+    "SahiMaintenanceException",
     "SahiNotFoundException",
     "SahiOrderNotFoundException",
     "SahiRateLimitException",

{sahiapi-0.1.0 → sahiapi-0.2.0}/src/sahiapi/sahi/client.py

@@ -95,10 +95,10 @@ class SahiAPI(_Orders, _Portfolio, _Funds, _Account, _MarketData, _Instruments):
         token: The response of :func:`sahiapi.get_access_token` (preferred), or
             just its ``access_token`` string. Use :meth:`from_credentials` to go
             straight from an API key to a client.
-        scrip_master_url: The scrip-master CSV download URL, needed for the
-            instrument lookups. Defaults to ``$SAHI_SCRIP_MASTER_URL``. The URL
-            is not in the public docs; it is provided when your API access is set
-            up.
+        scrip_master_url: The scrip-master CSV download URL the instrument
+            lookups read. Defaults to ``$SAHI_SCRIP_MASTER_URL`` if set, else the
+            published file (``env.SCRIP_MASTER_URL``); only another copy of the
+            file needs this.
         timeout: Default per-request timeout in seconds.
 
     The enum values the API uses are available as class attributes, e.g.
@@ -194,7 +194,9 @@ class SahiAPI(_Orders, _Portfolio, _Funds, _Account, _MarketData, _Instruments):
         self._http = HttpClient(
             env.API_BASE_URL, host=HOST_API, access_token=access_token, timeout=timeout
         )
-        self._scrip_master_url = scrip_master_url or os.environ.get(_ENV_SCRIP_MASTER_URL)
+        self._scrip_master_url = (
+            scrip_master_url or os.environ.get(_ENV_SCRIP_MASTER_URL) or env.SCRIP_MASTER_URL
+        )
         self._token = state
 
     # -- authentication -------------------------------------------------------
@@ -221,7 +223,7 @@ class SahiAPI(_Orders, _Portfolio, _Funds, _Account, _MarketData, _Instruments):
             key_id: The key id from your Sahi account.
             secret: The secret shown once at key creation.
             scopes: Optional subset of the key's scopes to narrow the token to.
-            scrip_master_url: Scrip-master CSV URL (default ``$SAHI_SCRIP_MASTER_URL``).
+            scrip_master_url: Scrip-master CSV URL, as on the constructor.
             timeout: Default per-request timeout in seconds, also used for the mint.
         """
         token = auth.get_access_token(key_id, secret, scopes=scopes, timeout=timeout)

{sahiapi-0.1.0 → sahiapi-0.2.0}/src/sahiapi/sahi/env.py

@@ -1,7 +1,10 @@
 """The hosts the SDK talks to.
 
 The SDK always talks to the production Sahi hosts. There is no argument or
-environment variable for pointing it anywhere else.
+environment variable for pointing it anywhere else. The scrip master is the one
+exception: it is a static file whose URL the API reference publishes, and
+``SahiAPI(scrip_master_url=...)`` or ``SAHI_SCRIP_MASTER_URL`` can point at
+another copy.
 
 The two hosts are separate: the **API** host serves everything under ``/v1``,
 and the **auth** host serves ``/api/v1/apikeys/token``. WebSocket URLs are
@@ -17,6 +20,7 @@ from __future__ import annotations
 __all__ = [
     "API_BASE_URL",
     "AUTH_BASE_URL",
+    "SCRIP_MASTER_URL",
     "websocket_base_url",
 ]
 
@@ -24,6 +28,8 @@ __all__ = [
 API_BASE_URL = "https://direct.sahi.com"
 #: The auth host (serves the token endpoint). No trailing slash.
 AUTH_BASE_URL = "https://apis.sahi.com"
+#: The scrip-master CSV, as published on the API reference's Scrip master page.
+SCRIP_MASTER_URL = "https://assets.sahi.com/external/instruments.csv"
 
 
 def websocket_base_url(api_base_url: str) -> str:

{sahiapi-0.1.0 → sahiapi-0.2.0}/src/sahiapi/sahi/exceptions.py

@@ -40,6 +40,7 @@ __all__ = [
     "SahiInvalidOrderStateException",
     "SahiIpNotAllowedException",
     "SahiKeyNotApprovedException",
+    "SahiMaintenanceException",
     "SahiNotFoundException",
     "SahiOrderNotFoundException",
     "SahiRateLimitException",
@@ -256,6 +257,17 @@ class SahiServerException(SahiAPIException):
     )
 
 
+class SahiMaintenanceException(SahiServerException):
+    """503 ``UNDER_MAINTENANCE``: the daily 04:45-07:00 IST maintenance window.
+
+    The margin endpoints refuse requests while the OMS runs its beginning-of-day
+    processing. Nothing is wrong with the request, and a short-wait retry is
+    pointless: wait for the window to end.
+    """
+
+    hint = "The OMS is in its daily 04:45-07:00 IST maintenance window. Retry after 07:00 IST."
+
+
 class SahiTimeoutException(SahiAPIException):
     """No response arrived within the timeout.
 
@@ -348,6 +360,7 @@ def exception_for(
     message: str | None = None,
     request_id: str | None = None,
     retry_after: int | None = None,
+    envelope: bool = True,
 ) -> SahiAPIException:
     """Build the right :class:`SahiAPIException` for a non-2xx response.
 
@@ -367,10 +380,24 @@ def exception_for(
         message: The envelope ``message``.
         request_id: The request id to attach for support.
         retry_after: Parsed ``Retry-After`` seconds, for 429s.
+        envelope: Whether the body was the API's JSON error envelope. A 4xx
+            without one never reached the API: the edge (CloudFront's WAF)
+            refused it, in practice for an over-long URL. Mapping it by status
+            would hand the user a scope or key hint for a problem that is the
+            request's size, so it comes back as the base class with a message
+            that says where it was refused.
 
     Returns:
         An unraised exception instance for the caller to raise.
     """
+    if not envelope and 400 <= status < 500 and status != 429:
+        return SahiAPIException(
+            "the request was refused before it reached the API (no API error envelope), "
+            "usually because the URL is too long; send less per call",
+            status=status,
+            code=None,
+            request_id=request_id,
+        )
     key = _normalise(code)
 
     def build(cls: type[SahiAPIException]) -> SahiAPIException:
@@ -387,6 +414,8 @@ def exception_for(
         return build(SahiIpNotAllowedException)
     if key == "LOCKED":
         return build(SahiAccountLockedException)
+    if key == "UNDERMAINTENANCE":
+        return build(SahiMaintenanceException)
 
     if status == 400:
         return build(SahiBadRequestException)

{sahiapi-0.1.0 → sahiapi-0.2.0}/src/sahiapi/sahi/feed.py

@@ -8,8 +8,8 @@ Sahi has two streams, and :class:`SahiFeed` owns one connection for each:
   your account's order events with no subscription.
 
 Both share a token and the connection rules in :mod:`~sahiapi.sahi.ws_client`.
-Ticks update a local cache as they arrive, so :meth:`get_ltp`, :meth:`get_quote`
-and :meth:`get_depth` return the latest value even before you start consuming.
+Ticks update a local cache as they arrive, so :meth:`last_ltp`, :meth:`last_quote`
+and :meth:`last_depth` return the latest value even before you start consuming.
 Once the tick stream has closed fatally (an expired token above all) those
 reads raise that error instead of serving a frozen price, so a caller that only
 polls the cache learns of it too.
@@ -194,7 +194,7 @@ class SahiFeed:
         the socket thread.
 
         The call does not wait for the server. The ids count as subscribed at
-        once (:meth:`get_ltp` returns ``None`` until a tick lands), and enter the
+        once (:meth:`last_ltp` returns ``None`` until a tick lands), and enter the
         replayed table when the server's ``ack`` arrives. The server refuses a
         request whole if any id is unknown or the per-connection cap would be
         passed; that batch is then dropped, none of its ids are subscribed, and
@@ -240,7 +240,7 @@ class SahiFeed:
     def unsubscribe(self, instrument_ids: list[int]) -> None:
         """Stop ticks for these instruments and drop their cached values.
 
-        Afterwards :meth:`get_ltp` / :meth:`get_quote` / :meth:`get_depth` raise
+        Afterwards :meth:`last_ltp` / :meth:`last_quote` / :meth:`last_depth` raise
         :class:`SahiFeedNotSubscribedException` for them until re-subscribed.
         """
         dropped = set(instrument_ids)
@@ -279,7 +279,7 @@ class SahiFeed:
 
     # -- cache reads ----------------------------------------------------------
 
-    def get_ltp(self, instrument_id: int) -> dict[str, Any] | None:
+    def last_ltp(self, instrument_id: int) -> dict[str, Any] | None:
         """Return the latest LTP tick for an instrument, or ``None`` if none has arrived.
 
         Raises:
@@ -290,7 +290,7 @@ class SahiFeed:
         """
         return self._cached("ltp", instrument_id)
 
-    def get_quote(self, instrument_id: int) -> dict[str, Any] | None:
+    def last_quote(self, instrument_id: int) -> dict[str, Any] | None:
         """Return the latest quote tick for an instrument, or ``None`` if none yet.
 
         Raises:
@@ -301,7 +301,7 @@ class SahiFeed:
         """
         return self._cached("quote", instrument_id)
 
-    def get_depth(self, instrument_id: int) -> dict[str, Any] | None:
+    def last_depth(self, instrument_id: int) -> dict[str, Any] | None:
         """Return the latest depth tick for an instrument, or ``None`` if none yet.
 
         Raises:

{sahiapi-0.1.0 → sahiapi-0.2.0}/src/sahiapi/sahi/funds.py

@@ -63,10 +63,9 @@ class _Funds(EndpointGroup):
             ``{"required_margin": ..., "available_margin": ...}``, in paise.
 
         Raises:
-            SahiServerException: ``503 UNDER_MAINTENANCE`` between 04:45 and
-                07:00 IST, while the OMS runs its beginning-of-day processing.
-                Retry after 07:00 IST; the exception's generic hint of a short
-                wait does not apply here.
+            SahiMaintenanceException: ``503 UNDER_MAINTENANCE`` between 04:45
+                and 07:00 IST, while the OMS runs its beginning-of-day
+                processing. Retry after 07:00 IST.
         """
         body = build_order_body(
             exchange_segment,
@@ -116,8 +115,8 @@ class _Funds(EndpointGroup):
             TypeError: If a leg is missing a required field or carries one the
                 API does not define. The message names the leg by zero-based
                 index, as the server's own leg errors do.
-            SahiServerException: ``503 UNDER_MAINTENANCE`` between 04:45 and
-                07:00 IST, as on :meth:`get_order_margin`. Retry after 07:00 IST.
+            SahiMaintenanceException: ``503 UNDER_MAINTENANCE`` between 04:45
+                and 07:00 IST, as on :meth:`get_order_margin`.
         """
         # The server ignores fields it does not know, so a misspelled key would
         # otherwise be quoted at a value the caller never asked for; building each

{sahiapi-0.1.0 → sahiapi-0.2.0}/src/sahiapi/sahi/http.py

@@ -274,6 +274,7 @@ class HttpClient:
     def _error_from(self, response: httpx.Response, request_id: str) -> exceptions.SahiAPIException:
         code: str | None = None
         message: str | None = None
+        envelope = True
         try:
             body = response.json()
             if isinstance(body, dict):
@@ -282,6 +283,8 @@ class HttpClient:
                 code = raw_code if isinstance(raw_code, str) else None
                 message = body.get("message")
         except ValueError:
+            # HTML or plain text: the edge answered, not the API.
+            envelope = False
             message = response.text or None
 
         server_request_id = response.headers.get(_REQUEST_ID_HEADER) or request_id
@@ -293,6 +296,7 @@ class HttpClient:
             message=message,
             request_id=server_request_id,
             retry_after=retry_after,
+            envelope=envelope,
         )
 
     @staticmethod

{sahiapi-0.1.0 → sahiapi-0.2.0}/src/sahiapi/sahi/instruments.py

@@ -21,10 +21,9 @@ One parsed copy is shared by every client in the process, keyed by URL: the file
 is around 10 MB and costs well over a hundred megabytes once parsed, and it is
 the same file for every account.
 
-The download URL is not part of the public API reference; it is provided when
-your API access is set up. Pass it as ``scrip_master_url`` to :class:`SahiAPI`, or
-set ``SAHI_SCRIP_MASTER_URL``. Until one is given, these methods raise
-:class:`SahiConfigurationException`.
+The file is downloaded from the URL the API reference's Scrip master page
+publishes (``env.SCRIP_MASTER_URL``). Another copy can be used by passing
+``scrip_master_url`` to :class:`SahiAPI` or setting ``SAHI_SCRIP_MASTER_URL``.
 """
 
 from __future__ import annotations
@@ -42,7 +41,6 @@ import httpx
 from .base import EndpointGroup
 from .exceptions import (
     SahiAPIException,
-    SahiConfigurationException,
     SahiConnectionException,
     SahiTimeoutException,
 )
@@ -100,7 +98,7 @@ class _Instruments(EndpointGroup):
     """
 
     # Provided/managed by SahiAPI; declared here so the mixin is self-describing.
-    _scrip_master_url: str | None
+    _scrip_master_url: str
 
     def get_instruments(
         self, *, refresh: bool = False, timeout: float | None = None
@@ -130,7 +128,6 @@ class _Instruments(EndpointGroup):
             mutating a row changes what later lookups return.
 
         Raises:
-            SahiConfigurationException: If no scrip-master URL is configured.
             SahiConnectionException: If the download could not be started.
             SahiTimeoutException: If the download times out.
             SahiAPIException: If the download fails (``status`` set for a non-2xx).
@@ -178,12 +175,6 @@ class _Instruments(EndpointGroup):
 
     def _master(self, *, refresh: bool, timeout: float | None) -> _Master:
         url = self._scrip_master_url
-        if not url:
-            raise SahiConfigurationException(
-                "no scrip-master URL is configured. Pass scrip_master_url=... to "
-                "SahiAPI() or set SAHI_SCRIP_MASTER_URL. The URL is provided when "
-                "your API access is set up."
-            )
         with _CACHE_LOCK:
             cached = _CACHE.get(url)
             if not refresh and cached is not None and _is_current(cached):

{sahiapi-0.1.0 → sahiapi-0.2.0}/src/sahiapi/sahi/marketdata.py

@@ -22,7 +22,6 @@ from .base import EndpointGroup
 
 __all__ = ["_MarketData"]
 
-_MAX_INSTRUMENTS_PER_REQUEST = 500
 _CANDLE_SIZES = (
     constants.CANDLE_1M,
     constants.CANDLE_3M,
@@ -43,9 +42,15 @@ class _MarketData(EndpointGroup):
         """Last traded price for one or many instruments (``GET /v1/marketdata/ltp``).
 
         Args:
-            instrument_ids: One ``instrument_id``, or up to 500 of them. The
+            instrument_ids: One ``instrument_id``, or a list of them. The
                 endpoint is single or bulk, so a lone id needs no list around it;
-                the response is keyed by id either way.
+                the response is keyed by id either way. The API accepts up to
+                100 ids per call and answers ``400 VALIDATION_FAILED`` above
+                that; past roughly 200 the URL outgrows the edge's limit and
+                the request is refused before reaching the API (a plain
+                :class:`SahiAPIException`, HTTP 403). Batch a longer list. The
+                SDK does not cap it: a limit baked into a release would outlive
+                a server change.
 
         Returns:
             ``{"data": {"<id>": {"last_trade_price": ..., "last_trade_time": ...}}}``.
@@ -53,7 +58,7 @@ class _MarketData(EndpointGroup):
             ``200``.
 
         Raises:
-            ValueError: If no ids are given, or more than 500 are.
+            ValueError: If no ids are given.
         """
         ids = self._as_instrument_ids(instrument_ids)
         return self._request(  # type: ignore[no-any-return]
@@ -70,15 +75,15 @@ class _MarketData(EndpointGroup):
         """Full quote with market depth (``GET /v1/marketdata/quotes``).
 
         Args:
-            instrument_ids: One ``instrument_id``, or up to 500 of them, as on
-                :meth:`get_ltp`.
+            instrument_ids: One ``instrument_id``, or a list of them, as on
+                :meth:`get_ltp` (the API's limit of 100 per call applies here too).
 
         Returns:
             ``{"data": {"<id>": {...}}}`` — the REST equivalent of the tick
             stream's depth tick: price, volume, DPR band, open interest and depth.
 
         Raises:
-            ValueError: If no ids are given, or more than 500 are.
+            ValueError: If no ids are given.
         """
         ids = self._as_instrument_ids(instrument_ids)
         return self._request(  # type: ignore[no-any-return]
@@ -243,18 +248,12 @@ class _MarketData(EndpointGroup):
 
     @staticmethod
     def _as_instrument_ids(instrument_ids: int | Sequence[int]) -> list[int]:
-        # The endpoint is single or bulk, so a lone id is wrapped rather than
-        # refused. Both limits are the API's own rules; failing here saves a round
-        # trip that would come back 400 and gives a message that names the fix.
+        # Lone id is wrapped, not refused: the endpoint is single-or-bulk.
+        # No local id cap on purpose: a limit baked into a released SDK outlives
+        # a server change, and the server's 400 names the limit anyway.
         ids = [instrument_ids] if isinstance(instrument_ids, int) else list(instrument_ids)
         if not ids:
             raise ValueError("instrument_ids must contain at least one instrument_id")
-        if len(ids) > _MAX_INSTRUMENTS_PER_REQUEST:
-            raise ValueError(
-                f"at most {_MAX_INSTRUMENTS_PER_REQUEST} instrument_ids per request, got "
-                f"{len(ids)}; split the list into batches of "
-                f"{_MAX_INSTRUMENTS_PER_REQUEST}"
-            )
         return ids
 
     @staticmethod

{sahiapi-0.1.0 → sahiapi-0.2.0}/src/sahiapi/sahi/proto/codec.py

@@ -11,9 +11,11 @@ The decoded dicts keep the proto field names verbatim (``instrument_id``,
 ``last_trade_price``), keep integers as integers (unlike protobuf's JSON mapping,
 which renders 64-bit ints as strings), and give enum values as their string names
 with the enum prefix stripped (``NSE``, ``LTP``), matching the constants
-elsewhere in the SDK. Only fields the frame actually carries appear, so an absent
-optional such as an index's ``last_trade_time`` is simply missing rather than a
-zero.
+elsewhere in the SDK. Every field of the message is present, in the shape the
+REST endpoints return: an ``optional`` the server left unset (an index's
+``last_trade_time``, a stock's ``open_interest``) is ``None``, an empty repeated
+field is ``[]`` and an unset counter is ``0``, so a reader never has to guard
+for a missing key.
 """
 
 from __future__ import annotations
@@ -111,16 +113,48 @@ def _convert_value(field: FieldDescriptor, value: Any) -> Any:
     return value
 
 
+# Per message type: (name, kind, field) for every field, built once. Decoding
+# runs per tick, and asking the descriptor the same questions each time cost
+# ~40% over the ListFields() loop it replaced.
+_FIELD_PLANS: dict[str, list[tuple[str, str, FieldDescriptor]]] = {}
+
+
+def _field_plan(message: Message) -> list[tuple[str, str, FieldDescriptor]]:
+    descriptor = message.DESCRIPTOR
+    plan = _FIELD_PLANS.get(descriptor.full_name)
+    if plan is None:
+        plan = []
+        for field in descriptor.fields:
+            if _is_repeated(field):
+                kind = "repeated"
+            elif field.has_presence:  # proto3 ``optional`` and sub-messages
+                kind = "optional"
+            else:
+                kind = "scalar"
+            plan.append((field.name, kind, field))
+        _FIELD_PLANS[descriptor.full_name] = plan
+    return plan
+
+
 def _message_to_dict(message: Message) -> dict[str, Any]:
-    """Convert a protobuf message to a plain dict, set fields only.
+    """Convert a protobuf message to a plain dict with every field present.
+
+    The wire omits what is zero or empty, so the dict fills it back in to the
+    shape the REST endpoints return: an ``optional`` field the server did not
+    set is ``None`` (an index has no ``last_trade_time``, a stock no
+    ``open_interest``), a repeated field with no items is ``[]`` (no order book
+    yet), and an unset counter is ``0``. Integers stay integers, enums become
+    their stripped string names, nested messages recurse.
 
-    Integers stay integers, enums become their stripped string names, nested
-    messages recurse, and repeated fields become lists.
+    Users key on this shape; dropping a key or changing a default here breaks
+    code that reads ``tick["open_interest"]`` on a stock without a guard.
     """
     result: dict[str, Any] = {}
-    for field, value in message.ListFields():
-        if _is_repeated(field):
-            result[field.name] = [_convert_value(field, item) for item in value]
+    for name, kind, field in _field_plan(message):
+        if kind == "repeated":
+            result[name] = [_convert_value(field, item) for item in getattr(message, name)]
+        elif kind == "optional" and not message.HasField(name):
+            result[name] = None
         else:
-            result[field.name] = _convert_value(field, value)
+            result[name] = _convert_value(field, getattr(message, name))
     return result

{sahiapi-0.1.0 → sahiapi-0.2.0}/src/sahiapi/sahi/ws_client.py

@@ -1,10 +1,11 @@
 """One WebSocket connection, with reconnect and close-code handling.
 
 Both Sahi streams share the same connection rules: the access token goes on the
-upgrade as a Bearer header, the server pings every 30 seconds and expects a pong
-within 15, and some close codes are fatal while others just mean reconnect. This
-class implements those rules once; :class:`~sahiapi.sahi.feed.SahiFeed` owns one
-instance per stream.
+upgrade as a Bearer header next to the SDK's ``User-Agent`` (production's
+CloudFront refuses an upgrade without one, with a 403), the server pings every
+30 seconds and expects a pong within 15, and some close codes are fatal while
+others just mean reconnect. This class implements those rules once;
+:class:`~sahiapi.sahi.feed.SahiFeed` owns one instance per stream.
 
 The connection runs a receive loop on a daemon thread and hands each frame to an
 ``on_message`` callback. On a transient drop it reconnects with exponential
@@ -37,6 +38,7 @@ import threading
 from typing import Any, Callable, Protocol
 
 from . import constants, exceptions
+from .http import _user_agent
 
 __all__ = ["Transport", "WebSocketConnection"]
 
@@ -170,7 +172,7 @@ class WebSocketConnection:
         connect_fn: ConnectFn | None = None,
     ) -> None:
         self._url = url
-        self._header = [f"Authorization: Bearer {access_token}"]
+        self._header = [f"Authorization: Bearer {access_token}", f"User-Agent: {_user_agent()}"]
         self._binary = binary
         self._on_message = on_message
         self._on_open = on_open

sahiapi-0.1.0/CHANGELOG.md

@@ -1,30 +0,0 @@
-# Changelog
-
-All notable changes to this project are documented here. The format follows
-[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the project aims to
-follow [Semantic Versioning](https://semver.org/) once it reaches `1.0.0`.
-
-## [Unreleased]
-
-## [0.1.0] - 2026-10-18
-
-### Added
-- Initial SDK: authentication (`SahiAPI.from_credentials` for the one-call path,
-  `get_access_token` + `SahiAPI(token)` for a shared token, rotation via
-  `set_access_token`), and full REST coverage — orders, portfolio, funds,
-  account, market data (with `get_candle_history`) and the scrip master.
-- `SahiFeed` for the two WebSocket streams: the protobuf tick stream (LTP, quote,
-  depth) and JSON order updates, with reconnect, subscription replay and a local
-  tick cache whose reads raise the stream's error once it has closed fatally.
-- A typed exception hierarchy mapped from `(status, host, code)`. Every API
-  exception (`SahiAPIException`) carries the server `status`, `code`,
-  `message`, a `request_id` and an actionable `hint`, all included in `str()`;
-  a feed exception carries the WebSocket `close_code` instead.
-- Every wire enum as a constant and `SahiAPI` class attribute.
-- `on_connect` on the order stream for the API's Stream + Snapshot bootstrap;
-  transparent reconnect on heartbeat (4408) and slow-consumer (4409) drops.
-- Packaging, CI (ruff, mypy strict, pytest on Python 3.9–3.13) and a
-  trusted-publishing release workflow.
-
-[Unreleased]: https://github.com/aarityatech/sahi-python/compare/sahiapi/v0.1.0...HEAD
-[0.1.0]: https://github.com/aarityatech/sahi-python/releases/tag/sahiapi/v0.1.0

sahiapi-0.1.0/LICENSE

@@ -1,7 +0,0 @@
-Copyright (c) 2026 Aaritya Technologies Private Limited. All rights reserved.
-
-This software and its source code are proprietary and confidential. Until an
-open-source license is applied by the copyright holder, no permission is granted
-to copy, use, modify, or distribute this software outside Aaritya Technologies.
-
-An open-source license will replace this file when the project is published.

sahiapi-0.1.0/PKG-INFO

@@ -1,97 +0,0 @@
-Metadata-Version: 2.5
-Name: sahiapi
-Version: 0.1.0
-Summary: The official Python client library for the Sahi APIs.
-Project-URL: Homepage, https://docs.sahi.com/
-Project-URL: Documentation, https://docs.sahi.com/
-Project-URL: Repository, https://github.com/aarityatech/sahi-python
-Author: Aaritya Technologies
-License: Copyright (c) 2026 Aaritya Technologies Private Limited. All rights reserved.
-        
-        This software and its source code are proprietary and confidential. Until an
-        open-source license is applied by the copyright holder, no permission is granted
-        to copy, use, modify, or distribute this software outside Aaritya Technologies.
-        
-        An open-source license will replace this file when the project is published.
-License-File: LICENSE
-Keywords: bse,market-data,nse,options,sahi,stocks,trading
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Financial and Insurance Industry
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Typing :: Typed
-Requires-Python: >=3.9
-Requires-Dist: httpx>=0.27
-Requires-Dist: protobuf>=4.25
-Requires-Dist: websocket-client>=1.7
-Provides-Extra: dev
-Requires-Dist: mypy>=1.11; extra == 'dev'
-Requires-Dist: pytest-cov>=5.0; extra == 'dev'
-Requires-Dist: pytest>=8.0; extra == 'dev'
-Requires-Dist: respx>=0.21; extra == 'dev'
-Requires-Dist: ruff>=0.6; extra == 'dev'
-Description-Content-Type: text/markdown
-
-# sahiapi
-
-The official Python client library for the [Sahi APIs](https://docs.sahi.com/):
-orders, portfolio, funds, market data and live streams.
-
-> Early development. The public interface is not yet stable.
-
-## Install
-
-```bash
-pip install sahiapi
-```
-
-Requires Python 3.9 or newer.
-
-## Quickstart
-
-Create an API key in your Sahi account and approve it for the trading day, then:
-
-```python
-import os
-from sahiapi import SahiAPI
-
-api = SahiAPI.from_credentials(
-    key_id=os.environ["SAHI_KEY_ID"],
-    secret=os.environ["SAHI_SECRET"],
-)
-print(api.get_profile())
-print(api.get_funds())
-```
-
-Tokens expire at 06:00 IST, so mint a fresh one each trading day.
-
-## Documentation
-
-Guides, the full API reference and examples are at **https://docs.sahi.com/**.
-
-The SDK returns the API's JSON exactly as documented there: money is integer
-paise, timestamps are epoch milliseconds, and field names are unchanged.
-
-## Development
-
-```bash
-uv sync --extra dev
-uv run pytest
-uv run ruff check .
-uv run mypy
-```
-
-The tick-stream protobuf bindings are generated and committed; regenerate them
-with `tools/regen_proto.sh` after editing the `.proto`. Releases are cut with
-`tools/release.sh`; see `.github/workflows/release.yml`.
-
-## License
-
-Proprietary during development; an open-source license will be applied before
-public release. See [LICENSE](LICENSE).

sahiapi-0.1.0/README.md

@@ -1,57 +0,0 @@
-# sahiapi
-
-The official Python client library for the [Sahi APIs](https://docs.sahi.com/):
-orders, portfolio, funds, market data and live streams.
-
-> Early development. The public interface is not yet stable.
-
-## Install
-
-```bash
-pip install sahiapi
-```
-
-Requires Python 3.9 or newer.
-
-## Quickstart
-
-Create an API key in your Sahi account and approve it for the trading day, then:
-
-```python
-import os
-from sahiapi import SahiAPI
-
-api = SahiAPI.from_credentials(
-    key_id=os.environ["SAHI_KEY_ID"],
-    secret=os.environ["SAHI_SECRET"],
-)
-print(api.get_profile())
-print(api.get_funds())
-```
-
-Tokens expire at 06:00 IST, so mint a fresh one each trading day.
-
-## Documentation
-
-Guides, the full API reference and examples are at **https://docs.sahi.com/**.
-
-The SDK returns the API's JSON exactly as documented there: money is integer
-paise, timestamps are epoch milliseconds, and field names are unchanged.
-
-## Development
-
-```bash
-uv sync --extra dev
-uv run pytest
-uv run ruff check .
-uv run mypy
-```
-
-The tick-stream protobuf bindings are generated and committed; regenerate them
-with `tools/regen_proto.sh` after editing the `.proto`. Releases are cut with
-`tools/release.sh`; see `.github/workflows/release.yml`.
-
-## License
-
-Proprietary during development; an open-source license will be applied before
-public release. See [LICENSE](LICENSE).