NBB.Stat. Automatic Consultation Technical Manual

Transcription

1 NBB.Stat Automatic Consultation Technical Manual

2 Table of Contents 1. INTRODUCTION CSV SDMX ANNEXES INTRODUCTION This document must be seen as an extension on the general documentation of NBB.Stat. We therefore recommend the user to firstly read the general documentation before starting with this document. NBB.Stat offers via the menu Export several possibilities for Export. The options discussed in detail in this document are the CSV-export and the SDMX-export. More specific, we will focus on the ways NBB.Stat offers us the possibility to consult and download data in an automated way. That is, without having to physically go to the application. Figure 1: Export possibilities As we see in Figure 1, there are other options available under the Export -menu. The option Excel is allows us to export the displayed table to an Excel-file. This is shown in the general documentation of NBB.Stat. PC-axis is a specific format for Windows and Internet environments to present statistical data. This format is not supported by the National Bank of Belgium. The option Related files offers us a way of making files for download available to the user. This could for example be a pdf-file about the methodology of the shown statistics. 2. CSV Today the CSV-format is only available via the User Interface and thus only by manual interventions. This is described in detail in the general documentation of NBB.Stat. It is however foreseen in a future version of NBB.Stat that the CSV-download will be available in an automated form. This would allow the user to download CSV-files without having to physically go to the NBB.Stat application. This documentation will be updated when this new option has become available.

3 3. SDMX NBB.Stat offers an easy way to directly consult the underlying data using the SDMX-protocols. In Figure 2 we see all the different options. We can roughly divide it into two parts: 1. direct download options (the buttons Export to SDMX-file and Export to DSD ) and 2. reusable references (the three text-boxes below). The first part is rather straightforward and has been discussed in the general documentation. We therefore do not discuss this any further here. It is the second part which is to us of most interest. Figure 2: SDMX export options We offer three reusable references of which the last two can be seen as one part: 1. SDMX Query 2. SDMX URL s DATA URL Data Structure Definition URL (DSD) The SDMX-query and -URL s reflect the data that is shown in the active table. If we change the table (e.g. by changing the selected parameters) these changes will be reflected in the SDMX- URL s SDMX-QUERY The SDMX-Query can be used in web service request. A good example of this would be the JSONweb service requests. A good documentation about the use of these SDMX-Queries in webservices can be found on the site of the OECD: When looking at the syntax of these queries, we can divide them into two parts: the header and the actual query. The query allows you to select via any criteria over any period, requesting the data in any format desired. An example of such a query can be found in annex of this document. Each dimension is indicated with a code. The meaning of these codes can be found in the DSD of the dataset (see the section on SDMX-URL s).

4 3.2. SDMX-URL S The SDMX-URL s can be simply pasted in the address-bar of any web browser to directly get to the data in the SDMX-format. The first URL gives you the data itself, the second URL will give you the description of the structure of the dataset and of the codelists used in this dataset. In the annexes of this document, you will find examples of both the data URL and the DSD URL. 4. ANNEXES 4.1. EXAMPLE OF SDMX-QUERY <message:querymessage xmlns=" xmlns:message=" xsi:schemalocation=" xmlns:xsi=" <Header xmlns=" <ID>none</ID> <Test>false</Test> <Truncated>false</Truncated> <Prepared> T12:03:36</Prepared> <Sender id="yourid"> <Name xml:lang="en">your English Name</Name> </Sender> <Receiver id="nbb"> <Name xml:lang="en">organisation for Economic Co-operation and Development</Name> <Name xml:lang="fr">organisation de coopération et de développement économiques</name> <Name xml:lang="nl">nationale Bank van België</Name> </Receiver> </Header> <Query xmlns=" <DataWhere xmlns=" <And> <DataSet>QNA</DataSet> <Dimension id="qna_account">1</dimension> <Dimension id="frequency">a</dimension> <Attribute id="time_format">p1y</attribute> <Time> <StartTime>2010</StartTime> <EndTime>2014</EndTime> </Time> <Dimension id="qna_indicator">b1gm</dimension> <Dimension id="qna_indicator">b1g</dimension> <Dimension id="qna_indicator">d21_m_d31</dimension> <Dimension id="qna_branch">vz</dimension> <Dimension id="qna_branch">va</dimension> <Dimension id="qna_branch">vb_e</dimension> <Dimension id="qna_branch">vf</dimension> <Dimension id="qna_branch">vg_u</dimension> <Dimension id="qna_branch">vg_i</dimension> <Dimension id="qna_branch">vj</dimension> <Dimension id="qna_branch">vk</dimension> <Dimension id="qna_branch">vl</dimension> <Dimension id="qna_branch">vm_n</dimension> <Dimension id="qna_branch">vo</dimension> <Dimension id="qna_branch">vq</dimension> <Dimension id="qna_branch">vr_u</dimension> <Dimension id="qna_price">v</dimension> <Dimension id="qna_price">l</dimension> <Dimension id="qna_price">ly</dimension> <Dimension id="qna_price">lq</dimension> <Dimension id="qna_price">cy</dimension>

5 <Dimension id="qna_price">cq</dimension> <Dimension id="qna_price">d</dimension> <Dimension id="qna_adj">y</dimension> <Dimension id="qna_adj">n</dimension> </And> <And> <DataSet>QNA</DataSet> <Dimension id="qna_account">1</dimension> <Dimension id="frequency">q</dimension> <Attribute id="time_format">p3m</attribute> <Time> <StartTime>2012-Q4</StartTime> <EndTime>2014-Q4</EndTime> </Time> <Dimension id="qna_indicator">b1gm</dimension> <Dimension id="qna_indicator">b1g</dimension> <Dimension id="qna_indicator">d21_m_d31</dimension> <Dimension id="qna_branch">vz</dimension> <Dimension id="qna_branch">va</dimension> <Dimension id="qna_branch">vb_e</dimension> <Dimension id="qna_branch">vf</dimension> <Dimension id="qna_branch">vg_u</dimension> <Dimension id="qna_branch">vg_i</dimension> <Dimension id="qna_branch">vj</dimension> <Dimension id="qna_branch">vk</dimension> <Dimension id="qna_branch">vl</dimension> <Dimension id="qna_branch">vm_n</dimension> <Dimension id="qna_branch">vo</dimension> <Dimension id="qna_branch">vq</dimension> <Dimension id="qna_branch">vr_u</dimension> <Dimension id="qna_price">v</dimension> <Dimension id="qna_price">l</dimension> <Dimension id="qna_price">ly</dimension> <Dimension id="qna_price">lq</dimension> <Dimension id="qna_price">cy</dimension> <Dimension id="qna_price">cq</dimension> <Dimension id="qna_price">d</dimension> <Dimension id="qna_adj">y</dimension> <Dimension id="qna_adj">n</dimension> </And> </DataWhere> </Query> </message:querymessage> 4.2. EXAMPLE OF SDMX-URL S For the SDMX-URL example, we use the exact same data as used for the example of the SDMXquery. The URL is much less verbose that the query but both give exactly the same result. We also recognise the same codes as used in the query. The explanation for these codes can be found in the DSD (see further). +VG_I+VJ+VK+VL+VM_N+VO+VQ+VR_U.V.N.Q/all?startTime=2010&endTime=2014

6 Typing the above URL in your web browser will give you the following SDMX-file as a result (partial): The classifications and codes used in the URL and query can be found using the link to the DSD. Typing the above URL in your web browser will give you the following SDMX-file as a result (partial):

7