Crawl the public data from Tefas.
Project description
Tefas Crawler
Crawl public invenstment fund information from Turkey Electronic Fund Trading Platform (TEFAS) with ease.
Installation
pip install tefas-crawler
Usage
Import the Crawler object and create an instance of it.
from tefas import Crawler
tefas = Crawler()
API
fetch(start, end, name, columns, kind)
| Argument | Type | Description | Required |
|---|---|---|---|
| start | string or datetime.datetime |
The date that fund information is crawled for. | Yes |
| end | string or datetime.datetime |
End of the period that fund information is crawled for. | No |
| name | string |
Name of the fund. If not given, all funds will be returned. | No |
| columns[] | list of string |
List of columns to be returned. | No |
| kind | string |
Type of the fund. One of YAT, EMK, or BYF. Defaults to YAT. |
No |
Examples
Get all funds for a given day.
data = tefas.fetch(start="2020-11-20")
Get a specific fund for a time period, and select columns.
data = tefas.fetch(start="2020-11-15", end="2020-11-20", name="YAC", columns=["code", "date", "price"])
Data Schema
As of today, we support the following data schema from Tefas:
| Column | Description | Type |
|---|---|---|
| date | Sate | date |
| price | Price of the fund for a given date | string |
| code | Short code of the fund | string |
| title | Full name of the fund | string |
| market_cap | Total value of the fund | float |
| number_of_shares | Number of outstanding shares | float |
| number_of_investors | Number of participants | float |
| bank_bills | Share of bank bills | float |
| exchange_traded_fund | Share of exchange traded fund | float |
| other | Share of other | float |
| fx_payable_bills | Share of fx payable bills | float |
| government_bond | Share of government bond | float |
| foreign_currency_bills | Share of foreign currency bills | float |
| eurobonds | Share of eurobonds | float |
| commercial_paper | Share of commercial paper | float |
| fund_participation_certificate | Share of fund participation certificate | float |
| real_estate_certificate | Share of real estate certificate | float |
| venture_capital_investment_fund_participation | Share of venture capital investment fund | float |
| real_estate_investment_fund_participation | Share of real estate investment fund | float |
| treasury_bill | Share of treasury bill | float |
| stock | Share of stock | float |
| government_bonds_and_bills_fx | Share of government bonds and bills (fx) | float |
| participation_account | Share of participation account | float |
| participation_account_au | Share of gold participation account | float |
| participation_account_d | Share of foreign currency participation account | float |
| participation_account_tl | Share of Turkish Lira participation account | float |
| government_lease_certificates | Share of government lease certificates | float |
| government_lease_certificates_d | Share of foreign currency government lease certificates | float |
| government_lease_certificates_tl | Share of Turkish Lira government lease certificates | float |
| government_lease_certificates_foreign | Share of government foreign lease certificates | float |
| precious_metals | Share of precious metals | float |
| precious_metals_byf | Share of precious metals stock market investment fund | float |
| precious_metals_kba | Share of precious metals government dept instrument | float |
| precious_metals_kks | Share of precious metals public lease certificates | float |
| public_domestic_debt_instruments | Share of foreign exchange public domestic debt instruments | float |
| private_sector_lease_certificates | Share of private sector lease certificates | float |
| private_sector_bond | Share of private sector bond | float |
| repo | Share of repo | float |
| derivatives | Share of derivatives | float |
| tmm | Share of tmm | float |
| reverse_repo | Share of reverse-repo | float |
| asset_backed_securities | Share of asset-backed securities | float |
| term_deposit | Share of term deposit | float |
| term_deposit_au | Share of gold term deposit | float |
| term_deposit_d | Share of foreign currency term deposit | float |
| term_deposit_tl | Share of Turkish Lira term deposit | float |
| futures_cash_collateral | Share of futures cash collateral | float |
| foreign_debt_instruments | Share of foreign debt instruments | float |
| foreign_domestic_debt_instruments | Share of foreign domestic debt instruments | float |
| foreign_private_sector_debt_instruments | Share of foreign private sector debt instruments | float |
| foreign_exchange_traded_funds | Share of foreign exchange traded funds | float |
| foreign_equity | Share of foreign equity | float |
| foreign_securities | Share of foreign securities | float |
| foreign_investment_fund_participation_shares | Share of foreign investment fund participation | float |
| private_sector_international_lease_certificate | Share of private sector international lease certificate | float |
| private_sector_foreign_debt_instruments | Share of private sector foreign dept instruments | float |
To-do
- Increase test coverage
- Request error handling
- Cache query results
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file tefas_crawler-0.5.0.tar.gz.
File metadata
- Download URL: tefas_crawler-0.5.0.tar.gz
- Upload date:
- Size: 10.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dfe8de04f067591f4270f875e77e4216455ff535b9896b39cf4ddc4c9495af0b
|
|
| MD5 |
4dcbbc6a4c4c373e65aa84835f39a719
|
|
| BLAKE2b-256 |
3e187082410de0f78993ddc676bf91f0f7924b662a5574438f45b2e6e2742174
|
File details
Details for the file tefas_crawler-0.5.0-py3-none-any.whl.
File metadata
- Download URL: tefas_crawler-0.5.0-py3-none-any.whl
- Upload date:
- Size: 10.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a3c88dc21389473bdfe31accf54b9697eee7128640a6b567e094c555e94385d5
|
|
| MD5 |
f2ce08502ac7234578ecf6a1f297c552
|
|
| BLAKE2b-256 |
2618955d989d578566402ff9914573cdd0c7f1785b989239584c913dbb87b341
|