Skip to main content

A Python implementation for retrieving and transforming macroeconomic time series data from TCMB EVDS (CBRT EDDS) API.

Project description

evdsts

Macroeconomic time series toolkit for TCMB EVDS (CBRT EDDS)

PyPI version Downloads Python Version Status License Issues Top Language Forks


The Purpose

evdsts is a Python implementation for retrieving and transforming macroeconomic time series data from The Central Bank of Republic of Turkiye Electronic Data Delivery System (EDDS) API. evdsts is designed for making both data retrieving and also time series analysis easy thanks to its time series analysis ready outputs and other useful transformations.

Overview

evdsts is mainly designed for preparing the time series analysis ready datasets from the data retrieved from EDDS. evdsts both makes the data retrieving easy and also allows you to start working on data instantly with its advanced features that gives you complete control over the retrieved data.

evdsts is consisted of two important classes:

Class Responsibility
Connector Connecting to EDDS, data retrieving, data renaming, etc.
Transformator Co-integrated transformations such as z-score, dummies, outliers, differencing and more.

Key Features

  • In-situ search -- search series by keywords without leaving Python; results are instant and local.
  • Analysis-ready outputs -- every returned value is guaranteed to be a proper numeric or datetime type, never a raw string.
  • Auto time-series indexing -- retrieved data are converted to real pandas DatetimeIndex series automatically (optional).
  • Reference names -- assign memorable aliases like usdtry or cppi to complex EDDS codes; aliases are permanent and portable across projects.
  • Human-readable parameters -- use daily, quarterly, percent, diff, max instead of cryptic API codes.
  • Pre-flight validation -- many parameter errors are caught before any network request is made.
  • Extended transformations -- log-returns, higher-order differences and other operations not natively supported by the API.
  • Flexible output -- get results as DataFrame, JSON or dict; write to disk as CSV, JSON or XLS.
  • CLI support -- rebuild search indexes from the command line with evdsts build-index.
  • Fully annotated -- type hints and docstrings everywhere for IDE autocompletion and quick help.

Quick Start

from evdsts import Connector

connector = Connector("YOUR_API_KEY", language="EN")

# search for a series
connector.where("consumer price index")

# retrieve data
cpi = connector.get_series("TP.FE.OKTG01", start_date="01.01.2020")

# retrieve multiple series
rates = connector.get_series(
    "TP.DK.USD.A.YTL, TP.DK.EUR.A.YTL",
    start_date="01.01.2023",
    frequency="M",
    transformations="percent",
)

CLI Usage

# rebuild the search index
evdsts build-index --language ENG -y

# see all options
evdsts build-index --help

Documentation

Please see THE USER MANUAL for detailed explanations about how to get an API key from the EDDS and use evdsts.

Examples Open In Colab

Download the Jupyter Notebook Application that covers the main use cases of evdsts, or alternatively open it on Google Colab by clicking the Open in Colab badge above.

Installation

Stable version of evdsts is available on GitHub, PyPI and conda-forge.

# PyPI
pip install evdsts

# GitHub
pip install git+https://github.com/syncoding/evdsts.git

# Conda
conda install evdsts -c conda-forge

Dependencies

Package Version
Python >= 3.13
pandas >= 3.0.0
requests >= 2.32.5
tqdm >= 4.67.3

openpyxl is additionally required if you want to write data in MS Excel format.

Links

Source Code GitHub
Changelog CHANGELOG.md
License MIT

Contact

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

evdsts-0.1.4.tar.gz (1.0 MB view details)

Uploaded Source

Built Distribution

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

evdsts-0.1.4-py3-none-any.whl (1.0 MB view details)

Uploaded Python 3

File details

Details for the file evdsts-0.1.4.tar.gz.

File metadata

  • Download URL: evdsts-0.1.4.tar.gz
  • Upload date:
  • Size: 1.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Hatch/1.16.3 cpython/3.14.3 HTTPX/0.28.1

File hashes

Hashes for evdsts-0.1.4.tar.gz
Algorithm Hash digest
SHA256 86ba69c50e05bdb2f662515338e099fefdd7e9fa8f0cd4219e1aa79a476be31d
MD5 01140c5c7ae6d57a2d35e9a8d81be7f1
BLAKE2b-256 e3c6f9095c009d94fac0246fc5b05198e1ba5f8516e5a0b2d0c7511f9dcbd976

See more details on using hashes here.

File details

Details for the file evdsts-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: evdsts-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 1.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Hatch/1.16.3 cpython/3.14.3 HTTPX/0.28.1

File hashes

Hashes for evdsts-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 1f1f9810b73203d4a1cd502a1d9f87287339b4abb393badc4631bef4a0844047
MD5 b6df8262cc62cd71a21fa3eb907f31c6
BLAKE2b-256 6a2c7c01b9bb87db7628ae1798ea3989669296dc2a88776db766579e2f15841e

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