tsetmc-api
tsetmc-api copied to clipboard
python library to fetch tehran stocks market data
TSETMC-API
This library is for getting data from tsetmc website. It is divided into 5 subcomponents:
Installation
You can install this library using the following command:
pip install tsetmc-api
Examples
You can find examples of using each component in examples
directory.
Component | Example File |
---|---|
Symbol | symbol_example.py |
Market Watch | market_watch_example.py |
Day Details | day_details_example.py |
Market Map | market_map_example.py |
Group | group_example.py |
Async | async_example.py |
Usage
- symbol: working with main symbol page and live data ( e.g. this page)
- market_watch: getting data visible from market watch page
- day_details: working with details of a symbol in a single day of history ( e.g. this page)
- market_map: getting data visible in market map page
- group: getting list of available symbol groups
Symbol Component (tsetmc_api.symbol)
Market Watch Component (tsetmc_api.market_watch)
Day Details Component (tsetmc_api.day_details)
Market Map Component (tsetmc_api.market_map)
Group Component (tsetmc_api.group)
Group component currently only has one function (get_all_groups
) which returns all the symbol groups.
Errors
Tsetmc sometimes returns 403 and you should retry.
Async Support
Each method in the library has an async counterpart with the same name and a _async
suffix.
These methods use the sync functions behind the scene in an asyncio pool executor.
TODO
- [ ] Migrate
symbol
component to use new tsetmc. - [ ] Migrate
market_watch
component to use new tsetmc. - [x] Migrate
day_details
component to use new tsetmc. - [x] Migrate
market_map
component to use new tsetmc. - [x] Migrate
group
component to use new tsetmc. - [x] Support asyncio.
Support and Donation
If this repository helped you, please support it by giving a star (:star:).
For contacting me about this project please use the following email: