Source code for langchain_community.utilities.polygon
"""
调用多个Polygon股票市场REST API的工具。
文档:https://polygon.io/docs/stocks/getting-started
"""
import json
from typing import Any, Dict, Optional
import requests
from langchain_core.pydantic_v1 import BaseModel, root_validator
from langchain_core.utils import get_from_dict_or_env
POLYGON_BASE_URL = "https://api.polygon.io/"
[docs]class PolygonAPIWrapper(BaseModel):
"""Polygon API的包装器。"""
polygon_api_key: Optional[str] = None
@root_validator()
def validate_environment(cls, values: Dict) -> Dict:
"""验证环境中的API密钥。"""
polygon_api_key = get_from_dict_or_env(
values, "polygon_api_key", "POLYGON_API_KEY"
)
values["polygon_api_key"] = polygon_api_key
return values
[docs] def get_financials(self, ticker: str) -> Optional[dict]:
"""获取基本财务数据,这些数据可以在资产负债表、损益表和现金流量表中找到,针对给定的股票。
/vX/reference/financials
"""
url = (
f"{POLYGON_BASE_URL}vX/reference/financials?"
f"ticker={ticker}&"
f"apiKey={self.polygon_api_key}"
)
response = requests.get(url)
data = response.json()
status = data.get("status", None)
if status != "OK":
raise ValueError(f"API Error: {data}")
return data.get("results", None)
[docs] def get_last_quote(self, ticker: str) -> Optional[dict]:
"""获取特定股票的最新全国最佳买卖盘(报价)。
/v2/last/nbbo/{ticker}
"""
url = f"{POLYGON_BASE_URL}v2/last/nbbo/{ticker}?apiKey={self.polygon_api_key}"
response = requests.get(url)
data = response.json()
status = data.get("status", None)
if status != "OK":
raise ValueError(f"API Error: {data}")
return data.get("results", None)
[docs] def get_ticker_news(self, ticker: str) -> Optional[dict]:
"""获取与股票代码相关的最新新闻文章,包括文章摘要和指向原始来源的链接。
/v2/reference/news
"""
url = (
f"{POLYGON_BASE_URL}v2/reference/news?"
f"ticker={ticker}&"
f"apiKey={self.polygon_api_key}"
)
response = requests.get(url)
data = response.json()
status = data.get("status", None)
if status != "OK":
raise ValueError(f"API Error: {data}")
return data.get("results", None)
[docs] def get_aggregates(self, ticker: str, **kwargs: Any) -> Optional[dict]:
"""获取股票在给定日期范围内的聚合条形图,以自定义时间窗口大小。
/v2/aggs/ticker/{ticker}/range/{multiplier}/{timespan}/{from_date}/{to_date}
"""
timespan = kwargs.get("timespan", "day")
multiplier = kwargs.get("timespan_multiplier", 1)
from_date = kwargs.get("from_date", None)
to_date = kwargs.get("to_date", None)
adjusted = kwargs.get("adjusted", True)
sort = kwargs.get("sort", "asc")
url = (
f"{POLYGON_BASE_URL}v2/aggs"
f"/ticker/{ticker}"
f"/range/{multiplier}"
f"/{timespan}"
f"/{from_date}"
f"/{to_date}"
f"?apiKey={self.polygon_api_key}"
f"&adjusted={adjusted}"
f"&sort={sort}"
)
response = requests.get(url)
data = response.json()
status = data.get("status", None)
if status != "OK":
raise ValueError(f"API Error: {data}")
return data.get("results", None)
[docs] def run(self, mode: str, ticker: str, **kwargs: Any) -> str:
if mode == "get_financials":
return json.dumps(self.get_financials(ticker))
elif mode == "get_last_quote":
return json.dumps(self.get_last_quote(ticker))
elif mode == "get_ticker_news":
return json.dumps(self.get_ticker_news(ticker))
elif mode == "get_aggregates":
return json.dumps(self.get_aggregates(ticker, **kwargs))
else:
raise ValueError(f"Invalid mode {mode} for Polygon API.")