Usage

By default, all commands print the result on the standard output.
Most commands produce RFC4180 compliant CSV content.

Command arguments are composed of options and positional parameters. Options have a name, positional parameters are usually the values that follow the options, but they may be mixed. The general pattern is:

sdmx-dl fetch data ECB EXR M.CHF.EUR.SP00.A -o chf.csv
         command         parameters          options

All commands share the following options:

• -h, --help - Show an help message and exit.
• -v, --verbose - Enable verbose mode.

The commands follow a verb+noun hierarchy.

%%{init:{'themeVariables': {'textColor': '#fdf6e3', 'fontSize': '12px'},'flowchart':{'nodeSpacing': 5, 'rankSpacing': 30}}}%%
flowchart TB
    r{{sdmx-dl}}
    r --- f([fetch]) --- data & meta & keys
    r --- l([list]) --- sources & databases & flows & dimensions & attributes & codes & availability & features & plugins
    r --- c([check]) --- status & access & config & xsources[sources]
    r --- s([setup]) --- completion & launcher

    classDef default fill:#93a1a1,stroke-width:0px 
    linkStyle default stroke:#93a1a1
 
    classDef fx fill:#dc322f
    class f,data,meta,keys fx;
    click f "#fetch" "fetch command"
    click data "#fetch-data" "fetch data command"
    click meta "#fetch-meta" "fetch meta command"
    click keys "#fetch-keys" "fetch keys command"
   
    classDef lx fill:#859900
    class l,sources,databases,flows,dimensions,attributes,codes,availability,features,plugins lx;
    click l "#list" "list command"
    click sources "#list-sources" "list sources command"
    click databases "#list-databases" "list databases command"
    click flows "#list-flows" "list flows command"
    click dimensions "#list-dimensions" "list dimensions command"
    click attributes "#list-attributes" "list attributes command"
    click codes "#list-codes" "list codes command"
    click availability "#list-availability" "list availability command"
    click features "#list-features" "list features command"
    click plugins "#list-plugins" "list plugins command"
   
    classDef cx fill:#268bd2
    class c,status,access,config,xsources cx;
    click c "#check" "check command"
    click status "#check-status" "check status command"
    click access "#check-access" "check access command"
    click config "#check-config" "check config command"
    click xsources "#check-sources" "check sources command"
    
    classDef sx fill:#b58900
    class s,completion,launcher sx;
    click s "#setup" "setup command"
    click completion "#setup-completion" "setup completion command"
    click launcher "#setup-launcher" "setup launcher command"

Download time series.

Subcommands: data, meta, keys

Examples

List resources and structural metadata.

Subcommands: sources, databases, flows, dimensions, attributes, codes, availability, features, plugins

Examples

Check resources and services.

Subcommands: status, access, config, sources

Setup sdmx-dl.

Subcommands: completion, launcher

Download time series observations.

Example: sdmx-dl fetch data ECB EXR M.USD+CHF.EUR.SP00.A

Download time series metadata.

Example: sdmx-dl fetch meta ECB EXR M.USD+CHF.EUR.SP00.A

Download time series keys.

Example: sdmx-dl fetch keys ECB EXR M.USD+CHF.EUR.SP00.A

List data source names and properties.

Example: sdmx-dl list sources

List databases.

Example: sdmx-dl list databases STATFI

List data flows.

Example: sdmx-dl list flows ECB

List data flow dimensions.

Example: sdmx-dl list dimensions ECB EXR

List data flow attributes.

Example: sdmx-dl list attributes ECB EXR

List codes from data flow concept.

Example: sdmx-dl list codes ECB EXR FREQ

List available dimension codes.

Example: sdmx-dl list availability ECB EXR M.CHF… 4

List supported features of a data source.

Example: sdmx-dl list features ECB

List plugin names and properties.

Example: sdmx-dl list plugins

Check service availability.

Example: sdmx-dl check status ECB

Check service accessibility.

Example: sdmx-dl check access ECB

Check sdmx-dl configuration.

Example: sdmx-dl check config

Check sources configuration.

Example: sdmx-dl check sources all