0% found this document useful (0 votes)
182 views17 pages

EVDS Web Service Usage Guide

Uploaded by

Karen Aghabekyan
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
182 views17 pages

EVDS Web Service Usage Guide

Uploaded by

Karen Aghabekyan
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 17

CENTRAL BANK OF

THE REPUBLIC OF TURKEY

THE ELECTRONIC DATA DELIVERY SYSTEM

EVDS Web Service Usage Guide

January 2022
1. EVDS Series Data Services

The parameters of web service methods are defined in this document.

Different function parameters are separated by "&" sign.

The data in EVDS are updated most frequently in daily frequency. Therefore, data collection
once a day is very important in terms of overall system performance with Web service method. It
may also be useful to encode the data for the same data group together with the data needed by a
single call.

Serial Parameters

Parameter Name Description


series The serial codes are displayed. If more than one series is selected, it takes
up parameters as the number of series, the serial codes are separated by a
"-" sign.
Date Parameters

Parameter Name Description


startDate The start date is given.
endDate The end date is given.

In order to display the frequency of the desired series, the first day of the corresponding
frequency must be stated in the start date as dd-mm-yyyy format.

Example:

The series of (USD) US Dollar (Selling) coded as TL.DK.USD.S.YTL with starting date 01-01-
2005 and annual frequency is calculated as follows:

https://evds2.tcmb.gov.tr/service/evds/series=TP.DK.USD.S.YTL&startDate=01-01-
2005&endDate=01-02-
2017&type=xml&key=XXXXXXXX&aggregationTypes=avg&formulas=1&frequency=8

The year of 2005 is displayed as the start date of this search.

However, when all parameters are fixed for the same series and only the start date is changed as
02-01-2005;

1
https://evds2.tcmb.gov.tr/service/evds/series=TP.DK.USD.S.YTL&startDate=02-01-
2005&endDate=01-02-
2017&type=xml&key=XXXXXXXX&aggregationTypes=avg&formulas=1&frequency=8

the list starts with the year of 2006. For this reason, the first day of the corresponding frequency
must be indicated in order to display the desired frequency as in the example.

The End Date format will be also dd-mm-yyyy.

Format Parameters

Parameter Name Description


type The return types of web service are as csv, xml or json Object.

decimalSeperator “,”, “.”. Default value is period.

API Key Parameters

Parameter Name Description


key API key is defined on the user.
*** The API Key (key=XXXXXXX) is defined differently for each user and given with registration.

You can see the API Key with these steps:

• Sign in

• Click your username

• Select Profile menu

• Select API Key option

Observation Parameters

Parameter Name Description


aggregationTypes If more than one series is selected, it takes up parameters as the number of
series, the serial codes are separated by a "-" sign.

Average: avg,
Minimum: min,
Maximum: max
Beginning: first,
End: last,
Cumulative: sum

2
If this parameter is not entered by the user, the original observation
parameter is applied for the relevant series.

Formula Parameters

Parameter Name Description


formulas If more than one series is selected, it takes up parameters as the number of
series, the serial codes are separated by a "-" sign.

Level: 0
Percentage change: 1
Difference: 2
Year-to-year Percent Change: 3
Year-to-year Differences: 4
Percentage Change Compared to End-of-Previous Year: 5
Difference Compared to End-of-Previous Year : 6
Moving Average: 7
Moving Sum: 8

If this parameter is not entered by the user, the level formula parameter is
applied for the relevant series.

Frequency Parameters

Parameter Name Description


frequency This parameter takes a single value.

Daily: 1
Business: 2
Weekly(Friday): 3
Twicemonthly: 4
Monthly: 5
Quarterly: 6
Semiannual: 7
Annual: 8

If this parameter is not entered by the user, the common frequency of the
series is taken.
f you enter a higher frequency (eg monthly) than the common frequency
of the series (eg: annually), the common frequency of the series is taken
into account (eg: annually).

3
2. Sample Links from the Most Frequently Used Series
2.1. Level Values Requests

Category: Exchange Rates

Data group: Exchange Rates(*)

Series: (USD) US Dollar (Buying)- TP.DK.USD.A, Series: (EUR) Euro (Buying)- TP.DK.EUR.A,
Series: (CHF) Swiss Franc (Buying) - TP.DK.CHF.A, Series: (GBP) Pound Sterling (Buying)-
TP.DK.GBP.A, Series: (JPY) 100 Japanese Yen (Buying) - TP.DK.JPY.A

The link displays the series with formula level, output format xml and start date: 01-10-2017 and
end date: 01-11-2017.

https://evds2.tcmb.gov.tr/service/evds/series=TP.DK.USD.A-TP.DK.EUR.A-TP.DK.CHF.A-
TP.DK.GBP.A-TP.DK.JPY.A&startDate=01-10-2017&endDate=01-11-2017&type=xml&key=
XXXXXXX

2.2. The exemplified links are generated from the most commonly used series with
frequecy formulas:

Category: Exchange Rates

Data group: Exchange Rates(**)

Series: (USD) US Dollar (Buying)- TP.DK.USD.A.YTL series start date: 01-02-2005 and end date: 01-02-
2017,format parameter xml, observation value average, formula percentage change and frequency annually are
calculated as follows:

https://evds2.tcmb.gov.tr/service/evds/series=TP.DK.USD.A.YTL&startDate=01-02-2005&endDate=01-
02-2017&type=xml&key=XXXXXXX&aggregationTypes=avg&formulas=1&frequency=8

Series: (USD) US Dollar (Selling)- TP.DK.USD.S.YTL series start date: 01-02-2005 and end date: 01-02-
2017,format parameter xml, observation value average, formula percentage change and frequency annually are
calculated as follows:

