{"ok":true,"site":"pxdata-stat","host":"pxdata.stat.fi","about":"Statistics Finland's PxWeb statistical databases (StatFin, Paavo postal-code data, etc.). The CLI uses the public PxWeb API v1 to browse databases, subject areas and tables, search tables, read table metadata and query table data.","commands":[{"command":"list-databases","summary":"List all databases on the server (StatFin, Postinumeroalueittainen_avoin_tieto, Hyvinvointialueet, ...)","params":[{"name":"lang","type":"string","description":"Language of texts","oneOf":["en","fi","sv"],"default":"en"}],"exampleUrl":"https://clify-dev.netlify.app/pxdata-stat/list-databases"},{"command":"list-subject-areas","summary":"List the top-level subject areas (folders) of a database, e.g. StatFin subject areas like vaerak (population structure)","params":[{"name":"lang","type":"string","description":"Language of texts","oneOf":["en","fi","sv"],"default":"en"},{"name":"database","type":"string","description":"Database id (dbid from list-databases)","default":"StatFin"}],"exampleUrl":"https://clify-dev.netlify.app/pxdata-stat/list-subject-areas"},{"command":"list-tables","summary":"List the tables (type 't') or sub-levels (type 'l') inside a subject area of a database","params":[{"name":"lang","type":"string","description":"Language of texts","oneOf":["en","fi","sv"],"default":"en"},{"name":"database","type":"string","description":"Database id","default":"StatFin"},{"name":"area","type":"string","required":true,"description":"Subject area id from list-subject-areas, e.g. vaerak, kuol, matk (for Paavo: uusin or arkisto)"}],"exampleUrl":"https://clify-dev.netlify.app/pxdata-stat/list-tables"},{"command":"search-tables","summary":"Search a database's tables by free text, title words or variable value codes; query=* with filter=* lists every table with publish dates","params":[{"name":"lang","type":"string","description":"Language of texts and of the search index","oneOf":["en","fi","sv"],"default":"en"},{"name":"database","type":"string","description":"Database id","default":"StatFin"},{"name":"query","type":"string","required":true,"description":"Search text, a value code (e.g. KU091 municipality code), or * for all tables"},{"name":"filter","type":"string","description":"Restrict where to match: title = table titles only, codes = variable value codes, * = everything (use with query=* to list all tables). Omit for default full-text search.","oneOf":["*","title","codes"]}],"exampleUrl":"https://clify-dev.netlify.app/pxdata-stat/search-tables?query=population&filter=title"},{"command":"get-table-metadata","summary":"Get a table's title and variables, with each variable's code, value codes and value texts (needed before querying data)","params":[{"name":"lang","type":"string","description":"Language of texts","oneOf":["en","fi","sv"],"default":"en"},{"name":"database","type":"string","description":"Database id","default":"StatFin"},{"name":"area","type":"string","required":true,"description":"Subject area id. This is the search result 'path' without the leading slash, e.g. vaerak"},{"name":"table","type":"string","required":true,"description":"Table id including the .px suffix, e.g. 11rc.px"}],"exampleUrl":"https://clify-dev.netlify.app/pxdata-stat/get-table-metadata"},{"command":"get-table-data","summary":"Query a table's data values, selecting on one variable (e.g. latest N years with filter=top on timeperiod_y); all other variables return all values","params":[{"name":"lang","type":"string","description":"Language of texts","oneOf":["en","fi","sv"],"default":"en"},{"name":"database","type":"string","description":"Database id","default":"StatFin"},{"name":"area","type":"string","required":true,"description":"Subject area id, e.g. vaerak"},{"name":"table","type":"string","required":true,"description":"Table id including .px, e.g. 11rb.px"},{"name":"code","type":"string","description":"Variable code to select on (from get-table-metadata variables[].code). StatFin tables use timeperiod_y for years.","default":"timeperiod_y"},{"name":"filter","type":"string","description":"Selection type: item = a specific value code, top = latest N values (value is N), all = every value (value *)","oneOf":["item","top","all"],"default":"all"},{"name":"value","type":"string","description":"Value code for filter=item (e.g. 2024, SSS), a count for filter=top (e.g. 5), or * for filter=all","default":"*"},{"name":"format","type":"string","description":"Response format. json gives columns plus data[{key:[codes], values:[...]}]; json-stat2 is the compact JSON-stat format","oneOf":["json","json-stat2","json-stat"],"default":"json"}],"exampleUrl":"https://clify-dev.netlify.app/pxdata-stat/get-table-data"},{"command":"get-api-limits","summary":"Get the API's usage limits: max cells/values per query, max calls per time window, CORS","params":[{"name":"lang","type":"string","description":"Language","oneOf":["en","fi","sv"],"default":"fi"}],"exampleUrl":"https://clify-dev.netlify.app/pxdata-stat/get-api-limits"}]}