sharpapi 0.2.2__tar.gz → 0.3.1__tar.gz

{sharpapi-0.2.2 → sharpapi-0.3.1}/.gitignore

@@ -10,3 +10,9 @@ build/
 .ruff_cache/
 *.egg
 .mypy_cache/
+.coverage
+htmlcov/
+.claude/
+.DS_Store
+tests/
+.benchmarks/

sharpapi-0.3.1/CHANGELOG.md

@@ -0,0 +1,58 @@
+# Changelog
+
+All notable changes to the `sharpapi` Python SDK are documented here.
+
+## 0.3.1 — 2026-05-06
+
+### Added — TeamRef metadata
+
+`TeamRef` now exposes five additional optional fields:
+
+- `logo` — full CDN URL. ~93% of teams are populated.
+- `city` — e.g. `"Arizona"` for the Diamondbacks.
+- `mascot` — e.g. `"Diamondbacks"`.
+- `conference` — e.g. `"NL"`, `"AFC"`, `"Western"`.
+- `division` — e.g. `"West Division"`, `"NL East"`, `"Pacific Division"`.
+
+All five default to `None` and are additive — existing 0.3.0 code keeps
+working unchanged.
+
+## 0.3.0 — 2026-05-06
+
+### Added — nested refs
+
+Every odds row, opportunity row, and reference-list row may now carry
+optional structured reference objects alongside the existing flat fields.
+All new fields are **optional and additive** — clients on older API
+versions (or talking to older API servers) see `None` and behave
+identically.
+
+New models:
+
+- `TeamRef` — `id`, `numerical_id`, `name`, `abbreviation` (latter only on
+  team-sport competitors)
+- `SportRef` — `id`, `name`, `numerical_id`
+- `EntityRef` — `id`, `label`, `numerical_id` (used for league / market /
+  sportsbook refs)
+
+New optional fields:
+
+- `OddsLine`, `EVOpportunity`, `ArbitrageOpportunity`, `MiddleOpportunity`,
+  `LowHoldOpportunity` — all gain `home`, `away`, `sport_ref`, `league_ref`,
+  `market_ref`, `sportsbook_ref` (legs / opps without a single book skip
+  `sportsbook_ref`).
+- `ArbitrageLeg` — gains `sportsbook_ref`.
+- `ClosingOddsLine` — gains `market_ref`, `sportsbook_ref`.
+- `ClosingSnapshot` — gains `home`, `away`, `sport_ref`, `league_ref`.
+- `Sport`, `League`, `Sportsbook`, `Market` — gain `numerical_id`.
+- `Event` — gains `home`, `away`, `sport_ref`, `league_ref`.
+
+New reference model:
+
+- `Team` — for the `/teams` reference endpoint, includes optional
+  `abbreviation` and `numerical_id`.
+
+### Backward compatibility
+
+No existing field was renamed, retyped, or removed. Code that does not
+reference the new attributes continues to work without changes.

sharpapi-0.3.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 SharpAPI LLC
+
+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.

{sharpapi-0.2.2 → sharpapi-0.3.1}/PKG-INFO

@@ -1,13 +1,14 @@
 Metadata-Version: 2.4
 Name: sharpapi
-Version: 0.2.2
+Version: 0.3.1
 Summary: Official Python SDK for the SharpAPI real-time sports betting odds API
 Project-URL: Homepage, https://sharpapi.io
 Project-URL: Documentation, https://docs.sharpapi.io/sdks/python
 Project-URL: Repository, https://github.com/Sharp-API/sharpapi-python
 Project-URL: Changelog, https://github.com/Sharp-API/sharpapi-python/releases
-Author-email: SharpAPI <support@sharpapi.io>
+Author-email: SharpAPI <hello@sharpapi.io>
 License-Expression: MIT
+License-File: LICENSE
 Keywords: api,arbitrage,ev,odds,pinnacle,real-time,sports-betting
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers

sharpapi-0.3.1/SECURITY.md

