arb-tehran-finance 0.0.30
A comprehensive module for Iranian financial markets, including data retrieval and analysis for macroeconomics, capital markets, commodity exchange, derivatives, gold, real estate and more.
License: MIT
Requires Python: >=3.12

# **arb_tehran_finance**  

A comprehensive module for Iranian financial markets, including data retrieval and analysis for macroeconomics, capital markets, commodity exchange, derivatives, gold, real estate and more.  

This module is under continuous development, and each new version will enhance specific functionalities.  

---

## **1. Module Structure**  

**1- tse:** Data retrieval and analysis for the Tehran Stock Exchange (TSE) from the TSETMC website.  
- **1.1- tse_report:** Fetching market data from TSE.  
- **1.2- tse_analysis:** Analyzing market data from TSE.  

**2- ime:** Data retrieval and analysis for the Iran Mercantile Exchange (IME).  
- **2.1- ime_report:** Fetching market data from IME.  
- **2.2- ime_analysis:** Analyzing market data from IME.  

**3- codal:** Company performance reports and analysis retrieved from Codal.  
- **3.1- codal_report:** Fetching financial reports of companies.  
- **3.2- codal_analysis:** Analyzing financial reports of companies.  

**4- eco:** Data retrieval and analysis for Iran's macroeconomic indicators sourced from the Central Bank, Statistical Center, Customs, etc.  
- **4.1- eco_report:** Fetching macroeconomic data.  
- **4.2- eco_analysis:** Analyzing macroeconomic data.  

**5- derivative:** Analysis of derivative markets based on stock and commodity assets.  
- **5.1- future:** Futures market analysis.  
- **5.2- option:** Options market analysis.  

**6- usd_gold:** Reports and analysis for forex and gold markets.  
- **6.1- usd_gold_report:** Reports on forex and gold markets.  
- **6.2- usd_gold_analysis:** Analysis of forex and gold markets.  

**7- realestate:** Reports and analysis for Iran's real estate market, based on Central Bank reports and real estate data sources.  
- **7.1- realestate_report:** Reports on the real estate market.  
- **7.2- realestate_analysis:** Analysis of the real estate market.  

---

## **2. Installation and Setup**  

To install the module, simply run:  

```sh
pip install arb_tehran_finance
```

---

## **3. Usage**  

Due to the module's multi-layered structure, importing it into a Python environment should be done as follows:  

#### **Example 1:** Retrieve Tehran Stock Exchange index data  
```python
from arb_tehran_finance.tse import tse_report
tse_report.index_tedpix()
```

#### **Example 2:** Analyze arbitrage opportunities in the futures market  
```python
from arb_tehran_finance.derivative import future
future.future_arbitrage()
```

---

## **4. Contact Us**  

For suggestions, support, and updates, connect with us through:  

📢 **Telegram:** [t.me/alirzabaghrii](https://t.me/alirzabaghrii)  
📷 **Instagram:** [instagram.com/alirzabaghrii](http://instagram.com/alirzabaghrii)  
𝕏 **X (Twitter):** [x.com/alirzabaghrii](https://x.com/alirzabaghrii)  
🎥 **YouTube:** [youtube.com/@alirzabaghrii](https://youtube.com/@alirzabaghrii)  
💻 **GitHub:** [github.com/alirzabaghrii](https://github.com/alirzabaghrii)  

We look forward to your feedback and contributions!