dogabot-sdk 0.1.0__tar.gz

dogabot_sdk-0.1.0/.gitignore

@@ -0,0 +1,6 @@
+.venv/
+__pycache__/
+*.egg-info/
+.pytest_cache/
+dist/
+.build/

dogabot_sdk-0.1.0/LICENSE

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

dogabot_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,49 @@
+Metadata-Version: 2.5
+Name: dogabot-sdk
+Version: 0.1.0
+Summary: Official dogabot REST API SDK for Python
+Author: dogabot
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api,dogabot,sdk,trading
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.27
+Requires-Dist: pydantic>=2.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# dogabot-sdk (Python)
+
+Official REST client for the [dogabot public API](https://docs.dogabot.com/).
+
+```bash
+pip install dogabot-sdk
+# or: uv add dogabot-sdk
+# from source: pip install "dogabot-sdk @ git+https://github.com/dogabot/dogabot-sdk-python.git"
+```
+
+```python
+from dogabot_sdk import Client
+
+with Client(api_key="dbk_live_...") as client:  # or DOGABOT_API_KEY
+    me = client.get_me()
+    print(me)
+```
+
+Writes require an idempotency key:
+
+```python
+client.resources.post_terminal_placeorder(
+    body={"exchange": "hyperliquid", "symbol": "BTC", "side": "buy", "quantity": 0.001,
+          "order_type": "market", "trading_mode": "paper", "broadcast_mode": "personal"},
+    options={"idempotency_key": "place-paper-btc-1"},
+)
+```
+
+**Backend use only** for API keys — do not embed `dbk_live_…` in browser bundles.
+
+Runnable samples: [`examples/`](./examples/).
+
+Docs: https://docs.dogabot.com/sdk/ · MCP: https://docs.dogabot.com/mcp/

dogabot_sdk-0.1.0/README.md

@@ -0,0 +1,33 @@
+# dogabot-sdk (Python)
+
+Official REST client for the [dogabot public API](https://docs.dogabot.com/).
+
+```bash
+pip install dogabot-sdk
+# or: uv add dogabot-sdk
+# from source: pip install "dogabot-sdk @ git+https://github.com/dogabot/dogabot-sdk-python.git"
+```
+
+```python
+from dogabot_sdk import Client
+
+with Client(api_key="dbk_live_...") as client:  # or DOGABOT_API_KEY
+    me = client.get_me()
+    print(me)
+```
+
+Writes require an idempotency key:
+
+```python
+client.resources.post_terminal_placeorder(
+    body={"exchange": "hyperliquid", "symbol": "BTC", "side": "buy", "quantity": 0.001,
+          "order_type": "market", "trading_mode": "paper", "broadcast_mode": "personal"},
+    options={"idempotency_key": "place-paper-btc-1"},
+)
+```
+
+**Backend use only** for API keys — do not embed `dbk_live_…` in browser bundles.
+
+Runnable samples: [`examples/`](./examples/).
+
+Docs: https://docs.dogabot.com/sdk/ · MCP: https://docs.dogabot.com/mcp/

dogabot_sdk-0.1.0/examples/README.md

@@ -0,0 +1,15 @@
+# dogabot-sdk examples (Python)
+
+Set a live API key, then run from this directory (or any cwd):
+
+```bash
+export DOGABOT_API_KEY=dbk_live_...
+pip install -e ..   # from sdk/python, once
+python get_me.py
+python get_ticker.py
+python list_markets.py
+# paper place only — refuses unless you opt in:
+CONFIRM_PLACE=1 python place_paper_order.py
+```
+
+Docs: https://docs.dogabot.com/sdk/

dogabot_sdk-0.1.0/examples/get_me.py

@@ -0,0 +1,21 @@
+"""Print the authenticated account (GET /api/v1/me)."""
+
+from __future__ import annotations
+
+import json
+import os
+import sys
+
+from dogabot_sdk import Client
+
+
+def main() -> None:
+    if not os.environ.get("DOGABOT_API_KEY"):
+        print("Set DOGABOT_API_KEY=dbk_live_...", file=sys.stderr)
+        sys.exit(1)
+    with Client() as client:
+        print(json.dumps(client.get_me(), indent=2, default=str))
+
+
+if __name__ == "__main__":
+    main()

dogabot_sdk-0.1.0/examples/get_ticker.py

@@ -0,0 +1,26 @@
+"""Fetch a ticker with query params (GET /api/v1/ticker)."""
+
+from __future__ import annotations
+
+import json
+import os
+import sys
+
+from dogabot_sdk import Client
+
+
+def main() -> None:
+    if not os.environ.get("DOGABOT_API_KEY"):
+        print("Set DOGABOT_API_KEY=dbk_live_...", file=sys.stderr)
+        sys.exit(1)
+    exchange = os.environ.get("DOGABOT_EXCHANGE", "hyperliquid")
+    symbol = os.environ.get("DOGABOT_SYMBOL", "BTC")
+    with Client() as client:
+        ticker = client.resources.get_ticker(
+            options={"query": {"exchange": exchange, "symbol": symbol}},
+        )
+        print(json.dumps(ticker, indent=2, default=str))
+
+
+if __name__ == "__main__":
+    main()

dogabot_sdk-0.1.0/examples/list_markets.py

@@ -0,0 +1,24 @@
+"""List markets with optional filters (GET /api/v1/markets)."""
+
+from __future__ import annotations
+
+import json
+import os
+import sys
+
+from dogabot_sdk import Client
+
+
+def main() -> None:
+    if not os.environ.get("DOGABOT_API_KEY"):
+        print("Set DOGABOT_API_KEY=dbk_live_...", file=sys.stderr)
+        sys.exit(1)
+    with Client() as client:
+        markets = client.resources.get_markets(
+            options={"query": {"limit": 5, "is_tradable": "true"}},
+        )
+        print(json.dumps(markets, indent=2, default=str))
+
+
+if __name__ == "__main__":
+    main()

dogabot_sdk-0.1.0/examples/place_paper_order.py

@@ -0,0 +1,48 @@
+"""Place a tiny paper market order (requires Idempotency-Key).
+
+Safety: set CONFIRM_PLACE=1 to actually call the API. Default is dry-run print.
+trading_mode stays paper — do not flip to live unless you intend to.
+"""
+
+from __future__ import annotations
+
+import json
+import os
+import sys
+import uuid
+
+from dogabot_sdk import Client
+
+
+def main() -> None:
+    if not os.environ.get("DOGABOT_API_KEY"):
+        print("Set DOGABOT_API_KEY=dbk_live_...", file=sys.stderr)
+        sys.exit(1)
+
+    body = {
+        "exchange": os.environ.get("DOGABOT_EXCHANGE", "hyperliquid"),
+        "symbol": os.environ.get("DOGABOT_SYMBOL", "BTC"),
+        "side": "buy",
+        "quantity": 0.001,
+        "order_type": "market",
+        "trading_mode": "paper",
+        "broadcast_mode": "personal",
+    }
+    idem = os.environ.get("DOGABOT_IDEMPOTENCY_KEY") or f"example-paper-{uuid.uuid4()}"
+
+    if os.environ.get("CONFIRM_PLACE") != "1":
+        print("Dry-run only. Would POST placeorder with:")
+        print(json.dumps({"body": body, "idempotency_key": idem}, indent=2))
+        print("Re-run with CONFIRM_PLACE=1 to submit (still paper).")
+        return
+
+    with Client() as client:
+        out = client.resources.post_terminal_placeorder(
+            body=body,
+            options={"idempotency_key": idem},
+        )
+        print(json.dumps(out, indent=2, default=str))
+
+
+if __name__ == "__main__":
+    main()

dogabot_sdk-0.1.0/pyproject.toml

@@ -0,0 +1,24 @@
+[build-system]
+requires = ["hatchling>=1.25"]
+build-backend = "hatchling.build"
+
+[project]
+name = "dogabot-sdk"
+version = "0.1.0"
+description = "Official dogabot REST API SDK for Python"
+readme = "README.md"
+requires-python = ">=3.11"
+license = "MIT"
+authors = [{ name = "dogabot" }]
+keywords = ["dogabot", "trading", "sdk", "api"]
+dependencies = [
+  "httpx>=0.27",
+  "pydantic>=2.0",
+]
+
+[project.optional-dependencies]
+dev = ["pytest>=8.0", "respx>=0.21"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]

dogabot_sdk-0.1.0/src/dogabot_sdk/__init__.py

@@ -0,0 +1,7 @@
+"""Official dogabot REST API SDK for Python."""
+
+from dogabot_sdk._client import Client
+from dogabot_sdk._errors import APIError
+from dogabot_sdk.resources_generated import OPERATION_IDS, Resources
+
+__all__ = ["Client", "APIError", "Resources", "OPERATION_IDS"]

dogabot_sdk-0.1.0/src/dogabot_sdk/_client.py

@@ -0,0 +1,129 @@
+from __future__ import annotations
+
+import os
+import time
+from importlib.metadata import PackageNotFoundError, version
+from typing import Any
+
+import httpx
+
+from dogabot_sdk._errors import APIError
+from dogabot_sdk._types import JsonValue, RequestOptions
+from dogabot_sdk.resources_generated import Resources
+
+DEFAULT_BASE = "https://api.dogabot.com"
+
+
+def _pkg_version() -> str:
+    try:
+        return version("dogabot-sdk")
+    except PackageNotFoundError:
+        return "0.1.0"
+
+
+class Client:
+    def __init__(
+        self,
+        *,
+        api_key: str | None = None,
+        base_url: str = DEFAULT_BASE,
+        timeout: float = 30.0,
+        max_retries: int = 2,
+        http_client: httpx.Client | None = None,
+        user_agent: str | None = None,
+    ) -> None:
+        key = api_key or os.environ.get("DOGABOT_API_KEY")
+        if not key:
+            raise ValueError("api_key is required (pass api_key= or set DOGABOT_API_KEY)")
+        self.api_key = key
+        self.base_url = base_url.rstrip("/")
+        self.timeout = timeout
+        self.max_retries = max_retries
+        self.user_agent = user_agent or f"dogabot-sdk-python/{_pkg_version()}"
+        self._owns_client = http_client is None
+        self._http = http_client or httpx.Client(timeout=timeout)
+        self.resources = Resources(self)
+
+    def close(self) -> None:
+        if self._owns_client:
+            self._http.close()
+
+    def __enter__(self) -> Client:
+        return self
+
+    def __exit__(self, *args: object) -> None:
+        self.close()
+
+    def get_me(self, *, options: RequestOptions | None = None) -> JsonValue:
+        return self.resources.get_me(options=options)
+
+    def request(
+        self,
+        *,
+        method: str,
+        path: str,
+        body: JsonValue | None = None,
+        write: bool = False,
+        options: RequestOptions | None = None,
+    ) -> JsonValue:
+        opts = options or {}
+        idem = opts.get("idempotency_key")
+        if write and not idem:
+            raise ValueError(f"idempotency_key is required for write operation {method} {path}")
+
+        url = path if path.startswith("http") else f"{self.base_url}{path}"
+        headers = {
+            "Authorization": f"Bearer {self.api_key}",
+            "Accept": "application/json",
+            "User-Agent": self.user_agent,
+        }
+        extra = opts.get("headers")
+        if extra:
+            headers.update(extra)
+        if idem:
+            headers["Idempotency-Key"] = idem
+
+        params = opts.get("query")
+        timeout = opts.get("timeout", self.timeout)
+
+        attempt = 0
+        while True:
+            resp = self._http.request(
+                method,
+                url,
+                params=params,
+                json=body if body is not None else None,
+                headers=headers,
+                timeout=timeout,
+            )
+            if resp.is_success:
+                if not resp.content:
+                    return None
+                try:
+                    return resp.json()
+                except Exception:
+                    return resp.text
+
+            retryable = resp.status_code == 429 or resp.status_code >= 500
+            if retryable and attempt < self.max_retries:
+                attempt += 1
+                retry_after = resp.headers.get("Retry-After")
+                try:
+                    wait = float(retry_after) if retry_after else min(2**attempt, 8)
+                except ValueError:
+                    wait = min(2**attempt, 8)
+                time.sleep(wait)
+                continue
+
+            body_json: dict[str, Any] | None
+            try:
+                parsed = resp.json()
+                body_json = parsed if isinstance(parsed, dict) else None
+            except Exception:
+                body_json = None
+            msg = (
+                body_json.get("error")
+                if body_json and isinstance(body_json.get("error"), str)
+                else f"HTTP {resp.status_code} {method} {path}"
+            )
+            raise APIError(msg, status_code=resp.status_code, body=body_json, headers=resp.headers)

dogabot_sdk-0.1.0/src/dogabot_sdk/_errors.py

@@ -0,0 +1,20 @@
+from __future__ import annotations
+
+from typing import Any, Mapping
+
+import httpx
+
+
+class APIError(Exception):
+    def __init__(
+        self,
+        message: str,
+        *,
+        status_code: int,
+        body: Mapping[str, Any] | None,
+        headers: httpx.Headers,
+    ) -> None:
+        super().__init__(message)
+        self.status_code = status_code
+        self.body = body
+        self.headers = headers

dogabot_sdk-0.1.0/src/dogabot_sdk/_types.py

@@ -0,0 +1,12 @@
+from __future__ import annotations
+
+from typing import Any, Mapping, MutableMapping, TypedDict
+
+JsonValue = Any
+
+
+class RequestOptions(TypedDict, total=False):
+    query: Mapping[str, Any]
+    headers: MutableMapping[str, str]
+    idempotency_key: str
+    timeout: float

dogabot_sdk-0.1.0/src/dogabot_sdk/py.typed

@@ -0,0 +1 @@
+# Marker for PEP 561 typed package.