@@ -0,0 +1,25 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+If you believe you have found a security vulnerability in this SDK or in
+the SharpAPI service, please report it privately to:
+
+**hello@sharpapi.io** (subject line: `[SECURITY] <short summary>`)
+
+Please do not open a public GitHub issue for security reports.
+
+We will acknowledge receipt within 72 hours and aim to provide a status
+update within 7 days. If the issue is confirmed, we will work with you on
+disclosure timing.
+
+## Scope
+
+In scope:
+- This SDK package and its published artifact on PyPI
+- The SharpAPI HTTP and WebSocket APIs (`api.sharpapi.io`, `ws.sharpapi.io`)
+
+Out of scope:
+- Findings in third-party dependencies (please report those upstream)
+- Denial of service via brute-force or volumetric attacks against the API
+- Issues that require physical access to a user's device

{sharpapi-0.2.2 → sharpapi-0.3.1}/pyproject.toml

@@ -4,12 +4,12 @@ build-backend = "hatchling.build"
 
 [project]
 name = "sharpapi"
-version = "0.2.2"
+version = "0.3.1"
 description = "Official Python SDK for the SharpAPI real-time sports betting odds API"
 readme = "README.md"
 license = "MIT"
 requires-python = ">=3.10"
-authors = [{ name = "SharpAPI", email = "support@sharpapi.io" }]
+authors = [{ name = "SharpAPI", email = "hello@sharpapi.io" }]
 keywords = ["sports-betting", "odds", "arbitrage", "ev", "api", "real-time", "pinnacle"]
 classifiers = [
     "Development Status :: 4 - Beta",
@@ -41,6 +41,25 @@ Changelog = "https://github.com/Sharp-API/sharpapi-python/releases"
 [tool.hatch.build.targets.wheel]
 packages = ["src/sharpapi"]
 
+# Explicit sdist whitelist. Hatchling's default sdist would otherwise
+# include everything not gitignored (CI workflows, dependabot config,
+# .gitignore itself), all of which would land on PyPI on every release.
+# Keep this in sync with what we actually want users who do
+# `pip install --no-binary :all: sharpapi` to receive.
+[tool.hatch.build.targets.sdist]
+include = [
+  "src/sharpapi",
+  "README.md",
+  "LICENSE",
+  "CHANGELOG.md",
+  "SECURITY.md",
+  "pyproject.toml",
+]
+exclude = [
+  ".gitignore",
+  ".github",
+]
+
 [tool.ruff]
 target-version = "py310"
 line-length = 100

{sharpapi-0.2.2 → sharpapi-0.3.1}/src/sharpapi/__init__.py

@@ -17,9 +17,12 @@ Example::
         print(f"+{opp.ev_percentage}% on {opp.selection} @ {opp.sportsbook}")
 """
 
+from ._utils import american_to_decimal, american_to_probability, decimal_to_american
 from .async_client import AsyncSharpAPI
 from .client import SharpAPI
 from .exceptions import (
+    ERROR_CODE_DESCRIPTIONS,
+    ERROR_CODE_TO_EXCEPTION,
     AuthenticationError,
     RateLimitedError,
     SharpAPIError,
@@ -28,16 +31,21 @@ from .exceptions import (
     ValidationError,
 )
 from .models import (
-    APIResponse,
     AccountInfo,
+    APIKey,
+    APIResponse,
     ArbitrageLeg,
     ArbitrageOpportunity,
-    EVOpportunity,
+    ClosingOddsLine,
+    ClosingSnapshot,
+    EntityRef,
     Event,
+    EVOpportunity,
     GameState,
     League,
     LowHoldOpportunity,
     LowHoldSide,
+    Market,
     MiddleOpportunity,
     MiddleSide,
     OddsLine,
@@ -46,28 +54,35 @@ from .models import (
     RateLimitInfo,
     ResponseMeta,
     Sport,
+    SportRef,
     Sportsbook,
+    Team,
+    TeamRef,
 )
 from .streaming import EventStream
-from ._utils import american_to_decimal, american_to_probability, decimal_to_american
 
-__version__ = "0.2.1"
+__version__ = "0.3.1"
 
 __all__ = [
     # Clients
     "SharpAPI",
     "AsyncSharpAPI",
     # Models
+    "APIKey",
     "APIResponse",
     "AccountInfo",
     "ArbitrageLeg",
     "ArbitrageOpportunity",
+    "ClosingOddsLine",
+    "ClosingSnapshot",
+    "EntityRef",
     "EVOpportunity",
     "Event",
     "GameState",
     "League",
     "LowHoldOpportunity",
     "LowHoldSide",
+    "Market",
     "MiddleOpportunity",
     "MiddleSide",
     "OddsLine",
@@ -76,7 +91,10 @@ __all__ = [
     "RateLimitInfo",
     "ResponseMeta",
     "Sport",
+    "SportRef",
     "Sportsbook",
+    "Team",
+    "TeamRef",
     # Streaming
     "EventStream",
     # Exceptions
@@ -86,6 +104,9 @@ __all__ = [
     "StreamError",
     "TierRestrictedError",
     "ValidationError",
+    # Error-code registry
+    "ERROR_CODE_DESCRIPTIONS",
+    "ERROR_CODE_TO_EXCEPTION",
     # Utilities
     "american_to_decimal",
     "american_to_probability",

{sharpapi-0.2.2 → sharpapi-0.3.1}/src/sharpapi/_base.py

@@ -3,21 +3,29 @@
 from __future__ import annotations
 
 import random
+from typing import Literal
 
 import httpx
 
 from .exceptions import (
+    ERROR_CODE_TO_EXCEPTION,
     AuthenticationError,
     RateLimitedError,
     SharpAPIError,
     TierRestrictedError,
     ValidationError,
+    canonical_code,
 )
 from .models import APIResponse, RateLimitInfo, ResponseMeta
 
 DEFAULT_BASE_URL = "https://api.sharpapi.io"
 DEFAULT_TIMEOUT = 30.0
-USER_AGENT = "sharpapi-python/0.2.2"
+USER_AGENT = "sharpapi-python/0.2.5"
+
+# Supported REST authentication methods. SSE always uses ``?api_key=`` query
+# regardless of this setting because EventSource cannot set custom headers.
+AuthMethod = Literal["x-api-key", "bearer"]
+DEFAULT_AUTH_METHOD: AuthMethod = "x-api-key"
 
 RETRY_STATUSES = frozenset({502, 503, 504})
 RETRY_MAX_ATTEMPTS = 3
@@ -90,6 +98,30 @@ def handle_errors(response: httpx.Response) -> None:
         code = body.get("code", "unknown_error")
     status = response.status_code
 
+    # Resolve deprecated code aliases (bad_request, invalid_request → validation_error).
+    code = canonical_code(code)
+
+    # Prefer the canonical code→exception mapping for well-known codes; fall back
+    # to HTTP-status-based routing for responses that omit an error code.
+    exc_class = ERROR_CODE_TO_EXCEPTION.get(code or "")
+    if exc_class is TierRestrictedError:
+        raise TierRestrictedError(
+            error_msg,
+            code=code,
+            status=status,
+            required_tier=body.get("required_tier"),
+        )
+    if exc_class is RateLimitedError:
+        raise RateLimitedError(
+            error_msg,
+            code=code,
+            status=status,
+            retry_after=body.get("retry_after"),
+        )
+    if exc_class is not None and exc_class is not SharpAPIError:
+        raise exc_class(error_msg, code=code, status=status)
+
+    # No canonical code match — route by HTTP status.
     if status == 401:
         raise AuthenticationError(error_msg, code=code, status=status)
     elif status == 403:
@@ -112,13 +144,28 @@ def handle_errors(response: httpx.Response) -> None:
         raise SharpAPIError(error_msg, code=code, status=status)
 
 
-def make_headers(api_key: str) -> dict[str, str]:
-    """Build default request headers."""
-    return {
-        "X-API-Key": api_key,
+def make_headers(
+    api_key: str,
+    auth_method: AuthMethod = DEFAULT_AUTH_METHOD,
+) -> dict[str, str]:
+    """Build default request headers.
+
+    Args:
+        api_key: The SharpAPI key (e.g. ``sk_live_...``).
+        auth_method: Either ``"x-api-key"`` (default — sends an
+            ``X-API-Key`` header) or ``"bearer"`` (sends
+            ``Authorization: Bearer <key>``). Useful when proxies, IAM
+            layers, or SSO gateways strip non-standard custom headers.
+    """
+    headers: dict[str, str] = {
         "Content-Type": "application/json",
         "User-Agent": USER_AGENT,
     }
+    if auth_method == "bearer":
+        headers["Authorization"] = f"Bearer {api_key}"
+    else:
+        headers["X-API-Key"] = api_key
+    return headers
 
 
 def _int_or_none(value: str | None) -> int | None: