reportify-sdk 0.2.9__tar.gz → 0.3.0__tar.gz

{reportify_sdk-0.2.9/reportify_sdk.egg-info → reportify_sdk-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: reportify-sdk
-Version: 0.2.9
+Version: 0.3.0
 Summary: Python SDK for Reportify API - Financial data and document search
 Author-email: Reportify <support@reportify.cn>
 License-Expression: MIT
@@ -75,19 +75,18 @@ balance = client.stock.balance_sheet("US:AAPL")
 cashflow = client.stock.cashflow_statement("US:AAPL")
 
 # Price data
-prices = client.stock.prices("US:AAPL", limit=30)
-kline = client.stock.kline("US:TSLA", interval="1d", limit=100)
+prices = client.stock.prices("US:AAPL", start_date="2024-01-01")
 
-# Real-time quotes
-quotes = client.stock.quote(["US:AAPL", "US:MSFT"])
+# Real-time quote
+quote = client.stock.quote("US:AAPL")
 
 # Company info
 overview = client.stock.overview("US:AAPL")
 shareholders = client.stock.shareholders("US:AAPL")
 
 # Screening and calendar
-stocks = client.stock.screener(market="US", min_market_cap=1e10)
-earnings = client.stock.earnings_calendar(area="us", start_date="2024-01-01")
+stocks = client.stock.screener(country="US", market_cap_more_than=1e10)
+earnings = client.stock.earnings_calendar(market="us", start_date="2024-01-01", end_date="2024-01-31")
 ```
 
 ### Timeline
@@ -118,6 +117,102 @@ summary = client.docs.summary("doc_id")
 # List and search documents
 docs = client.docs.list(symbols=["US:AAPL"], page_size=10)
 chunks = client.docs.search_chunks("revenue breakdown", num=5)
+
+# Upload documents
+result = client.docs.upload([
+    {"url": "https://example.com/report.pdf", "name": "Annual Report"}
+])
+```
+
+### Quant (Quantitative Analysis)
+
+```python
+# Compute technical indicators
+df = client.quant.compute_indicators(["000001"], "RSI(14)")
+df = client.quant.compute_indicators(["000001"], "MACD()")
+
+# Screen stocks by formula
+stocks = client.quant.screen(formula="RSI(14) < 30")
+stocks = client.quant.screen(formula="CROSS(MA(5), MA(20))")
+
+# Get OHLCV data
+ohlcv = client.quant.ohlcv("000001", start_date="2024-01-01")
+ohlcv_batch = client.quant.ohlcv_batch(["000001", "600519"])
+
+# Backtest strategy
+result = client.quant.backtest(
+    start_date="2023-01-01",
+    end_date="2024-01-01",
+    symbol="000001",
+    entry_formula="CROSS(MA(5), MA(20))",
+    exit_formula="CROSSDOWN(MA(5), MA(20))"
+)
+print(f"Total Return: {result['total_return_pct']:.2%}")
+```
+
+### Concepts
+
+```python
+# Get latest concepts
+concepts = client.concepts.latest()
+for c in concepts:
+    print(c["concept_name"])
+
+# Get today's concept feeds
+feeds = client.concepts.today()
+```
+
+### Channels
+
+```python
+# Search channels
+result = client.channels.search("Goldman Sachs")
+
+# Get followed channels
+followings = client.channels.followings()
+
+# Follow/unfollow a channel
+client.channels.follow("channel_id")
+client.channels.unfollow("channel_id")
+```
+
+### Chat
+
+```python
+# Chat completion based on documents
+response = client.chat.completion(
+    "What are Tesla's revenue projections?",
+    symbols=["US:TSLA"],
+    mode="comprehensive"  # concise, comprehensive, deepresearch
+)
+print(response["message"])
+```
+
+### Agent
+
+```python
+# Create agent conversation
+conv = client.agent.create_conversation(agent_id=11887655289749510)
+
+# Chat with agent
+response = client.agent.chat(
+    conversation_id=conv["id"],
+    message="Analyze NVIDIA's latest earnings"
+)
+
+# Get agent-generated file
+file_content = client.agent.get_file("file_id")
+with open("output.xlsx", "wb") as f:
+    f.write(file_content)
+```
+
+### User
+
+```python
+# Get followed companies
+companies = client.user.followed_companies()
+for company in companies:
+    print(f"{company['symbol']}: {company['name']}")
 ```
 
 ## Error Handling

{reportify_sdk-0.2.9 → reportify_sdk-0.3.0}/README.md

@@ -46,19 +46,18 @@ balance = client.stock.balance_sheet("US:AAPL")
 cashflow = client.stock.cashflow_statement("US:AAPL")
 
 # Price data
-prices = client.stock.prices("US:AAPL", limit=30)
-kline = client.stock.kline("US:TSLA", interval="1d", limit=100)
+prices = client.stock.prices("US:AAPL", start_date="2024-01-01")
 
-# Real-time quotes
-quotes = client.stock.quote(["US:AAPL", "US:MSFT"])
+# Real-time quote
+quote = client.stock.quote("US:AAPL")
 
 # Company info
 overview = client.stock.overview("US:AAPL")
 shareholders = client.stock.shareholders("US:AAPL")
 
 # Screening and calendar
-stocks = client.stock.screener(market="US", min_market_cap=1e10)
-earnings = client.stock.earnings_calendar(area="us", start_date="2024-01-01")
+stocks = client.stock.screener(country="US", market_cap_more_than=1e10)
+earnings = client.stock.earnings_calendar(market="us", start_date="2024-01-01", end_date="2024-01-31")
 ```
 
 ### Timeline
@@ -89,6 +88,102 @@ summary = client.docs.summary("doc_id")
 # List and search documents
 docs = client.docs.list(symbols=["US:AAPL"], page_size=10)
 chunks = client.docs.search_chunks("revenue breakdown", num=5)
+
+# Upload documents
+result = client.docs.upload([
+    {"url": "https://example.com/report.pdf", "name": "Annual Report"}
+])
+```
+
+### Quant (Quantitative Analysis)
+
+```python
+# Compute technical indicators
+df = client.quant.compute_indicators(["000001"], "RSI(14)")
+df = client.quant.compute_indicators(["000001"], "MACD()")
+
+# Screen stocks by formula
+stocks = client.quant.screen(formula="RSI(14) < 30")
+stocks = client.quant.screen(formula="CROSS(MA(5), MA(20))")
+
+# Get OHLCV data
+ohlcv = client.quant.ohlcv("000001", start_date="2024-01-01")
+ohlcv_batch = client.quant.ohlcv_batch(["000001", "600519"])
+
+# Backtest strategy
+result = client.quant.backtest(
+    start_date="2023-01-01",
+    end_date="2024-01-01",
+    symbol="000001",
+    entry_formula="CROSS(MA(5), MA(20))",
+    exit_formula="CROSSDOWN(MA(5), MA(20))"
+)
+print(f"Total Return: {result['total_return_pct']:.2%}")
+```
+
+### Concepts
+
+```python
+# Get latest concepts
+concepts = client.concepts.latest()
+for c in concepts:
+    print(c["concept_name"])
+
+# Get today's concept feeds
+feeds = client.concepts.today()
+```
+
+### Channels
+
+```python
+# Search channels
+result = client.channels.search("Goldman Sachs")
+
+# Get followed channels
+followings = client.channels.followings()
+
+# Follow/unfollow a channel
+client.channels.follow("channel_id")
+client.channels.unfollow("channel_id")
+```
+
+### Chat
+
+```python
+# Chat completion based on documents
+response = client.chat.completion(
+    "What are Tesla's revenue projections?",
+    symbols=["US:TSLA"],
+    mode="comprehensive"  # concise, comprehensive, deepresearch
+)
+print(response["message"])
+```
+
+### Agent
+
+```python
+# Create agent conversation
+conv = client.agent.create_conversation(agent_id=11887655289749510)
+
+# Chat with agent
+response = client.agent.chat(
+    conversation_id=conv["id"],
+    message="Analyze NVIDIA's latest earnings"
+)
+
+# Get agent-generated file
+file_content = client.agent.get_file("file_id")
+with open("output.xlsx", "wb") as f:
+    f.write(file_content)
+```
+
+### User
+
+```python
+# Get followed companies
+companies = client.user.followed_companies()
+for company in companies:
+    print(f"{company['symbol']}: {company['name']}")
 ```
 
 ## Error Handling

{reportify_sdk-0.2.9 → reportify_sdk-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "reportify-sdk"
-version = "0.2.9"
+version = "0.3.0"
 description = "Python SDK for Reportify API - Financial data and document search"
 readme = "README.md"
 license = "MIT"

{reportify_sdk-0.2.9 → reportify_sdk-0.3.0}/reportify_sdk/__init__.py

@@ -20,7 +20,7 @@ from reportify_sdk.exceptions import (
     APIError,
 )
 
-__version__ = "0.2.9"
+__version__ = "0.3.0"
 __all__ = [
     "Reportify",
     "ReportifyError",

{reportify_sdk-0.2.9 → reportify_sdk-0.3.0}/reportify_sdk/chat.py

@@ -54,7 +54,7 @@ class ChatModule:
             categories: Filter by document categories
             markets: Filter by markets (cn, hk, us)
             institutions: Filter by institutions
-            symbols: Filter by stock symbols
+            symbols: Stock symbols in market:ticker format (e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
             tags: Filter by tags
             start_date: Start date filter (YYYY-MM-DD)
             end_date: End date filter (YYYY-MM-DD)

reportify_sdk-0.3.0/reportify_sdk/client.py

@@ -0,0 +1,262 @@
+"""
+Reportify Client
+
+Main client class for interacting with the Reportify API.
+"""
+
+from typing import Any
+
+import httpx
+
+from reportify_sdk.exceptions import (
+    APIError,
+    AuthenticationError,
+    NotFoundError,
+    RateLimitError,
+)
+
+
+class Reportify:
+    """
+    Reportify API Client
+
+    A user-friendly client for accessing financial data, document search,
+    and knowledge base through the Reportify API.
+
+    Args:
+        api_key: Your Reportify API key
+        base_url: Base URL for the API (default: https://api.reportify.cn)
+        timeout: Request timeout in seconds (default: 30)
+
+    Example:
+        >>> from reportify_sdk import Reportify
+        >>> client = Reportify(api_key="your-api-key")
+        >>> docs = client.search("Tesla earnings", num=10)
+    """
+
+    DEFAULT_BASE_URL = "https://api.reportify.cn"
+
+    def __init__(
+        self,
+        api_key: str,
+        base_url: str | None = None,
+        timeout: float = 30.0,
+    ):
+        if not api_key:
+            raise AuthenticationError("API key is required")
+
+        self.api_key = api_key
+        self.base_url = (base_url or self.DEFAULT_BASE_URL).rstrip("/")
+        self.timeout = timeout
+
+        self._client = httpx.Client(
+            base_url=self.base_url,
+            headers=self._get_headers(),
+            timeout=timeout,
+        )
+
+        # Initialize sub-modules (lazy loading)
+        self._stock = None
+        self._timeline = None
+        self._kb = None
+        self._docs = None
+        self._tools = None
+        self._quant = None
+        self._concepts = None
+        self._channels = None
+        self._chat = None
+        self._agent = None
+        self._user = None
+        self._search = None
+
+    def _get_headers(self) -> dict[str, str]:
+        """Get default headers for API requests"""
+        return {
+            "Authorization": f"Bearer {self.api_key}",
+            "Content-Type": "application/json",
+            "User-Agent": "reportify-sdk-python/0.3.0",
+        }
+
+    def _request(
+        self,
+        method: str,
+        path: str,
+        params: dict[str, Any] | None = None,
+        json: dict[str, Any] | None = None,
+    ) -> dict[str, Any]:
+        """
+        Make an HTTP request to the API
+
+        Args:
+            method: HTTP method (GET, POST, etc.)
+            path: API endpoint path
+            params: Query parameters
+            json: JSON body data
+
+        Returns:
+            Response data as dictionary
+
+        Raises:
+            AuthenticationError: If API key is invalid
+            RateLimitError: If rate limit is exceeded
+            NotFoundError: If resource is not found
+            APIError: For other API errors
+        """
+        try:
+            response = self._client.request(
+                method=method,
+                url=path,
+                params=params,
+                json=json,
+            )
+
+            # Handle error responses
+            if response.status_code == 401:
+                raise AuthenticationError()
+            elif response.status_code == 429:
+                raise RateLimitError()
+            elif response.status_code == 404:
+                raise NotFoundError()
+            elif response.status_code >= 400:
+                error_msg = response.text
+                try:
+                    error_data = response.json()
+                    error_msg = error_data.get("detail", error_data.get("message", error_msg))
+                except Exception:
+                    pass
+                raise APIError(error_msg, status_code=response.status_code)
+
+            return response.json()
+
+        except httpx.TimeoutException:
+            raise APIError("Request timeout", status_code=408)
+        except httpx.RequestError as e:
+            raise APIError(f"Request failed: {str(e)}")
+
+    def _get(self, path: str, params: dict[str, Any] | None = None) -> dict[str, Any]:
+        """Make a GET request"""
+        return self._request("GET", path, params=params)
+
+    def _post(self, path: str, json: dict[str, Any] | None = None) -> dict[str, Any]:
+        """Make a POST request"""
+        return self._request("POST", path, json=json)
+
+    def _get_bytes(self, path: str) -> bytes:
+        """Make a GET request and return raw bytes (for file downloads)"""
+        try:
+            response = self._client.get(path)
+            response.raise_for_status()
+            return response.content
+        except httpx.HTTPStatusError as e:
+            status_code = e.response.status_code
+            if status_code == 401:
+                raise AuthenticationError("Invalid API key")
+            elif status_code == 404:
+                raise NotFoundError(f"Resource not found: {path}")
+            elif status_code == 429:
+                raise RateLimitError("Rate limit exceeded")
+            else:
+                raise APIError(f"API error: {status_code}")
+
+
+    # -------------------------------------------------------------------------
+    # Sub-modules (lazy loading)
+    # -------------------------------------------------------------------------
+
+    @property
+    def search(self):
+        """Search module for document search across all categories"""
+        if self._search is None:
+            from reportify_sdk.search import SearchModule
+            self._search = SearchModule(self)
+        return self._search
+
+    @property
+    def stock(self):
+        """Stock data module for financial statements, prices, etc."""
+        if self._stock is None:
+            from reportify_sdk.stock import StockModule
+            self._stock = StockModule(self)
+        return self._stock
+
+    @property
+    def timeline(self):
+        """Timeline module for following companies, topics, etc."""
+        if self._timeline is None:
+            from reportify_sdk.timeline import TimelineModule
+            self._timeline = TimelineModule(self)
+        return self._timeline
+
+    @property
+    def kb(self):
+        """Knowledge base module for searching user uploaded documents"""
+        if self._kb is None:
+            from reportify_sdk.kb import KBModule
+            self._kb = KBModule(self)
+        return self._kb
+
+    @property
+    def docs(self):
+        """Documents module for accessing document content and metadata"""
+        if self._docs is None:
+            from reportify_sdk.docs import DocsModule
+            self._docs = DocsModule(self)
+        return self._docs
+
+    @property
+    def quant(self):
+        """Quant module for indicators, factors, quotes, and backtesting"""
+        if self._quant is None:
+            from reportify_sdk.quant import QuantModule
+            self._quant = QuantModule(self)
+        return self._quant
+
+    @property
+    def concepts(self):
+        """Concepts module for accessing concept data and feeds"""
+        if self._concepts is None:
+            from reportify_sdk.concepts import ConceptsModule
+            self._concepts = ConceptsModule(self)
+        return self._concepts
+
+    @property
+    def channels(self):
+        """Channels module for searching and following channels"""
+        if self._channels is None:
+            from reportify_sdk.channels import ChannelsModule
+            self._channels = ChannelsModule(self)
+        return self._channels
+
+    @property
+    def chat(self):
+        """Chat module for document-based Q&A"""
+        if self._chat is None:
+            from reportify_sdk.chat import ChatModule
+            self._chat = ChatModule(self)
+        return self._chat
+
+    @property
+    def agent(self):
+        """Agent module for AI-powered conversations and workflows"""
+        if self._agent is None:
+            from reportify_sdk.agent import AgentModule
+            self._agent = AgentModule(self)
+        return self._agent
+
+    @property
+    def user(self):
+        """User module for user-related tools and data"""
+        if self._user is None:
+            from reportify_sdk.user import UserModule
+            self._user = UserModule(self)
+        return self._user
+
+    def close(self):
+        """Close the HTTP client"""
+        self._client.close()
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        self.close()

{reportify_sdk-0.2.9 → reportify_sdk-0.3.0}/reportify_sdk/docs.py

@@ -101,7 +101,7 @@ class DocsModule:
         List documents with filters
 
         Args:
-            symbols: Filter by stock symbols
+            symbols: Stock symbols in market:ticker format (e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
             categories: Filter by document categories (financials, transcripts, reports, news, files, filings, socials)
             markets: Filter by markets (cn, hk, us)
             institutions: Filter by institutions
@@ -176,7 +176,7 @@ class DocsModule:
 
         Args:
             query: Search query string
-            symbols: Filter by stock symbols
+            symbols: Stock symbols in market:ticker format (e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
             categories: Filter by document categories (financials, transcripts, reports, news, filings, socials)
             markets: Filter by markets (cn, hk, us)
             institutions: Filter by institutions
@@ -251,7 +251,7 @@ class DocsModule:
         Query documents by stock symbols
 
         Args:
-            symbols: Stock symbols to filter by (required)
+            symbols: Stock symbols in market:ticker format (required, e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
             categories: Filter by document categories
             markets: Filter by markets (cn, hk, us)
             start_date: Start date filter (YYYY-MM-DD)
@@ -345,7 +345,7 @@ class DocsModule:
 
         Args:
             query: Search query string
-            symbols: Filter by stock symbols
+            symbols: Stock symbols in market:ticker format (e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
             categories: Filter by document categories
             markets: Filter by markets (cn, hk, us)
             institutions: Filter by institutions