Skip to contents

Retrieve metadata from the Bank of Israel SDMX Web Service.

Usage

boi_metadata(type, id = NULL, lang = "en")

Arguments

type

(character(1))
The type of metadata to query. One of: "datastructure", "dataflow", "codelist", or "concept".

id

(NULL | character(1))
The id to query. Default NULL.

lang

(character(1))
Language for names, either "en" or "he". Default "en".

Value

A data.table::data.table() with the requested metadata.

Examples

# \donttest{
boi_metadata("dataflow")
#>               id                                                       name
#>           <char>                                                     <char>
#>  1:          ACC                                                       <NA>
#>  2:          ATM                                                       <NA>
#>  3:       BBS_99                             Monthly Balance Sheets - Banks
#>  4:       BFR_99                               Financial Statements - Banks
#>  5:          BIR    Interest rates and business volume - exc. housing loans
#>  6:  BIR_MRTG_99         Interest rates and business volume - housing loans
#>  7:          BKN                                        Banknotes and Coins
#>  8:       BMB_99                                       Balances for housing
#>  9:          BOP                                                       <NA>
#> 10:           BR                                          BOI interest rate
#> 11:        BTS_7                                   Business Tendency Survey
#> 12:          CAP                                                       <NA>
#> 13:        CARDS                                                       <NA>
#> 14:         CCIR Credit Card Companies - Interest Rates and Business Volume
#> 15:          CCP                                                       <NA>
#> 16:      CHEQUES                                                     Checks
#> 17:         CONS                                               Construction
#> 18:     DEBT_AGG                                 Debt and credit aggregates
#> 19:          DRV                                             Trade Turnover
#> 20:     ECON_IND                                                       <NA>
#> 21:          ENR                                                     Energy
#> 22:          EXR                                             Exchange rates
#> 23:          EXS                                        External Statistics
#> 24:         EZER                                                       EZER
#> 25: EZER_PIK_MOS                                                       <NA>
#> 26:          FTR                                              Foreign Trade
#> 27:       INSINV                                                       <NA>
#> 28:      INSINV2                                    Institutional Investors
#> 29:          LBM                                               Labor Market
#> 30:          MAG                                         Monetay Aggregates
#> 31:        MASAV                                                  ACH-MASAV
#> 32:           MF                                               Mutual Funds
#> 33:          MNF                                                   Industry
#> 34:           NA                                          National Accounts
#> 35:          PRI                                                       <NA>
#> 36:           PS                                              Public Sector
#> 37:   REAL_ES_DF                                                Real estate
#> 38:          REV                                                       <NA>
#> 39:       SECDWH                                            Securities TASE
#> 40:          TLB                                               Telbor rates
#> 41:        ZAHAV                                                 RTGS-ZAHAV
#> 42:          ZCM                Inflation expectations and zero yield curve
#>               id                                                       name
#>           <char>                                                     <char>
boi_metadata("datastructure")
#>                   id                                                     name
#>               <char>                                                   <char>
#>  1:              ACC                                               Accounting
#>  2:              ATM                                                      ATM
#>  3:              BBS                                    Monthly Balance Sheet
#>  4:              BFR                                Banking Financial Reports
#>  5:              BIR                                   Banking Interest Rates
#>  6:         BIR_MRTG        INTEREST RATE AND BUSINESS VOLUME - HOUSING LOANS
#>  7:              BKN                                      Banknotes and Coins
#>  8:              BMB                                 Banking Mortgage Balance
#>  9:              BOP                                      Balance of Payments
#> 10:              BTS                                 BUSINESS TENDENCY SURVEY
#> 11:              CAP                                            Capital Stock
#> 12:            CARDS                                                    Cards
#> 13:             CCIR Credit Card Companies Interest Rates and Business Volume
#> 14:              CCP                                             Credit cards
#> 15:          CHEQUES                                                  Cheques
#> 16:             CONS                                             Construction
#> 17:         DEBT_AGG                               Debt and credit aggregates
#> 18:              DRV                                              Derivatives
#> 19: DSD_EZER_PIK_MOS                                             EZER PIK MOS
#> 20:         ECON_IND                          Indicators of economic activity
#> 21:              ENR                                                   Energy
#> 22:              EXR                                           Exchange Rates
#> 23:              EXS                                      External Statistics
#> 24:          FTR_NEW                                        Foreign Trade NEW
#> 25:           INSINV                                  Institutional Investors
#> 26:          INSINV2                                  Institutional Investors
#> 27:              LBM                                             LABOR MARKET
#> 28:              MAG                                      Monetary aggregates
#> 29:            MASAV                                                    Masav
#> 30:               MF                                             Mutual Funds
#> 31:              MNF                                            Manufacturing
#> 32:               NA                                        National Accounts
#> 33:              PRI                                            Price Indices
#> 34:               PS                                            Public Sector
#> 35:              RBB                  Central Bank rates and Inter-Bank rates
#> 36:          REAL_ES                                              Real estate
#> 37:              REV                                          Revenue Indices
#> 38:           SECDWH                                      Securities TASE DWH
#> 39:            ZAHAV                                                    Zahav
#> 40:              ZCM                                              Zero Coupon
#>                   id                                                     name
#>               <char>                                                   <char>
boi_metadata("codelist", "CL_FREQ")
#>         id      name
#>     <char>    <char>
#> 1: CL_FREQ Frequency
# }