https://evds2.tcmb.gov.tr/service/evds/series=TP.DK.USD.S.YTL&startDate=01-02-2005&endDate=01-
02-2017&type=xml&key=XXXXXXX&aggregationTypes=avg&formulas=1&frequency=8

4
Series: (EUR) Euro (Buying)- P.DK.EUR.A.YTL series start date: 01-02-2005 and end date: 01-02-
2017,format parameter xml, observation value average, formula percentage change and frequency annually are
calculated as follows:

https://evds2.tcmb.gov.tr/service/evds/series=TP.DK.EUR.A.YTL&startDate=01-02-2005&endDate=01-
02-2017&type=xml&key=XXXXXXX&aggregationTypes=avg&formulas=1&frequency=8

Series: (EUR) Euro (Selling)- P.DK.EUR.S.YTL series start date: 01-02-2005 and end date: 01-02-
2017,format parameter xml, observation value average, formula percentage change and frequency annually are
calculated as follows:

https://evds2.tcmb.gov.tr/service/evds/series=TP.DK.EUR.S.YTL&startDate=01-02-2005&endDate=01-
02-2017&type=xml&key=XXXXXXX&aggregationTypes=avg&formulas=1&frequency=8

5
3. All Series Data By Given Data Group

This web service presents data from the all connected series based on the selected data group.

Data Group Parameters

Parameter Name Description


datagroup data group code
Sample Links

https://evds2.tcmb.gov.tr/service/evds/datagroup=bie_yssk&startDate=01-06-2017&endDate=07-09-
2017&type=csv&key=XXXX

4. EVDS Metadata Web Services


4.1. Category Service
This web service presents all categories in EVDS. “categories” must be added after the
web definition “https://evds2.tcmb.gov.tr/service/evds”.

Sample Link:

https://evds2.tcmb.gov.tr/service/evds/categories/key=XXXXXX&type=xml

The web service contains:

CATEGORY_ID Category Code

TOPIC_TITLE_TR Category Name

TOPIC_TITLE_ENG Category Name English

4.2.Data Group Service


This web service presents data goups in EVDS. “datagroups” must be added after the
web definition “https://evds2.tcmb.gov.tr/service/evds”.

6
Mode Parameters

Parameter Name Description

The data group listing is based on the following filtering:

mode=0 Returns all data groups under all categories.


mode mode=1 Returns data group information according to a data group selection.
mode=2 Returns all data groups information according to a category.

Code Parameters

Parameter Name Description


For mode=1;
code=data group code
code
For mode=2;
code=category code
Sample Links:

https://evds2.tcmb.gov.tr/service/evds/datagroups/key=XXXX&mode=1&code=bie_yssk&type=json

https://evds2.tcmb.gov.tr/service/evds/datagroups/key=XXXX&mode=2&code=2&type=xml

The web service contains:

Code Description
DATAGROUP_CODE Data Group Code
DATAGROUP_NAME Data Group Name (Turkish)
DATAGROUP_NAME_ENG Data Group Name (English)
START_DATE Data Start Date
END_DATE Date End Date
FREQUENCY Original Frequency
FREQUENCY_STR Original Frequency Desc.
DATASOURCE Data Source (Turkish)
DATASOURCE_ENG Data Source (English)
METADATA_LINK Metadata Link (Turkish)
METADATA_LINK_ENG Metadata Link (English)
REV_POL_LINK Revision Policy Link (Turkish)

7
REV_POL_LINK_ENG Revision Policy Link (English)
APP_CHA_LINK Application Change Link (Turkish)
APP_CHA_LINK_ENG Application Change Link (English)
NOTE Information Note (Turkish)
NOTE_ENG Information Note (English)

4.3. Series Service

This web service presents the series list based on data group and series code in EVDS. “serieList”
must be added after the web definition “https://evds2.tcmb.gov.tr/service/evds”.

Code Parameters

Parametre Adı Açıklama


code code= category code or data group code

Sample Links

https://evds2.tcmb.gov.tr/service/evds/serieList/key=XXXXX&type=xml&code=TP.DK.USD.A

https://evds2.tcmb.gov.tr/service/evds/serieList/key=XXXXX&type=csv&code=bie_yssk

The web servis contains:

Code Description

SERIE_CODE Series Code


DATAGROUP_CODE Data Group Code
SERIE_NAME Series Name (Turkish)
SERIE_NAME_ENG Series Name (English)
FREQUENCY_STR Original Frequency Desc.
DEFAULT_AGG_METHOD_STR Default Conversion Method Desc.
DEFAULT_AGG_METHOD Default Conversion Method
TAG Tag (Turkish)
TAG_ENG Tag (English)
DATASOURCE Data Source (Turkish)
DATASOURCE_ENG Data Source (English)

8
METADATA_LINK Metadata Link (Turkish)
METADATA_LINK_ENG Metadata Link (English)
REV_POL_LINK Revision Policy Link (Turkish)
REV_POL_LINK_ENG Revision Policy Link (English)
APP_CHA_LINK Application Change Link (Turkish)
APP_CHA_LINK_ENG Application Change Link (English)
START_DATE Data Start Date
END_DATE Date End Date

9
5. Import Data into Excel with Web Service Method

5.1. Excel 2013 version

-Open new workbook and then Click DATA tab

-Click Get External Data-> From Web

-Enter the EVDS web service URL and then click the Import button.

10
-Click Ok button

-Click Ok button to import data

11
You can use Refresh All button in the Data tab to retrieve new data

12
5.2. Excel 2016 version

-Open new workbook and then Click Data Tab

-Click From Other Sources and then Click From Web

13
-Enter the web service url

14
15
You can use Refresh button to retrieve new data in the given date range.

16

You might also like