Metadata-Version: 2.4
Name: echoscan
Version: 0.1.9
Summary: EchoScan package for Python
Author: EchoScan Team
License: MIT
Requires-Python: >=3.9
Description-Content-Type: text/markdown

# `echoscan` (Python)

中文 | [English](#english)

## 中文

### 可用调用方式

- `EchoScanLiteClient()`
- `EchoScanProClient(api_key=...)`

方法：

- Lite: `get_report(imprint)`
- Pro: `get_report(imprint)`, `get_history(imprint, days=..., from_=..., to=..., recent=...)`

History 查询：

仅 Pro 客户端可用（需要 Pro API Key）。

### 返回值与错误

`get_report()` 顶层结构：

```json
{
  "analysis": {},
  "lyingCount": 0,
  "projection": {}
}
```

`get_history()` 顶层结构：

```json
{
  "imprint": "fp_session_...",
  "range": {},
  "recent": [],
  "summary": {},
  "timeline": []
}
```

完整字段说明链接：[echoscan](https://echoscan.org)


### 示例

```python
import os
from echoscan import EchoScanProClient

pro = EchoScanProClient(api_key=os.environ["ECHOSCAN_PRO_KEY"])
report = pro.get_report("fp_session_123")
history = pro.get_history("fp_session_123", from_="2026-03-01", to="2026-03-18", recent=20)

print(report)
print(history)
```

---

## English

### Usage

- `EchoScanLiteClient()`
- `EchoScanProClient(api_key=...)`

Methods:

- Lite: `get_report(imprint)`
- Pro: `get_report(imprint)`, `get_history(imprint, days=..., from_=..., to=..., recent=...)`

History query:

Pro-only (requires a Pro API key).

### Response and errors

`get_report()` top-level shape:

```json
{
  "analysis": {},
  "lyingCount": 0,
  "projection": {}
}
```

`get_history()` top-level shape:

```json
{
  "imprint": "fp_session_...",
  "range": {},
  "recent": [],
  "summary": {},
  "timeline": []
}
```

Full field reference: [echoscan](https://echoscan.org)


### Example

```python
import os
from echoscan import EchoScanProClient

pro = EchoScanProClient(api_key=os.environ["ECHOSCAN_PRO_KEY"])
report = pro.get_report("fp_session_123")
history = pro.get_history("fp_session_123", from_="2026-03-01", to="2026-03-18", recent=20)

print(report)
print(history)
```
