reportify-sdk 0.2.10__tar.gz → 0.3.1__tar.gz

{reportify_sdk-0.2.10/reportify_sdk.egg-info → reportify_sdk-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: reportify-sdk
-Version: 0.2.10
+Version: 0.3.1
 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.10 → reportify_sdk-0.3.1}/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.10 → reportify_sdk-0.3.1}/pyproject.toml

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

{reportify_sdk-0.2.10 → reportify_sdk-0.3.1}/reportify_sdk/__init__.py

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

{reportify_sdk-0.2.10 → reportify_sdk-0.3.1}/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.2.10 → reportify_sdk-0.3.1}/reportify_sdk/client.py

@@ -74,7 +74,7 @@ class Reportify:
         return {
             "Authorization": f"Bearer {self.api_key}",
             "Content-Type": "application/json",
-            "User-Agent": "reportify-sdk-python/0.2.10",
+            "User-Agent": "reportify-sdk-python/0.3.1",
         }
 
     def _request(

{reportify_sdk-0.2.10 → reportify_sdk-0.3.1}/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

{reportify_sdk-0.2.10 → reportify_sdk-0.3.1}/reportify_sdk/quant.py

@@ -315,6 +315,63 @@ class QuantModule:
         response = self._client._post("/v1/quant/quotes/ohlcv/batch", json=data)
         return self._to_dataframe(response.get("datas", []))
 
+    # -------------------------------------------------------------------------
+    # Financials
+    # -------------------------------------------------------------------------
+
+    def financials(
+        self,
+        financial_type: Literal["income", "cashflow", "balancesheet", "equity"],
+        symbol: str,
+        *,
+        market: StockMarket = "cn",
+        start_year: int | None = None,
+        end_year: int | None = None,
+    ) -> pd.DataFrame:
+        """
+        Get historical financial statement data for a single symbol
+
+        Args:
+            financial_type: Type of financial statement
+                - "income": Income statement (利润表)
+                - "cashflow": Cash flow statement (现金流量表)
+                - "balancesheet": Balance sheet (资产负债表)
+                - "equity": Equity statement (股东权益变动表)
+            symbol: Stock code
+            market: Stock market ("cn", "hk", "us"), default "cn"
+            start_year: Start year (default: 3 years ago)
+            end_year: End year (default: current year)
+
+        Returns:
+            DataFrame with financial data sorted by report period
+
+        Example:
+            >>> # Get income statement
+            >>> df = client.quant.financials("income", "000001")
+            >>> print(df[["report_period", "revenue", "net_profit"]])
+
+            >>> # Get balance sheet for specific years
+            >>> df = client.quant.financials(
+            ...     "balancesheet", "600519",
+            ...     start_year=2020,
+            ...     end_year=2024
+            ... )
+
+            >>> # Get cash flow statement for HK stock
+            >>> df = client.quant.financials("cashflow", "00700", market="hk")
+        """
+        params: dict[str, Any] = {
+            "symbol": symbol,
+            "market": market,
+        }
+        if start_year:
+            params["start_year"] = start_year
+        if end_year:
+            params["end_year"] = end_year
+
+        response = self._client._get(f"/v1/quant/financials/{financial_type}", params=params)
+        return self._to_dataframe(response.get("datas", []))
+
     # -------------------------------------------------------------------------
     # Backtest
     # -------------------------------------------------------------------------

{reportify_sdk-0.2.10 → reportify_sdk-0.3.1}/reportify_sdk/search.py

@@ -44,7 +44,7 @@ class SearchModule:
             query: Search query string
             num: Number of results to return (default: 10, max: 100)
             categories: Filter by categories (news, reports, filings, transcripts, socials)
-            symbols: Filter by stock symbols (e.g., ["US:AAPL", "HK:0700"])
+            symbols: Stock symbols in market:ticker format (e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
             industries: Filter by industries
             channel_ids: Filter by channel IDs
             start_datetime: Start datetime filter (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS)
@@ -86,7 +86,7 @@ class SearchModule:
         Args:
             query: Search query string
             num: Number of results to return
-            symbols: Filter by stock symbols
+            symbols: Stock symbols in market:ticker format (e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
             channel_ids: Filter by channel IDs
             start_datetime: Start datetime filter
             end_datetime: End datetime filter
@@ -124,7 +124,7 @@ class SearchModule:
         Args:
             query: Search query string
             num: Number of results to return
-            symbols: Filter by stock symbols
+            symbols: Stock symbols in market:ticker format (e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
             industries: Filter by industries
             channel_ids: Filter by channel IDs
             start_datetime: Start datetime filter
@@ -162,7 +162,7 @@ class SearchModule:
 
         Args:
             query: Search query string
-            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)
             num: Number of results to return
             start_datetime: Start datetime filter
             end_datetime: End datetime filter
@@ -195,7 +195,7 @@ class SearchModule:
 
         Args:
             query: Search query string
-            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)
             num: Number of results to return
             start_datetime: Start datetime filter (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS)
             end_datetime: End datetime filter (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS)
@@ -234,7 +234,7 @@ class SearchModule:
 
         Args:
             query: Search query string
-            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)
             num: Number of results to return
             start_datetime: Start datetime filter (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS)
             end_datetime: End datetime filter (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS)
@@ -272,7 +272,7 @@ class SearchModule:
         Args:
             query: Search query string
             num: Number of results to return
-            symbols: Filter by stock symbols
+            symbols: Stock symbols in market:ticker format (e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
             start_datetime: Start datetime filter
             end_datetime: End datetime filter
 
@@ -306,7 +306,7 @@ class SearchModule:
         Args:
             query: Search query string
             num: Number of results to return
-            symbols: Filter by stock symbols
+            symbols: Stock symbols in market:ticker format (e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
             channel_ids: Filter by channel IDs
             start_datetime: Start datetime filter
             end_datetime: End datetime filter

{reportify_sdk-0.2.10 → reportify_sdk-0.3.1}/reportify_sdk/stock.py

@@ -118,7 +118,7 @@ class StockModule:
         Get income statement data
 
         Args:
-            symbol: Stock symbol (e.g., "US:AAPL")
+            symbol: Stock symbol
             period: Report cycle ("annual", "quarterly", "cumulative quarterly")
             limit: Return latest N records (default: 8)
             start_date: Start date (YYYY-MM-DD)
@@ -329,7 +329,7 @@ class StockModule:
         Get real-time stock quote
 
         Args:
-            symbol: Stock symbol (e.g., "US:AAPL", "688001", "00700")
+            symbol: Stock symbol
 
         Returns:
             DataFrame with real-time quote data

{reportify_sdk-0.2.10 → reportify_sdk-0.3.1/reportify_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: reportify-sdk
-Version: 0.2.10
+Version: 0.3.1
 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