Metadata-Version: 2.1
Name: sadra_tse
Version: 1.0.0
Summary: A Python Module to Access Tehran Stock Exchange Historical and Real-Time Data
Author: Dr.Amirsadra Akbari
Author-email: amirsadra.akbari@iau.ir
License: BSD (3-clause)
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: requests
Requires-Dist: jdatetime
Requires-Dist: pandas
Requires-Dist: numpy
Requires-Dist: requests
Requires-Dist: bs4
Requires-Dist: asyncio
Requires-Dist: urllib3
Requires-Dist: aiohttp
Requires-Dist: unsync
Requires-Dist: IPython
Requires-Dist: persiantools
Requires-Dist: datetime
Requires-Dist: XlsxWriter
Requires-Dist: lxml

[![Downloads](https://static.pepy.tech/personalized-badge/sadra-tse?period=total&units=international_system&left_color=black&right_color=green&left_text=Downloads)](https://pepy.tech/project/sadra-tse)

<div dir="rtl" align="right">

##### این ماژول با هدف دسترسی به اطلاعات مربوط به سهام بورس ایران در محیط برنامه‌نویسی پایتون توسعه یافته است.

<p>&nbsp;</p>



#### : ازجمله ویژگی‌های مهم این ماژول می‌توان به موارد زیر اشاره کرد
 
قابلیت دسترسی به داده‌های یک سهم با استفاده از نماد يا نام کامل فارسی  &emsp; <--- &emsp;  <br />
قابلیت انجام تعدیل قیمت به صورت یکجا با احتساب انواع افزایش سرمایه و پرداخت سود نقدی  &emsp; <--- &emsp;  <br />
هوشمندی در تشخیص جابجایی یک نماد بین بازارهای مختلف و یکپارچه سازی همه سوابق نمادهای دارای جابجایی &emsp; <--- &emsp;  <br />
قابلیت دسترسی به سوابق همه شاخص‌های بازار بورس و هوشمندی در تشخیص اشتباهات املایی و نگارشی عناوین شاخص صنایع بورسی  &emsp; <--- &emsp;  <br />
قابلیت دسترسی به سابقه داده‌های درون‌روز یک نماد شامل عمق بازار و ریز معاملات  &emsp; <--- &emsp;  <br />
قابلیت دسترسی و رصد لحظه‌ای دیده‌بان و عمق بازار در ساعت انجام معاملات در بازار  &emsp; <--- &emsp;  <br />
قابلیت تهیه لیست جامعی از مشخصات همه سهم‌های بازار  &emsp; <--- &emsp;  <br />
قابلیت دانلود دسته‌جمعی سابقه قیمت لیستی از سهم‌ها و ساخت پنل قیمت پایانی تعدیل شده برای آنها  &emsp; <--- &emsp;  <br />
قابلیت دسترسی به سابقه ۱۰ ساله قیمت دلار بازار آزاد  &emsp; <--- &emsp;  <br />
خروجی سازگار با دیتافریم پانداز و قابلیت فیلترینگ زمانی مجدد بر اساس تاریخ شمسی  &emsp; <--- &emsp;  <br />
قابلیت ارائه تاریخ شمسی، میلادی و نام ایام هفته برای داده‌های روزانه  &emsp; <--- &emsp;  <br />

<p>&nbsp;</p>

##### این ماژول دارای یک کتابچه راهنمای فارسی است که در آن همه توابع ماژول به همراه مثال ذکر شده است. برای دسترسی به این کتابچه راهنما میتوانید از [این صفحه](https://github.com/ARahimiQuant/sadra-tse) استفاده کنید   

##### همچین می‌توانید از طریق [این لینک](https://t.me/sadratse) به آدرس تلگرامی ما دسترسی داشته باشید

</div>


<p>&nbsp;</p>
<p>&nbsp;</p>

<div dir="rtl" align="right">

# نصب ماژول

</div>

```python
pip install sadra-tse
```


<p>&nbsp;</p>

<div dir="rtl" align="right">

# فراخوانی ماژول


</div>


```python
import sadra_tse as sadra
```

<p>&nbsp;</p>

<div dir="rtl" align="right">

# دریافت سابقه اطلاعات روزانه یک نماد
<hr style="border:2px solid gray"> </hr>




### : دریافت سابقه قیمت

</div>

```python
sadra.Get_Price_History(
    stock='خودرو',
    start_date='1400-01-01',
    end_date='1401-01-01',
    ignore_date=False,
    adjust_price=False,
    show_weekday=False,
    double_date=False)
```


<div dir="rtl" align="right">

### : دریافت سابقه حقیقی-حقوقی

</div>

```python
sadra.Get_RI_History(
    stock='خودرو',
    start_date='1400-01-01',
    end_date='1401-01-01',
    ignore_date=False,
    show_weekday=False,
    double_date=False,
    alt=False)
```

<p>&nbsp;</p>

<div dir="rtl" align="right">

# دریافت سابقه اطلاعات درون‌روز یک نماد
<hr style="border:2px solid gray"> </hr>


### : دریافت سابقه ریز معاملات

</div>

```python
sadra.Get_IntradayTrades_History(
    stock='وخارزم',
    start_date='1400-09-15',
    end_date='1400-12-29',
    jalali_date=True,
    combined_datatime=False,
    show_progress=True)
```

<div dir="rtl" align="right">

### : دریافت سابقه عمق بازار

</div>

```python
sadra.Get_IntradayOB_History(
    stock='کرمان',
    start_date='1400-08-01',
    end_date='1400-08-01',
    jalali_date=True,
    combined_datatime=False,
    show_progress=True)
```

<div dir="rtl" align="right">

### : دریافت سابقه ارزش صف در زمان بسته‌شدن بازار

</div>

```python
sadra.Get_Queue_History(
    stock='وخارزم',
    start_date='1400-09-15',
    end_date='1400-12-29',
    show_per_capita=True,
    show_weekday=False,
    double_date=False,
    show_progress=True)
```

<p>&nbsp;</p>

<div dir="rtl" align="right">

# دریافت سابقه روزانه شاخص‌های بازار بورس
<hr style="border:2px solid gray"> </hr>


### : دریافت سابقه شاخص کل

</div>

```python
sadra.Get_CWI_History(
    start_date='1395-01-01',
    end_date='1400-12-29',
    ignore_date=False,
    just_adj_close=False,
    show_weekday=False,
    double_date=False)
```

<div dir="rtl" align="right">

### : دریافت سابقه شاخص کل هم‌وزن

</div>

```python
sadra.Get_EWI_History(
    start_date='1395-01-01',
    end_date='1400-12-29',
    ignore_date=False,
    just_adj_close=True,
    show_weekday=False,
    double_date=False)
```

<div dir="rtl" align="right">

### : دریافت سابقه شاخص قیمت وزنی-ارزشی

</div>

```python
sadra.Get_CWPI_History(
    start_date='1395-01-01',
    end_date='1400-12-29',
    ignore_date=False,
    just_adj_close=False,
    show_weekday=False,
    double_date=False)
```

<div dir="rtl" align="right">

### : دریافت سابقه شاخص قیمت هم‌وزن

</div>

```python
sadra.Get_EWPI_History(
    start_date='1395-01-01',
    end_date='1400-12-29',
    ignore_date=False,
    just_adj_close=False,
    show_weekday=False,
    double_date=False)
```

<div dir="rtl" align="right">

### : دریافت سابقه شاخص سهام آزاد شناور
</div>

```python
sadra.Get_FFI_History(
    start_date='1395-01-01',
    end_date='1400-12-29',
    ignore_date=False,
    just_adj_close=False,
    show_weekday=False,
    double_date=False)
```

<div dir="rtl" align="right">

### : دریافت سابقه شاخص بازار اول

</div>

```python
sadra.Get_MKT1I_History(
    start_date='1395-01-01',
    end_date='1400-12-29',
    ignore_date=False,
    just_adj_close=False,
    show_weekday=False,
    double_date=False)
```

<div dir="rtl" align="right">

### : دریافت سابقه شاخص بازار دوم

</div>

```python
sadra.Get_MKT2I_History(
    start_date='1395-01-01',
    end_date='1400-12-29',
    ignore_date=False,
    just_adj_close=False,
    show_weekday=False,
    double_date=False)
```

<div dir="rtl" align="right">

### : دریافت سابقه شاخص صنعت

</div>

```python
sadra.Get_INDI_History(
    start_date='1395-01-01',
    end_date='1400-12-29',
    ignore_date=False,
    just_adj_close=False,
    show_weekday=False,
    double_date=False)
```

<div dir="rtl" align="right">

### : دریافت سابقه شاخص 50 شرکت فعال‌تر
</div>

```python
sadra.Get_ACT50_History(
    start_date='1395-01-01',
    end_date='1400-12-29',
    ignore_date=False,
    just_adj_close=False,
    show_weekday=False,
    double_date=False)
```

<div dir="rtl" align="right">

### : دریافت سابقه شاخص 30 شرکت بزرگ

</div>

```python
sadra.Get_LCI30_History(
    start_date='1395-01-01',
    end_date='1400-12-29',
    ignore_date=False,
    just_adj_close=False,
    show_weekday=False,
    double_date=False)
```

<div dir="rtl" align="right">

### : دریافت سابقه شاخص صنایع بورسی

</div>

```python
sadra.Get_SectorIndex_History(
    sector='خودرو',
    start_date='1395-01-01',
    end_date='1400-12-29',
    ignore_date=False,
    just_adj_close=False,
    show_weekday=False,
    double_date=False)
```

<p>&nbsp;</p>

<div dir="rtl" align="right">

# اطلاعات لحظه‌ای بازار
<hr style="border:2px solid gray"> </hr>


### : دریافت اطلاعات لحظه‌ای بازار

</div>

```python
sadra.Get_MarketWatch(
    save_excel=True,
    save_path='D:/sadra-TSE Data/MarketWatch')
```

<p>&nbsp;</p>

<div dir="rtl" align="right">

# دانلود دسته‌جمعی و پنل قیمت
<hr style="border:2px solid gray"> </hr>


### : دریافت لیست جامع سهم‌ها

</div>

```python
sadra.Build_Market_StockList(
    bourse=True,
    farabourse=True,
    payeh=True,
    detailed_list=True,
    show_progress=True,
    save_excel=True,
    save_csv=True,
    save_path='D:/sadra-TSE Data/')
```

<div dir="rtl" align="right">

### : دانلود دسته‌جمعی اطلاعات و ساخت پنل قیمت

</div>

```python
sadra.Build_PricePanel(
    stock_list,
    jalali_date=True,
    save_excel=True,
    save_path='D:/sadra-TSE Data/Price Panel/')
```

<p>&nbsp;</p>

<div dir="rtl" align="right">

# دلار آمریکا
<hr style="border:2px solid gray"> </hr>


### : دسترسی به سابقه روزانه قیمت دلار

</div>

```python
sadra.Get_USD_RIAL(
    start_date='1395-01-01',
    end_date='1400-12-29',
    ignore_date=False,
    show_weekday=False,
    double_date=False)
```
