A versatile interface for the 'EDDS' (EVDS) API of the Central Bank of the Republic of Türkiye (https://evds2.tcmb.gov.tr/index.php?/evds/userDocs). This package allows users to easily access and manage economic data through a user-friendly menu function. It features a robust caching mechanism to enhance the efficiency of data requests by storing frequently accessed data for selected periods. Required API keys can be obtained by registering on the EVDS website.
pip install evdspy -U
get_series_exp function was added
see Documentation for its usage and result data types
please see evdschat package for extended usage of evdspy package.
api key will be read from .env file on load if available.
You may create a .env file in your work environment and write your api key as follows. Script will load your api key from this file on load if available.
# filename : `.env`
EVDS_API_KEY=AxByCzDsFoGmHeIgJaKrLbMaNgOe
You may also define your proxies as below in your .env file.
Script will load your proxies from this file if they exist.
# example `.env` file content
EVDS_API_KEY=AxByCzDsFoGmHeIgJaKrLbMaNgOe
http_proxy=http://proxy.example.com:80
https_proxy=http://proxy.example.com:80
from evdspy import get_series, default_start_date_fnc, default_end_date_fnc
df1 = get_series("bie_gsyhgycf", cache=False, api_key="YOUR_API_KEY_HERE")
template = """TP_GSYIH01_GY_CF
TP_GSYIH02_GY_CF
TP_GSYIH03_GY_CF
TP_GSYIH04_GY_CF
TP_GSYIH05_GY_CF
TP_GSYIH06_GY_CF
TP_GSYIH07_GY_CF
TP_GSYIH08_GY_CF
TP_GSYIH09_GY_CF
TP_GSYIH10_GY_CF
TP_GSYIH11_GY_CF
TP_GSYIH14_GY_CF
TP_GSYIH15_GY_CF
TP_GSYIH16_GY_CF
"""
df2 = get_series(template, debug=False, cache=False)
from evdspy import get_series , get_series_exp
CPI = """
TP.FG.J0 # Consumer Price Index
"""
inf_exp_market_part = """
TP.ENFBEK.PKA12ENF # Annual inflation expectations of market participants (12-month ahead, %)
"""
inf_exp_real_sector = """
TP.ENFBEK.IYA12ENF # Annual inflation expectations of real sector (12-month ahead, %)
"""
for index in [CPI, inf_exp_market_part, inf_exp_real_sector]:
res = get_series_exp(index , cache = True , start_date = "01-01-2010" )
print(res.data)
print(res.metadata)
from evdspy import get_series_exp
cpi_table = """
bie_tukfiy4 # CPI
"""
inf_exp_table = """
bie_enfbek # inflation expectations
"""
reserves_table = """
bie_abres2 # reserves
"""
def clean_name(name : str ) :
return name.replace("\n" , "" ).replace(" " , "")
for index in [cpi_table, inf_exp_table, reserves_table]:
res = get_series_exp(index, cache=True, start_date="01-01-2010")
print(res.data)
print(res.metadata)
res.to_excel(clean_name(index) + ".xlsx")
from evdspy import get_series
template = '''
TP.ODEMGZS.BDTTOPLAM
TP.ODEMGZS.ABD
TP.ODEMGZS.ARJANTIN
'''
df = get_series(index=template)
df1 = get_series(index=template, start_date="01-01-2000", frequency="monthly")
df2a = get_series(index='TP.ODEMGZS.BDTTOPLAM', start_date="01-01-2000", frequency="monthly", cache=True)
df2b = get_series(index=('TP.ODEMGZS.BDTTOPLAM', 'TP.ODEMGZS.ARJANTIN',),
start_date="01-01-2000",
frequency="monthly",
cache=True)
df3 = get_series(template, start_date="01-01-2000", frequency="monthly", aggregation="avg")
df4 = get_series(template, start_date="01-01-2000", frequency="monthly", aggregation=("avg", "min", "avg"))
df5 = get_series(template, proxy="http://proxy.example.com:80")
df6 = get_series(template, proxies={
'http': "http://proxy.example.com:80",
'https': "http://proxy.example.com:80",
})
all parameters of get_series function
from typing import Union
import pandas as pd
def get_series(
index: Union[str, tuple[str]],
start_date: str = '01-01-2000',
end_date: str = '01-01-2100',
frequency: str = None, # | monthly | weekly | annually | semimonthly | semiannually | business
formulas: str = None, # | level | percentage_change | difference |
# | year_to_year_percent_change | year_to_year_differences |
aggregation: str = None, # | avg |min | max | first | last | sum
cache: bool = False,
proxy: str = None,
proxies: dict = None,
debug: bool = False
) -> pd.DataFrame:
...
"""proxy
proxy = "http://proxy.example.com:80"
"""
"""proxies
proxies = {
'http': "http://proxy.example.com:80",
'https': "http://proxy.example.com:80",
}
"""
Here is the documentation for other functions and details.
python script
from evdspy import menu
menu()
command line / Terminal
$ evdspy menu
evdspy is an open source python interface which helps you make efficient requests by caching results (storing a dict using hashable parameters in order to avoid redundant requests), it provides a user friendly menu to ask data from the institution's API service. It is a Python interface to make requests from (CBRT) EVDS API Server. Fast, efficient and user friendly solution. Caches results to avoid redundant requests. Creates excel files reading configuration text file that can be easily created from the menu or console. Provides visual menu to the user. It is extendable and importable for user's own python projects.
pip install evdspy -U
from evdspy import *
check()
get()
help_evds()
or import evdspy as ev ev.check() ev.get() ev.help_evds()
from evdspy import *
menu()
or import evdspy as ev ev.menu() Menu function will display a friendly menu to setup project, creating output folders and some setup files to create some set of series to make a request and download from EVDS server save your api key to get data from EVDS. Than it will convert this data to a pandas dataframe and create some folders on your local area.
'console',
'menu',
'version',
'save_apikey',
'save',
'remove_cache',
check setup and create required folders and see current installation status.
creates folders and files
____Folders_______________
`caches`
will be used to store some request results to ovoid redundant requests from the EVDS api
`SeriesData`
to save results of requests or caches to an excel file using information on user option files
____Files_______________
`options.cfg`
a text file consisting global user options such as start date, end date and caching period.
`config_series.cfg`
this file consists information regarding individual sets of series. From the menu user can add
new series that will be requesting from the server. Program will produce on for example and this file
can be modified and new sets of series can be added following the example format.
from evdspy.main import *
setup_now()
# this will check for your current series.txt file
# if proper data series codes are given it will either download them
# or use the latest cache from your local environment
# to provide other cache options such as nocache / daily / hourly you may change your
# defaults or give arguments such as
get()
checking....
(Windows Command line / Linux Terminal / Mac Terminal) ( > , $ , $ as $ )
$ evdspy setup
--------------
creates initial folders for your environment to save data and caches
$ evdspy menu
--------------
Launces evdspy and loads the menu
$ evdspy create series
--------------
Creates series file (leaves untouched if exists)
$ evdspy help
--------------
shows help and some documentation from command line
$ evdspy create options
--------------
creates options on the current folder
$ evdspy get
--------------
makes request from EVDS API and creates excel files regarding information on your series file
$ evdspy save
--------------
asks for your api key to save a file in your environment named APIKEY_FOLDER
Here is the documentation for other functions and details. Documentation
Get a CBRT EVDS API key https://evds2.tcmb.gov.tr/index.php?/evds/login
https://evds2.tcmb.gov.tr/index.php?/evds/userDocs
evdspy is an open source python interface which helps you make efficient requests by caching results (storing a dict using hashable parameters in order to avoid redundant requests), it provides a user friendly menu to ask data from the institution's API service.
We would like inform you that evdspy is not an official package affiliated or endorsed by the CBRT institution.
It is an open source project with MIT LICENSE therefore following the rules of its
general MIT LICENSE you may use this interface without creator's permission, extend it or write your own modules
by importing evdspy's modules, classes or functions to request data from the mentioned API Service following the
institution's rules and parameters.
FAQs
A versatile interface for the 'EDDS' (EVDS) API of the Central Bank of the Republic of Türkiye (https://evds2.tcmb.gov.tr/index.php?/evds/userDocs). This package allows users to easily access and manage economic data through a user-friendly menu function. It features a robust caching mechanism to enhance the efficiency of data requests by storing frequently accessed data for selected periods. Required API keys can be obtained by registering on the EVDS website.
We found that evdspy demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.