| Name | tsetmc JSON |
| Version |
0.68.1
JSON |
| download |
| home_page | None |
| Summary | a library to retrieve data from tsetmc.com website |
| upload_time | 2024-11-07 09:12:06 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | None |
| keywords |
tsetmc
client
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
An ``async`` Python library to fetch data from https://tsetmc.com/.
Note: The API is provisional and may change rapidly without deprecation.
Installation
------------
Requires Python 3.12 or later.
``pip install tsetmc``
Overview
--------
Let's start with a simple script:
.. code-block:: python
import asyncio
from tsetmc.instruments import Instrument
async def main():
inst = await Instrument.from_l18('فملی')
info = await inst.info()
print(info)
asyncio.run(main())
The ``Instrument`` class provides many methods for getting information about an instrument.
The following code blocks try to demonstrate some of its capabilities.
Note: You need an asyncio capable REPL, like ``python -m asyncio`` or `IPython`_, to run the following code samples, otherwise you'll have to run them inside an async function like the sample code above.
.. code-block:: python
>>> from tsetmc.instruments import Instrument
>>> inst = await Instrument.from_l18('فملی')
>>> await inst.info()
{'eps': {'epsValue': None,
'estimatedEPS': '721',
'sectorPE': 12.02,
'psr': 1472.8279},
'sector': {'dEven': 0, 'cSecVal': '27 ', 'lSecVal': 'فلزات اساسی'},
'staticThreshold': {'insCode': None,
'dEven': 0,
'hEven': 0,
'psGelStaMax': 8270.0,
'psGelStaMin': 7190.0},
'minWeek': 7630.0,
'maxWeek': 7970.0,
'minYear': 4630.0,
'maxYear': 10670.0,
'qTotTran5JAvg': 179233329.0,
'kAjCapValCpsIdx': '43',
'dEven': 0,
'topInst': 1,
'faraDesc': '',
'contractSize': 0,
'nav': 0.0,
'underSupervision': 0,
'cValMne': None,
'lVal18': 'S*I. N. C. Ind.',
'cSocCSAC': None,
'lSoc30': None,
'yMarNSC': None,
'yVal': '300',
'insCode': '35425587644337450',
'lVal30': 'ملی\u200c صنایع\u200c مس\u200c ایران\u200c',
'lVal18AFC': 'فملی',
'flow': 1,
'cIsin': 'IRO1MSMI0000',
'zTitad': 600000000000.0,
'baseVol': 15584416,
'instrumentID': 'IRO1MSMI0001',
'cgrValCot': 'N1',
'cComVal': '1',
'lastDate': 0,
'sourceID': 0,
'flowTitle': 'بازار بورس',
'cgrValCotTitle': 'بازار اول (تابلوی اصلی) بورس'}
Getting the latest price information:
.. code-block:: python
>>> await inst.closing_price_info()
{'instrumentState': {'idn': 0,
'dEven': 0,
'hEven': 0,
'insCode': None,
'cEtaval': 'A ',
'realHeven': 0,
'underSupervision': 0,
'cEtavalTitle': 'مجاز'},
'instrument': None,
'lastHEven': 170725,
'finalLastDate': 20230524,
'nvt': 0.0,
'mop': 0,
'thirtyDayClosingHistory': None,
'priceChange': 0.0,
'priceMin': 7630.0,
'priceMax': 7900.0,
'priceYesterday': 7730.0,
'priceFirst': 7750.0,
'last': True,
'id': 0,
'insCode': '0',
'dEven': 20230524,
'hEven': 170725,
'pClosing': 7700.0,
'iClose': False,
'yClose': False,
'pDrCotVal': 7670.0,
'zTotTran': 7206.0,
'qTotTran5J': 84108817.0,
'qTotCap': 648015842640.0}
Getting the daily trade history for the last n days: (as a DataFrame)
.. code-block:: python
>>> await inst.daily_closing_price(n=2)
priceChange priceMin priceMax ... zTotTran qTotTran5J qTotCap
0 30.0 7490.0 7600.0 ... 4555.0 75649965.0 5.689944e+11
1 10.0 7500.0 7590.0 ... 4614.0 83570336.0 6.276337e+11
[2 rows x 17 columns]
Getting adjusted daily prices:
.. code-block:: python
>>> await inst.price_history(adjusted=True)
pmax pmin pf pl tvol pc
date
2007-02-04 45 41 45 42 172898994 42
2007-02-05 43 43 43 43 10826496 43
2007-02-06 44 44 44 44 26850133 44
2007-02-07 45 45 45 45 31086849 45
2007-02-10 45 45 45 45 40645528 45
... ... ... ... ... ...
2021-07-12 13340 12840 13110 12860 106208763 13020
2021-07-13 13010 12640 12840 12680 66812306 12770
2021-07-14 12830 12450 12540 12690 70277940 12670
2021-07-17 12960 12550 12800 12640 68542961 12750
2021-07-18 12880 12530 12600 12630 88106162 12650
[3192 rows x 6 columns]
Getting intraday data for a specific date:
.. code-block:: python
>>> await inst.on_date(20210704).states() # a dataframe:
idn dEven hEven insCode cEtaval realHeven underSupervision cEtavalTitle
0 0 0 1 0 A 94838 0 None
Searching for an instrument:
.. code-block:: python
>>> await Instrument.from_search('چادرملو')
Instrument(18027801615184692, 'کچاد')
The ``instruments.price_adjustments`` function gets all the price adjustments for a specified flow.
The `market_watch`_ module contains several function to fetch market watch data. They include:
* ``market_watch_init``
* ``market_watch_plus``
* ``closing_price_all``
* ``client_type_all``
* ``key_stats``
* ``ombud_messages``
* ``status_changes``
Use ``market_watch.MarketWatch`` for watching the market. Here is how:
.. code-block:: python
from asyncio import new_event_loop
from tsetmc.market_watch import MarketWatch
async def listen_to_update_events():
while True:
await market_watch.update_event.wait()
df = market_watch.df
print(df.at['35425587644337450', 'pl']) # last price of فملی
market_watch = MarketWatch()
loop = new_event_loop()
loop.create_task(listen_to_update_events())
loop.run_until_complete(market_watch.start())
There are many other functions and methods that are not covered here. Explore the codebase to learn more.
If you are interested in other information available on tsetmc.com that this library has no API for, please `open an issue`_ for them.
See also
--------
* https://github.com/5j9/fipiran
.. _pandas: https://pandas.pydata.org/
.. _market_watch: http://www.tsetmc.com/Loader.aspx?ParTree=15131F
.. _open an issue: https://github.com/5j9/tsetmc/issues
.. _IPython: https://ipython.org/
Raw data
{
"_id": null,
"home_page": null,
"name": "tsetmc",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "tsetmc, client",
"author": null,
"author_email": "5j9 <5j9@users.noreply.github.com>",
"download_url": "https://files.pythonhosted.org/packages/75/51/9bf2ca17e4aad7ef70d8faa582383d495fe570b0e89b3d8ef8dea9e19aaa/tsetmc-0.68.1.tar.gz",
"platform": null,
"description": "An ``async`` Python library to fetch data from https://tsetmc.com/.\n\nNote: The API is provisional and may change rapidly without deprecation.\n\nInstallation\n------------\nRequires Python 3.12 or later.\n\n``pip install tsetmc``\n\nOverview\n--------\nLet's start with a simple script:\n\n.. code-block:: python\n\n import asyncio\n\n from tsetmc.instruments import Instrument\n\n\n async def main():\n inst = await Instrument.from_l18('\u0641\u0645\u0644\u06cc')\n info = await inst.info()\n print(info)\n\n\n asyncio.run(main())\n\n\nThe ``Instrument`` class provides many methods for getting information about an instrument.\nThe following code blocks try to demonstrate some of its capabilities.\n\nNote: You need an asyncio capable REPL, like ``python -m asyncio`` or `IPython`_, to run the following code samples, otherwise you'll have to run them inside an async function like the sample code above.\n\n.. code-block:: python\n\n >>> from tsetmc.instruments import Instrument\n >>> inst = await Instrument.from_l18('\u0641\u0645\u0644\u06cc')\n >>> await inst.info()\n {'eps': {'epsValue': None,\n 'estimatedEPS': '721',\n 'sectorPE': 12.02,\n 'psr': 1472.8279},\n 'sector': {'dEven': 0, 'cSecVal': '27 ', 'lSecVal': '\u0641\u0644\u0632\u0627\u062a \u0627\u0633\u0627\u0633\u06cc'},\n 'staticThreshold': {'insCode': None,\n 'dEven': 0,\n 'hEven': 0,\n 'psGelStaMax': 8270.0,\n 'psGelStaMin': 7190.0},\n 'minWeek': 7630.0,\n 'maxWeek': 7970.0,\n 'minYear': 4630.0,\n 'maxYear': 10670.0,\n 'qTotTran5JAvg': 179233329.0,\n 'kAjCapValCpsIdx': '43',\n 'dEven': 0,\n 'topInst': 1,\n 'faraDesc': '',\n 'contractSize': 0,\n 'nav': 0.0,\n 'underSupervision': 0,\n 'cValMne': None,\n 'lVal18': 'S*I. N. C. Ind.',\n 'cSocCSAC': None,\n 'lSoc30': None,\n 'yMarNSC': None,\n 'yVal': '300',\n 'insCode': '35425587644337450',\n 'lVal30': '\u0645\u0644\u06cc\\u200c \u0635\u0646\u0627\u06cc\u0639\\u200c \u0645\u0633\\u200c \u0627\u06cc\u0631\u0627\u0646\\u200c',\n 'lVal18AFC': '\u0641\u0645\u0644\u06cc',\n 'flow': 1,\n 'cIsin': 'IRO1MSMI0000',\n 'zTitad': 600000000000.0,\n 'baseVol': 15584416,\n 'instrumentID': 'IRO1MSMI0001',\n 'cgrValCot': 'N1',\n 'cComVal': '1',\n 'lastDate': 0,\n 'sourceID': 0,\n 'flowTitle': '\u0628\u0627\u0632\u0627\u0631 \u0628\u0648\u0631\u0633',\n 'cgrValCotTitle': '\u0628\u0627\u0632\u0627\u0631 \u0627\u0648\u0644 (\u062a\u0627\u0628\u0644\u0648\u06cc \u0627\u0635\u0644\u06cc) \u0628\u0648\u0631\u0633'}\n\n\nGetting the latest price information:\n\n.. code-block:: python\n\n >>> await inst.closing_price_info()\n {'instrumentState': {'idn': 0,\n 'dEven': 0,\n 'hEven': 0,\n 'insCode': None,\n 'cEtaval': 'A ',\n 'realHeven': 0,\n 'underSupervision': 0,\n 'cEtavalTitle': '\u0645\u062c\u0627\u0632'},\n 'instrument': None,\n 'lastHEven': 170725,\n 'finalLastDate': 20230524,\n 'nvt': 0.0,\n 'mop': 0,\n 'thirtyDayClosingHistory': None,\n 'priceChange': 0.0,\n 'priceMin': 7630.0,\n 'priceMax': 7900.0,\n 'priceYesterday': 7730.0,\n 'priceFirst': 7750.0,\n 'last': True,\n 'id': 0,\n 'insCode': '0',\n 'dEven': 20230524,\n 'hEven': 170725,\n 'pClosing': 7700.0,\n 'iClose': False,\n 'yClose': False,\n 'pDrCotVal': 7670.0,\n 'zTotTran': 7206.0,\n 'qTotTran5J': 84108817.0,\n 'qTotCap': 648015842640.0}\n\n\nGetting the daily trade history for the last n days: (as a DataFrame)\n\n.. code-block:: python\n\n >>> await inst.daily_closing_price(n=2)\n priceChange priceMin priceMax ... zTotTran qTotTran5J qTotCap\n 0 30.0 7490.0 7600.0 ... 4555.0 75649965.0 5.689944e+11\n 1 10.0 7500.0 7590.0 ... 4614.0 83570336.0 6.276337e+11\n [2 rows x 17 columns]\n\n\nGetting adjusted daily prices:\n\n.. code-block:: python\n\n >>> await inst.price_history(adjusted=True)\n pmax pmin pf pl tvol pc\n date\n 2007-02-04 45 41 45 42 172898994 42\n 2007-02-05 43 43 43 43 10826496 43\n 2007-02-06 44 44 44 44 26850133 44\n 2007-02-07 45 45 45 45 31086849 45\n 2007-02-10 45 45 45 45 40645528 45\n ... ... ... ... ... ...\n 2021-07-12 13340 12840 13110 12860 106208763 13020\n 2021-07-13 13010 12640 12840 12680 66812306 12770\n 2021-07-14 12830 12450 12540 12690 70277940 12670\n 2021-07-17 12960 12550 12800 12640 68542961 12750\n 2021-07-18 12880 12530 12600 12630 88106162 12650\n [3192 rows x 6 columns]\n\n\nGetting intraday data for a specific date:\n\n.. code-block:: python\n\n >>> await inst.on_date(20210704).states() # a dataframe:\n idn dEven hEven insCode cEtaval realHeven underSupervision cEtavalTitle\n 0 0 0 1 0 A 94838 0 None\n\n\nSearching for an instrument:\n\n.. code-block:: python\n\n >>> await Instrument.from_search('\u0686\u0627\u062f\u0631\u0645\u0644\u0648')\n Instrument(18027801615184692, '\u06a9\u0686\u0627\u062f')\n\nThe ``instruments.price_adjustments`` function gets all the price adjustments for a specified flow.\n\n\nThe `market_watch`_ module contains several function to fetch market watch data. They include:\n\n* ``market_watch_init``\n* ``market_watch_plus``\n* ``closing_price_all``\n* ``client_type_all``\n* ``key_stats``\n* ``ombud_messages``\n* ``status_changes``\n\nUse ``market_watch.MarketWatch`` for watching the market. Here is how:\n\n.. code-block:: python\n\n from asyncio import new_event_loop\n from tsetmc.market_watch import MarketWatch\n\n async def listen_to_update_events():\n while True:\n await market_watch.update_event.wait()\n df = market_watch.df\n print(df.at['35425587644337450', 'pl']) # last price of \u0641\u0645\u0644\u06cc\n\n\n market_watch = MarketWatch()\n loop = new_event_loop()\n loop.create_task(listen_to_update_events())\n loop.run_until_complete(market_watch.start())\n\n\nThere are many other functions and methods that are not covered here. Explore the codebase to learn more.\n\nIf you are interested in other information available on tsetmc.com that this library has no API for, please `open an issue`_ for them.\n\n\nSee also\n--------\n\n* https://github.com/5j9/fipiran\n\n.. _pandas: https://pandas.pydata.org/\n.. _market_watch: http://www.tsetmc.com/Loader.aspx?ParTree=15131F\n.. _open an issue: https://github.com/5j9/tsetmc/issues\n.. _IPython: https://ipython.org/\n\n",
"bugtrack_url": null,
"license": null,
"summary": "a library to retrieve data from tsetmc.com website",
"version": "0.68.1",
"project_urls": {
"Homepage": "https://github.com/5j9/tsetmc"
},
"split_keywords": [
"tsetmc",
" client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8673747b91da9c0fbcc8d12db637bf8c4e87d9bf958b1543d62344d67a52d6d2",
"md5": "9a250b0e3bc62f1fd84cb25be92556ac",
"sha256": "32a302ad7b4f8046dc72fcadcc60a3b8137d5796c0c076aaf71c31cb1f28b05d"
},
"downloads": -1,
"filename": "tsetmc-0.68.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9a250b0e3bc62f1fd84cb25be92556ac",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 78949,
"upload_time": "2024-11-07T09:11:51",
"upload_time_iso_8601": "2024-11-07T09:11:51.481896Z",
"url": "https://files.pythonhosted.org/packages/86/73/747b91da9c0fbcc8d12db637bf8c4e87d9bf958b1543d62344d67a52d6d2/tsetmc-0.68.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "75519bf2ca17e4aad7ef70d8faa582383d495fe570b0e89b3d8ef8dea9e19aaa",
"md5": "84bee2a6599cfd6b3580aed8a9a2f4e6",
"sha256": "960c75290b17537703bd919d821a90f716f20c67c5789801e8605920bb4d6187"
},
"downloads": -1,
"filename": "tsetmc-0.68.1.tar.gz",
"has_sig": false,
"md5_digest": "84bee2a6599cfd6b3580aed8a9a2f4e6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 82652,
"upload_time": "2024-11-07T09:12:06",
"upload_time_iso_8601": "2024-11-07T09:12:06.332148Z",
"url": "https://files.pythonhosted.org/packages/75/51/9bf2ca17e4aad7ef70d8faa582383d495fe570b0e89b3d8ef8dea9e19aaa/tsetmc-0.68.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-07 09:12:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "5j9",
"github_project": "tsetmc",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "tsetmc"
}
