Metadata-Version: 2.3
Name: fmd
Version: 0.6.1
Summary: Download Taiwan financial market data via FMD API.
License: Apache-2.0
Author: Yu Chen, Yang
Author-email: ycy.tai@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: requests (>=2.32.3,<3.0.0)
Requires-Dist: typing-extensions (>=4.12.2,<5.0.0)
Project-URL: Homepage, https://github.com/ycytai/fmd
Description-Content-Type: text/markdown

# fmd

---

**⚠️ NOTICE:**

FMD API will stop service after March 14, 2025. Additionally, this repository will be archived and no longer maintained after March 14, 2025. Thanks for your support.

---

**fmd** is a python wrapper that provides users with an easy-to-use interface to access data from Financial Market Data (FMD) API, specializing in Taiwan's financial market.

**Source Code**: [https://github.com/ycytai/fmd](https://github.com/ycytai/fmd)

**Documentation**: [https://fmd.ycytai.com/](https://fmd.ycytai.com/)

## Features

- :smile: **User-friendly**: Intuitive interface for easy adoption by all skill levels.
- :chart_with_upwards_trend: **Diverse data**: Popular financial data including prices, dividends, and more.
- :package: **All JSON**: Streamlined data format for effortless integration and analysis.

## Installation

Just use `pip`
```
pip install fmd
```

## Quick Start

Retrieve data with various predefined resources.

```python
from fmd import FmdApi

fa = FmdApi()
stock = fa.stock.get(symbol='2330')
data = stock.get_price()
```

## More examples

Access various resources
```python
from fmd import FmdApi

fa = FmdApi()

stock = fa.stock.get(symbol='2330')

etf = fa.etf.get(symbol='0050')

index = fa.index.get(symbol='LI0001')

currency = fa.forex.get(currency='TWD')
```

## Feedback and Bugs Report

Feel free to raise a issue once you encounter an unknown situation. We cherish your feedback. Cheers.

