| Name | bddkdata JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | Fetches financial tables and banking sector data from the BRSA (BDDK) website. |
| upload_time | 2025-07-19 12:32:04 |
| maintainer | None |
| docs_url | None |
| author | Uraz Akgül |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# bddkdata v0.1.0
## Türkçe tercih edenler için:
***Those who prefer English can scroll down the page.***
## Açıklama
`bddkdata`, Bankacılık Düzenleme ve Denetleme Kurumu'nun (BDDK) resmi web sitesinde yayımlanan finansal tabloları ve bankacılık sektörü verilerini programatik olarak çekmeye olanak tanıyan bir Python kütüphanesidir. Kütüphane, aylık güncellenen temel bankacılık göstergelerine hızlı ve esnek erişim sağlar; veri analizi ve raporlama süreçlerinizi kolaylaştırır. Veriler doğrudan BDDK'nın açık veri servisinden alınır ve Türkçe/İngilizce başlık desteğiyle, kullanıma hazır pandas DataFrame formatında sunulur.
## Özellikler
* İstediğiniz tarih aralığında BDDK'nın yayımladığı aylık tabloları kolayca çekebilirsiniz.
* Tüm tablolar ve gruplar için Türkçe/İngilizce destekli başlıklarla veri alabilirsiniz.
* Kullanımı çok basittir, çıktı olarak doğrudan `pandas.DataFrame` döner.
* Hatalar ve mesajlar Türkçe veya İngilizce olarak gösterilir.
* Tablolar ve grup isimleri için kolayca listeleme fonksiyonları içerir.
* Çekilen verileri opsiyonel olarak Excel dosyası olarak kaydedebilirsiniz.
## Kurulum
Kütüphaneyi kullanmak için aşağıdaki adımları izleyin:
1. Python'ı sisteminize yükleyin: https://www.python.org/downloads/
2. Terminali açın ve paketi yüklemek için aşağıdaki komutu çalıştırın:
```bash
pip install bddkdata
```
Spesifik bir versiyona ait kurulum yapacaksanız aşağıdaki örnekte olduğu gibi komutu çalıştırabilirsiniz.
```bash
pip install bddkdata==0.1.0
```
Yüklü paketin versiyonuna aşağıdaki komut yardımıyla ulaşabilirsiniz.
```bash
pip show bddkdata
```
## Fonksiyonlar
### `fetch_data`
BDDK API'dan tablo verisi çeker.
Parametreler:
* `start_year` (int): Başlangıç yılı (YYYY)
* `start_month` (int): Başlangıç ayı (1-12)
* `end_year` (int): Bitiş yılı (YYYY)
* `end_month` (int): Bitiş ayı (1-12)
* `table_no` (int): Tablo numarası (örn: 1)
* `currency` (str): "TL" veya "USD"
* `group` (int): Grup ID'si (örn: 10001)
* `lang` (str): "tr" veya "en" (varsayılan "tr")
* `save_excel` (bool, opsiyonel): True verilirse sonuç Excel dosyasına kaydedilir. Varsayılan olarak False'tur.
Dönüş:
* `pandas.DataFrame` (veya veri yoksa `None`)
### `get_tables`
Mevcut tablo listesini döndürür.
Parametreler:
* `lang` (str): "tr" veya "en" (varsayılan "tr")
Dönüş:
* `pandas.DataFrame`
### `get_groups`
Mevcut grup listesini döndürür.
Parametreler:
* `lang` (str): "tr" veya "en" (varsayılan "tr")
Dönüş:
* `pandas.DataFrame`
## Örnek
```python
from bddkdata import fetch_data, get_tables, get_groups
print(get_tables(lang="tr"))
print(get_groups(lang="tr"))
df = fetch_data(
start_year=2024,
start_month=1,
end_year=2025,
end_month=5,
table_no=1,
currency="TL",
group=10001,
lang="tr",
save_excel=True
)
print(df)
```
## Notlar
* Kütüphane, BDDK'nın web sitesindeki verilere bağımlıdır. Bu nedenle, verilerin doğruluğu ve sürekliliği için lütfen ilgili web sitesini kontrol edin: [BDDK](https://www.bddk.org.tr/BultenAylik/tr/)
* Kütüphanenin geliştirilmesi ve iyileştirilmesi için geri bildirimlerinizi bekliyorum. GitHub reposuna katkıda bulunun: [GitHub Repo](https://github.com/urazakgul/bddkdata)
* Herhangi bir sorun veya öneride lütfen GitHub reposundaki "Issue" bölümünden yeni bir konu açarak bildirim sağlayın: [GitHub Issues](https://github.com/urazakgul/bddkdata/issues)
## Sürüm Notları
### v0.1.0 - 19/07/2025
* İlk sürüm yayınlandı.
## Lisans
Bu proje MIT Lisansı altında lisanslanmıştır.
## For those who prefer English:
## Description
`bddkdata` is a Python package that enables you to fetch financial tables and banking sector data published on the official website of the Banking Regulation and Supervision Agency (BRSA, BDDK) of Turkey. The library provides fast and flexible access to monthly updated core banking indicators, making your data analysis and reporting processes easier. Data is fetched directly from the BRSA's open data service and delivered in ready-to-use pandas DataFrame format with both Turkish and English column labels.
## Features
* Easily fetch monthly tables published by the BRSA for any desired date range.
* Fetch data with Turkish/English column support for all tables and groups.
* Simple to use; outputs are returned directly as `pandas.DataFrame`.
* Errors and messages are displayed in Turkish or English.
* Includes helper functions for listing available tables and group names.
* Optionally save fetched data as an Excel file.
## Installation
To use the package, follow these steps:
1. Install Python on your system: https://www.python.org/downloads/
2. Open a terminal and install the package with:
```bash
pip install bddkdata
```
To install a specific version, use:
```bash
pip install bddkdata==0.1.0
```
To check the installed version:
```bash
pip show bddkdata
```
## Functions
### `fetch_data`
Fetches table data from the BRSA API.
Parameters:
* `start_year` (int): Starting year (YYYY)
* `start_month` (int): Starting month (1–12)
* `end_year` (int): Ending year (YYYY)
* `end_month` (int): Ending month (1–12)
* `table_no` (int): Table number (e.g., 1)
* `currency` (str): "TL" or "USD"
* `group` (int): Group ID (e.g., 10001)
* `lang` (str): "tr" or "en" (default "tr")
* `save_excel` (bool, optional): If True, saves the result to an Excel file. Defaults to False.
Returns:
* `pandas.DataFrame` (or `None` if no data is available)
### `get_tables`
Fetches the list of available tables.
Parameters:
* `lang` (str): "tr" or "en" (default "tr")
Returns:
* `pandas.DataFrame`
### `get_groups`
Fetches the list of available groups.
Parameters:
* `lang` (str): "tr" or "en" (default "tr")
Returns:
* `pandas.DataFrame`
## Example
```python
from bddkdata import fetch_data, get_tables, get_groups
print(get_tables(lang="en"))
print(get_groups(lang="en"))
df = fetch_data(
start_year=2024,
start_month=1,
end_year=2025,
end_month=5,
table_no=1,
currency="USD",
group=10001,
lang="en",
save_excel=True
)
print(df)
```
## Notes
* The package depends on data from the official BRSA website. Please check the website for data accuracy and availability: [BRSA](https://www.bddk.org.tr/BultenAylik/en/)
* I welcome your feedback to improve and develop this library. You can contribute on GitHub: [GitHub Repo](https://github.com/urazakgul/bddkdata)
* For any issues or suggestions, please open a new topic in the "Issue" section of the GitHub repository: [GitHub Issues](https://github.com/urazakgul/bddkdata/issues)
## Release Notes
### v0.1.0 - 19/07/2025
* First release published.
## License
This project is licensed under the MIT License.
Raw data
{
"_id": null,
"home_page": null,
"name": "bddkdata",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Uraz Akg\u00fcl",
"author_email": "urazdev@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ee/54/082fcbe8fbe3cfafeb5c49a8f836156aae99554778473c7f6c6aa50b2ca2/bddkdata-0.1.0.tar.gz",
"platform": null,
"description": "# bddkdata v0.1.0\r\n\r\n## T\u00fcrk\u00e7e tercih edenler i\u00e7in:\r\n\r\n***Those who prefer English can scroll down the page.***\r\n\r\n## A\u00e7\u0131klama\r\n\r\n`bddkdata`, Bankac\u0131l\u0131k D\u00fczenleme ve Denetleme Kurumu'nun (BDDK) resmi web sitesinde yay\u0131mlanan finansal tablolar\u0131 ve bankac\u0131l\u0131k sekt\u00f6r\u00fc verilerini programatik olarak \u00e7ekmeye olanak tan\u0131yan bir Python k\u00fct\u00fcphanesidir. K\u00fct\u00fcphane, ayl\u0131k g\u00fcncellenen temel bankac\u0131l\u0131k g\u00f6stergelerine h\u0131zl\u0131 ve esnek eri\u015fim sa\u011flar; veri analizi ve raporlama s\u00fcre\u00e7lerinizi kolayla\u015ft\u0131r\u0131r. Veriler do\u011frudan BDDK'n\u0131n a\u00e7\u0131k veri servisinden al\u0131n\u0131r ve T\u00fcrk\u00e7e/\u0130ngilizce ba\u015fl\u0131k deste\u011fiyle, kullan\u0131ma haz\u0131r pandas DataFrame format\u0131nda sunulur.\r\n\r\n## \u00d6zellikler\r\n\r\n* \u0130stedi\u011finiz tarih aral\u0131\u011f\u0131nda BDDK'n\u0131n yay\u0131mlad\u0131\u011f\u0131 ayl\u0131k tablolar\u0131 kolayca \u00e7ekebilirsiniz.\r\n* T\u00fcm tablolar ve gruplar i\u00e7in T\u00fcrk\u00e7e/\u0130ngilizce destekli ba\u015fl\u0131klarla veri alabilirsiniz.\r\n* Kullan\u0131m\u0131 \u00e7ok basittir, \u00e7\u0131kt\u0131 olarak do\u011frudan `pandas.DataFrame` d\u00f6ner.\r\n* Hatalar ve mesajlar T\u00fcrk\u00e7e veya \u0130ngilizce olarak g\u00f6sterilir.\r\n* Tablolar ve grup isimleri i\u00e7in kolayca listeleme fonksiyonlar\u0131 i\u00e7erir.\r\n* \u00c7ekilen verileri opsiyonel olarak Excel dosyas\u0131 olarak kaydedebilirsiniz.\r\n\r\n## Kurulum\r\n\r\nK\u00fct\u00fcphaneyi kullanmak i\u00e7in a\u015fa\u011f\u0131daki ad\u0131mlar\u0131 izleyin:\r\n\r\n1. Python'\u0131 sisteminize y\u00fckleyin: https://www.python.org/downloads/\r\n2. Terminali a\u00e7\u0131n ve paketi y\u00fcklemek i\u00e7in a\u015fa\u011f\u0131daki komutu \u00e7al\u0131\u015ft\u0131r\u0131n:\r\n\r\n```bash\r\npip install bddkdata\r\n```\r\n\r\nSpesifik bir versiyona ait kurulum yapacaksan\u0131z a\u015fa\u011f\u0131daki \u00f6rnekte oldu\u011fu gibi komutu \u00e7al\u0131\u015ft\u0131rabilirsiniz.\r\n\r\n```bash\r\npip install bddkdata==0.1.0\r\n```\r\n\r\nY\u00fckl\u00fc paketin versiyonuna a\u015fa\u011f\u0131daki komut yard\u0131m\u0131yla ula\u015fabilirsiniz.\r\n\r\n```bash\r\npip show bddkdata\r\n```\r\n\r\n## Fonksiyonlar\r\n\r\n### `fetch_data`\r\n\r\nBDDK API'dan tablo verisi \u00e7eker.\r\n\r\nParametreler:\r\n\r\n* `start_year` (int): Ba\u015flang\u0131\u00e7 y\u0131l\u0131 (YYYY)\r\n* `start_month` (int): Ba\u015flang\u0131\u00e7 ay\u0131 (1-12)\r\n* `end_year` (int): Biti\u015f y\u0131l\u0131 (YYYY)\r\n* `end_month` (int): Biti\u015f ay\u0131 (1-12)\r\n* `table_no` (int): Tablo numaras\u0131 (\u00f6rn: 1)\r\n* `currency` (str): \"TL\" veya \"USD\"\r\n* `group` (int): Grup ID'si (\u00f6rn: 10001)\r\n* `lang` (str): \"tr\" veya \"en\" (varsay\u0131lan \"tr\")\r\n* `save_excel` (bool, opsiyonel): True verilirse sonu\u00e7 Excel dosyas\u0131na kaydedilir. Varsay\u0131lan olarak False'tur.\r\n\r\nD\u00f6n\u00fc\u015f:\r\n\r\n* `pandas.DataFrame` (veya veri yoksa `None`)\r\n\r\n### `get_tables`\r\n\r\nMevcut tablo listesini d\u00f6nd\u00fcr\u00fcr.\r\n\r\nParametreler:\r\n\r\n* `lang` (str): \"tr\" veya \"en\" (varsay\u0131lan \"tr\")\r\n\r\nD\u00f6n\u00fc\u015f:\r\n\r\n* `pandas.DataFrame`\r\n\r\n### `get_groups`\r\n\r\nMevcut grup listesini d\u00f6nd\u00fcr\u00fcr.\r\n\r\nParametreler:\r\n\r\n* `lang` (str): \"tr\" veya \"en\" (varsay\u0131lan \"tr\")\r\n\r\nD\u00f6n\u00fc\u015f:\r\n\r\n* `pandas.DataFrame`\r\n\r\n## \u00d6rnek\r\n\r\n```python\r\nfrom bddkdata import fetch_data, get_tables, get_groups\r\n\r\nprint(get_tables(lang=\"tr\"))\r\nprint(get_groups(lang=\"tr\"))\r\n\r\ndf = fetch_data(\r\n start_year=2024,\r\n start_month=1,\r\n end_year=2025,\r\n end_month=5,\r\n table_no=1,\r\n currency=\"TL\",\r\n group=10001,\r\n lang=\"tr\",\r\n save_excel=True\r\n)\r\nprint(df)\r\n```\r\n\r\n## Notlar\r\n\r\n* K\u00fct\u00fcphane, BDDK'n\u0131n web sitesindeki verilere ba\u011f\u0131ml\u0131d\u0131r. Bu nedenle, verilerin do\u011frulu\u011fu ve s\u00fcreklili\u011fi i\u00e7in l\u00fctfen ilgili web sitesini kontrol edin: [BDDK](https://www.bddk.org.tr/BultenAylik/tr/)\r\n* K\u00fct\u00fcphanenin geli\u015ftirilmesi ve iyile\u015ftirilmesi i\u00e7in geri bildirimlerinizi bekliyorum. GitHub reposuna katk\u0131da bulunun: [GitHub Repo](https://github.com/urazakgul/bddkdata)\r\n* Herhangi bir sorun veya \u00f6neride l\u00fctfen GitHub reposundaki \"Issue\" b\u00f6l\u00fcm\u00fcnden yeni bir konu a\u00e7arak bildirim sa\u011flay\u0131n: [GitHub Issues](https://github.com/urazakgul/bddkdata/issues)\r\n\r\n## S\u00fcr\u00fcm Notlar\u0131\r\n\r\n### v0.1.0 - 19/07/2025\r\n\r\n* \u0130lk s\u00fcr\u00fcm yay\u0131nland\u0131.\r\n\r\n## Lisans\r\n\r\nBu proje MIT Lisans\u0131 alt\u0131nda lisanslanm\u0131\u015ft\u0131r.\r\n\r\n## For those who prefer English:\r\n\r\n## Description\r\n\r\n`bddkdata` is a Python package that enables you to fetch financial tables and banking sector data published on the official website of the Banking Regulation and Supervision Agency (BRSA, BDDK) of Turkey. The library provides fast and flexible access to monthly updated core banking indicators, making your data analysis and reporting processes easier. Data is fetched directly from the BRSA's open data service and delivered in ready-to-use pandas DataFrame format with both Turkish and English column labels.\r\n\r\n## Features\r\n\r\n* Easily fetch monthly tables published by the BRSA for any desired date range.\r\n* Fetch data with Turkish/English column support for all tables and groups.\r\n* Simple to use; outputs are returned directly as `pandas.DataFrame`.\r\n* Errors and messages are displayed in Turkish or English.\r\n* Includes helper functions for listing available tables and group names.\r\n* Optionally save fetched data as an Excel file.\r\n\r\n## Installation\r\n\r\nTo use the package, follow these steps:\r\n\r\n1. Install Python on your system: https://www.python.org/downloads/\r\n2. Open a terminal and install the package with:\r\n\r\n```bash\r\npip install bddkdata\r\n```\r\n\r\nTo install a specific version, use:\r\n\r\n```bash\r\npip install bddkdata==0.1.0\r\n```\r\n\r\nTo check the installed version:\r\n\r\n```bash\r\npip show bddkdata\r\n```\r\n\r\n## Functions\r\n\r\n### `fetch_data`\r\n\r\nFetches table data from the BRSA API.\r\n\r\nParameters:\r\n\r\n* `start_year` (int): Starting year (YYYY)\r\n* `start_month` (int): Starting month (1\u201312)\r\n* `end_year` (int): Ending year (YYYY)\r\n* `end_month` (int): Ending month (1\u201312)\r\n* `table_no` (int): Table number (e.g., 1)\r\n* `currency` (str): \"TL\" or \"USD\"\r\n* `group` (int): Group ID (e.g., 10001)\r\n* `lang` (str): \"tr\" or \"en\" (default \"tr\")\r\n* `save_excel` (bool, optional): If True, saves the result to an Excel file. Defaults to False.\r\n\r\nReturns:\r\n\r\n* `pandas.DataFrame` (or `None` if no data is available)\r\n\r\n### `get_tables`\r\n\r\nFetches the list of available tables.\r\n\r\nParameters:\r\n\r\n* `lang` (str): \"tr\" or \"en\" (default \"tr\")\r\n\r\nReturns:\r\n\r\n* `pandas.DataFrame`\r\n\r\n### `get_groups`\r\n\r\nFetches the list of available groups.\r\n\r\nParameters:\r\n\r\n* `lang` (str): \"tr\" or \"en\" (default \"tr\")\r\n\r\nReturns:\r\n\r\n* `pandas.DataFrame`\r\n\r\n## Example\r\n\r\n```python\r\nfrom bddkdata import fetch_data, get_tables, get_groups\r\n\r\nprint(get_tables(lang=\"en\"))\r\nprint(get_groups(lang=\"en\"))\r\n\r\ndf = fetch_data(\r\n start_year=2024,\r\n start_month=1,\r\n end_year=2025,\r\n end_month=5,\r\n table_no=1,\r\n currency=\"USD\",\r\n group=10001,\r\n lang=\"en\",\r\n save_excel=True\r\n)\r\nprint(df)\r\n```\r\n\r\n## Notes\r\n\r\n* The package depends on data from the official BRSA website. Please check the website for data accuracy and availability: [BRSA](https://www.bddk.org.tr/BultenAylik/en/)\r\n* I welcome your feedback to improve and develop this library. You can contribute on GitHub: [GitHub Repo](https://github.com/urazakgul/bddkdata)\r\n* For any issues or suggestions, please open a new topic in the \"Issue\" section of the GitHub repository: [GitHub Issues](https://github.com/urazakgul/bddkdata/issues)\r\n\r\n## Release Notes\r\n\r\n### v0.1.0 - 19/07/2025\r\n\r\n* First release published.\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License.\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Fetches financial tables and banking sector data from the BRSA (BDDK) website.",
"version": "0.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/urazakgul/bddkdata/issues",
"Documentation": "https://github.com/urazakgul/bddkdata#readme",
"Source Code": "https://github.com/urazakgul/bddkdata"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "769ec77d24d3c2d4552aa9488d57e9427f97737b7f6917f892d9cfb04e96a11a",
"md5": "f6dcece35ef8364e03a3172605077bea",
"sha256": "94649b60c9e479849801ac4b1e72aac5d59b79bc388c38e5455ac02b8d1875be"
},
"downloads": -1,
"filename": "bddkdata-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f6dcece35ef8364e03a3172605077bea",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10514,
"upload_time": "2025-07-19T12:32:03",
"upload_time_iso_8601": "2025-07-19T12:32:03.488111Z",
"url": "https://files.pythonhosted.org/packages/76/9e/c77d24d3c2d4552aa9488d57e9427f97737b7f6917f892d9cfb04e96a11a/bddkdata-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ee54082fcbe8fbe3cfafeb5c49a8f836156aae99554778473c7f6c6aa50b2ca2",
"md5": "792e904ba5515fc58f0fe1a8536dfa03",
"sha256": "24b1e0fd1b621a216b0f223cfc2905cf82220f90f395efc362faa0de75c2b939"
},
"downloads": -1,
"filename": "bddkdata-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "792e904ba5515fc58f0fe1a8536dfa03",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 12252,
"upload_time": "2025-07-19T12:32:04",
"upload_time_iso_8601": "2025-07-19T12:32:04.921554Z",
"url": "https://files.pythonhosted.org/packages/ee/54/082fcbe8fbe3cfafeb5c49a8f836156aae99554778473c7f6c6aa50b2ca2/bddkdata-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-19 12:32:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "urazakgul",
"github_project": "bddkdata",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "bddkdata"
}
