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 & flows & dimensions & attributes & codes & availability & features & drivers
r --- c([check]) --- status & access & config
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,flows,dimensions,attributes,codes,availability,features,drivers lx;
click l "#list" "list command"
click sources "#list-sources" "list sources 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 drivers "#list-drivers" "list drivers command"
classDef cx fill:#268bd2
class c,status,access,config 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"
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.
List resources and structural metadata.
Subcommands: sources, flows, dimensions, attributes, codes, availability, features, drivers
Check resources and services.
Subcommands: status, access, config
Setup sdmx-dl.
Subcommands: completion, launcher
Download time series observations.
Example: sdmx-dl fetch data ECB EXR M.USD+CHF.EUR.SP00.A
Parameters:
Main options:
-s, --sources<file>- File that provides data source definitions.-l, --languages<langs>- Language priority list.
Output format:
[
Series:key,
ObsAttributes:map,
ObsPeriod:datetime,
ObsValue:number
]
Download time series metadata.
Example: sdmx-dl fetch meta ECB EXR M.USD+CHF.EUR.SP00.A
Parameters:
Main options:
-s, --sources<file>- File that provides data source definitions.-l, --languages<langs>- Language priority list.--sort- Sort output.
Output format:
[
Series:key,
Concept:string,
Value:string
]
Download time series keys.
Example: sdmx-dl fetch keys ECB EXR .USD+CHF.EUR.SP00.A
Parameters:
Main options:
-s, --sources<file>- File that provides data source definitions.-l, --languages<langs>- Language priority list.--sort- Sort output.
Output format:
[
Series:key
]
List data source names and properties.
Example: sdmx-dl list sources
Main options:
-s, --sources<file>- File that provides data source definitions.
Other options:
CSV
Output format:
[
Name:source,
Description:string,
Aliases:list,
Driver:string,
Dialect:string,
Endpoint:uri,
Properties:map,
Website:url,
Monitor:uri,
MonitorWebsite:url,
Languages:list
]
List data flows.
Example: sdmx-dl list flows ECB
Parameters:
source- Data source name.
Main options:
-s, --sources<file>- File that provides data source definitions.-l, --languages<langs>- Language priority list.--sort- Sort output.
Output format:
[
Ref:flow,
Label:string
]
List data flow dimensions.
Example: sdmx-dl list dimensions ECB EXR
Parameters:
Main options:
-s, --sources<file>- File that provides data source definitions.-l, --languages<langs>- Language priority list.--sort- Sort output.
Output format:
[
Name:string,
Label:string,
Coded:bool,
Index:int
]
List data flow attributes.
Example: sdmx-dl list attributes ECB EXR
Parameters:
Main options:
-s, --sources<file>- File that provides data source definitions.-l, --languages<langs>- Language priority list.--sort- Sort output.
Output format:
[
Name:string,
Label:string,
Coded:bool,
Relationship:enum
]
List codes from data flow concept.
Example: sdmx-dl list codes ECB EXR FREQ
Parameters:
Main options:
-s, --sources<file>- File that provides data source definitions.-l, --languages<langs>- Language priority list.--sort- Sort output.
Output format:
[
Code:string,
Label:string
]
List available dimension codes.
Example: sdmx-dl list availability ECB EXR M.CHF... 4
Parameters:
source- Data source name.flow- Data flow reference.key- Data key.index- Zero-based index of key dimension.
Main options:
-s, --sources<file>- File that provides data source definitions.-l, --languages<langs>- Language priority list.--sort- Sort output.
Output format:
[
Code:string
]
List supported features of a data source.
Example: sdmx-dl list features ECB
Parameters:
source- Data source name.
Main options:
-s, --sources<file>- File that provides data source definitions.-l, --languages<langs>- Language priority list.--sort- Sort output.
Output format:
[
SupportedFeature:enum
]
List driver names and properties.
Example: sdmx-dl list drivers
Main options:
-s, --sources<file>- File that provides data source definitions.
Other options:
CSV
Output format:
[
SupportedFeature:enum
]
Check service availability.
Example: sdmx-dl check status ECB
Parameters:
sources- Data source names.
Main options:
-s, --sources<file>- File that provides data source definitions.-l, --languages<langs>- Language priority list.--no-parallel- Disable parallel queries.--sort- Sort output.
Output format:
[
Source:source,
State:enum,
UptimeRatio:double,
AverageResponseTime:double,
ErrorMessage:string
]
Check service accessibility.
Example: sdmx-dl check access ECB
Parameters:
sources- Data source names.
Main options:
-s, --sources<file>- File that provides data source definitions.-l, --languages<langs>- Language priority list.--no-parallel- Disable parallel queries.--sort- Sort output.
Output format:
[
Source:source,
Accessible:enum,
DurationInMillis:int,
ErrorMessage:string
]
Check sdmx-dl configuration.
Example: sdmx-dl check config
Other options:
CSV
Output format:
[
Scope:enum,
PropertyKey:string,
PropertyValue:string,
Category:enum
]
