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:      BBS_99                             Monthly Balance Sheets - Banks
#>  2:      BFR_99                               Financial Statements - Banks
#>  3:         BIR    Interest rates and business volume - exc. housing loans
#>  4: BIR_MRTG_99         Interest rates and business volume - housing loans
#>  5:         BKN                                        Banknotes and Coins
#>  6:      BMB_99                                       Balances for housing
#>  7:          BR                                          BOI interest rate
#>  8:       BTS_7                                   Business Tendency Survey
#>  9:        CCIR Credit Card Companies - Interest Rates and Business Volume
#> 10:     CHEQUES                                                     Checks
#> 11:        CONS                                               Construction
#> 12:    DEBT_AGG                                 Debt and credit aggregates
#> 13:         DRV                                             Trade Turnover
#> 14:         ENR                                                     Energy
#> 15:         EXR                                             Exchange rates
#> 16:         EXS                                        External Statistics
#> 17:        EZER                                                       EZER
#> 18:         FTR                                              Foreign Trade
#> 19:     INSINV2                                    Institutional Investors
#> 20:         LBM                                               Labor Market
#> 21:         MAG                                         Monetay Aggregates
#> 22:       MASAV                                                  ACH-MASAV
#> 23:          MF                                               Mutual Funds
#> 24:         MNF                                                   Industry
#> 25:          NA                                          National Accounts
#> 26:          PS                                              Public Sector
#> 27:  REAL_ES_DF                                                Real estate
#> 28:      SECDWH                                            Securities TASE
#> 29:         TLB                                               Telbor rates
#> 30:       ZAHAV                                                 RTGS-ZAHAV
#> 31:         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:              DEM                                               DEMOGRAPHY
#> 19:              DRV                                              Derivatives
#> 20: DSD_EZER_PIK_MOS                                             EZER PIK MOS
#> 21:         ECON_IND                          Indicators of economic activity
#> 22:              ENR                                                   Energy
#> 23:              EXR                                           Exchange Rates
#> 24:              EXS                                      External Statistics
#> 25:          FTR_NEW                                        Foreign Trade NEW
#> 26:           INSINV                                  Institutional Investors
#> 27:          INSINV2                                  Institutional Investors
#> 28:              LBM                                             LABOR MARKET
#> 29:              MAG                                      Monetary aggregates
#> 30:            MASAV                                                    Masav
#> 31:               MF                                             Mutual Funds
#> 32:              MNF                                            Manufacturing
#> 33:               NA                                        National Accounts
#> 34:              PRI                                            Price Indices
#> 35:               PS                                            Public Sector
#> 36:              RBB                  Central Bank rates and Inter-Bank rates
#> 37:          REAL_ES                                              Real estate
#> 38:              REV                                          Revenue Indices
#> 39:           SECDWH                                      Securities TASE DWH
#> 40:            ZAHAV                                                    Zahav
#> 41:              ZCM                                              Zero Coupon
#>                   id                                                     name
#>               <char>                                                   <char>
boi_metadata("codelist", "CL_FREQ")
#>          id                  name
#>      <char>                <char>
#>  1: CL_FREQ             Frequency
#>  2: CL_FREQ  Daily – businessweek
#>  3: CL_FREQ              Minutely
#>  4: CL_FREQ                Annual
#>  5: CL_FREQ Half-yearly, semester
#>  6: CL_FREQ             Quarterly
#>  7: CL_FREQ               Monthly
#>  8: CL_FREQ                Weekly
#>  9: CL_FREQ                 Daily
#> 10: CL_FREQ                Hourly
#> 11: CL_FREQ              Biweekly
#> 12: CL_FREQ           Semimonthly
# }