Skip to main content

a library to retrieve data from fipiran.ir website

Project description

An async python library to fetch data from https://www.fipiran.com/ .

Note: This is package is incomplete and still in initial development phase. The API may change without deprecation.

Installation

Requires Python 3.13+.

$ pip install fipiran

Usage

import asyncio

from fipiran.symbols import Symbol


async def main():
    symbol = await Symbol.from_name('فملی')
    company_info = await symbol.info()
    print(company_info.model_dump_json(indent=2))


asyncio.run(main())

There are two main modules:

  • funds

  • symbols

Use an asyncio-aware REPL, like python -m asyncio, to run the code samples below.

Example 1:

>>> from fipiran.symbols import Symbol
>>> symbol = await Symbol.from_name('فملی')
>>> history = await symbol.history(limit=1)
>>> for entry in history:
        print(entry.model_dump_json(indent=2))
{
"insCode": "35425587644337450",
"transactionDate": "2025-10-01T00:00:00",
"numberOfTransactions": 11586.0,
"numberOfVolume": 575913522.0,
"transactionValue": 3847273607390.0,
"closingPrice": 6680.0,
"adjPriceForward": 7554.014596889284,
"adjPriceBackward": 7554.0145968,
"lastTransaction": 6720.0,
"changePrice": 190.0,
"priceMin": 6410.0,
"priceMax": 6720.0,
"priceFirst": 6530.0,
"priceYesterday": 6530.0,
"lastStatus": 0,
"hEven": 122949
}

Example 2:

Getting list of funds as a pandas DataFrame object.

>>> from fipiran.funds import funds
>>> await funds()
     regNo                                  name  ...      isCompleted  fundWatch
0    11726                        جسورانه فیروزه  ...         True       None
1    11603              جسورانه فناوری بازنشستگی  ...         True       None
2    11780                    گروه زعفران سحرخیز  ...         True       None
3    11772                      طلای سرخ نو ویرا  ...         True       None
4    11480                 جسورانه یکم آرمان آتی  ...         True       None
..     ...                                   ...  ...          ...        ...
308  11916                    با درآمد ثابت آریا  ...        False       None
309  11922                      آوای تاراز زاگرس  ...        False       None
310  11927                    صندوق در صندوق صنم  ...        False       None
311  11931  اختصاصی بازارگردانی توسعه سهام عدالت  ...        False       None
312  11933       اختصاصی بازارگردانی تثبیت پاداش  ...        False       None
[313 rows x 37 columns]

There are many other functions and methods. Please explore the code-base for more info.

If you are interested in other information that are available on fipiran.com but this library has no API for, please open an issue for them on github.

See also

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fipiran-2.0.0.tar.gz (8.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fipiran-2.0.0-py3-none-any.whl (9.5 kB view details)

Uploaded Python 3

File details

Details for the file fipiran-2.0.0.tar.gz.

File metadata

  • Download URL: fipiran-2.0.0.tar.gz
  • Upload date:
  • Size: 8.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for fipiran-2.0.0.tar.gz
Algorithm Hash digest
SHA256 31b572a2332d4fc8b99e69c2eb7448d9c1406e0af871836df422cde2e1cc8ed6
MD5 133afd623247a0051a4d104faf2f9bb9
BLAKE2b-256 043382194aacdff3612e6c6e9e186cb03b4a688e80e67e1c4279355c07b8372f

See more details on using hashes here.

File details

Details for the file fipiran-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: fipiran-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 9.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for fipiran-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3a6fc24298ea1d9ac70c281eb0040e5ee8ce6b112f3f800a1c0418a8ad70bcf7
MD5 6b158be1e4a35f8f9b25fa8e82b2bad6
BLAKE2b-256 bfacfc0f2d10657105f657acfa7a59d2c0270af927c5213cb908288f342ea620

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page