{"ok":true,"site":"finna","host":"finna.fi","about":"Finna.fi is the Finnish national search service for libraries, archives and museums. This CLI searches and reads records and authority data through the public read-only Finna REST API (api.finna.fi) and gets citations, exports and holdings from www.finna.fi.","commands":[{"command":"search-records","summary":"Keyword search over Finna's index of books, images, archive material and museum objects, with filters, sorting and paging (public Finna API)","params":[{"name":"lookfor","type":"string","required":true,"description":"Search terms"},{"name":"type","type":"string","description":"Which field to search","oneOf":["AllFields","Title","Author","Subject"],"default":"AllFields"},{"name":"filter","type":"string","description":"Facet filter as field:\"value\", e.g. format:\"0/Book/\", format:\"0/Image/\", online_boolean:\"1\", building:\"0/Helmet/\". Facet values come from get-facets or list-organisations."},{"name":"sort","type":"string","description":"Sort order, e.g. 'relevance,id asc', 'main_date_str desc' (newest first), 'main_date_str asc', 'title,id asc', 'author,id asc', 'first_indexed desc'"},{"name":"page","type":"number","description":"Page number, starting at 1","default":1},{"name":"api_limit","type":"number","description":"Results per page (0-100) (sent to the site as \"limit\"; clify's own --limit only shapes the output)","default":20},{"name":"lng","type":"string","description":"Language for translated values","oneOf":["fi","sv","en-gb"],"default":"fi"}],"exampleUrl":"https://clify-dev.netlify.app/finna/search-records?lookfor=sibelius&filter=format%3A%220%2FBook%2F%22&sort=main_date_str+desc"},{"command":"get-record","summary":"Get full metadata for one record by its Finna id (public Finna API), optionally choosing which fields to return","params":[{"name":"id","type":"string","required":true,"description":"Finna record id, e.g. helmet.1830976 or museovirasto.2588B7F548C8DB31DF7968B845EB1520"},{"name":"field","type":"string","description":"Return only this field. Examples: title, authors, subjects, summary, images, imageRights, urls, buildings, year, fullRecord. Leave empty for the default field set."},{"name":"lng","type":"string","description":"Language for translated values","oneOf":["fi","sv","en-gb"],"default":"fi"}],"exampleUrl":"https://clify-dev.netlify.app/finna/get-record?id=helmet.1830976&field=title"},{"command":"get-facets","summary":"List facet values with counts (formats, organisations, languages, years, ...) for a search or for the whole index; the values can be used as search-records filters","params":[{"name":"facet","type":"string","required":true,"description":"Facet field to count","oneOf":["format","building","language","main_date_str","author_facet","topic_facet","genre_facet","geographic_facet","era_facet","usage_rights_str_mv","sector_str_mv","online_boolean"]},{"name":"lookfor","type":"string","description":"Search terms to scope the counts (empty = whole index)"},{"name":"filter","type":"string","description":"Facet filter as field:\"value\", e.g. online_boolean:\"1\""},{"name":"lng","type":"string","description":"Language for translated values","oneOf":["fi","sv","en-gb"],"default":"fi"}],"exampleUrl":"https://clify-dev.netlify.app/finna/get-facets?facet=format&lookfor=sibelius"},{"command":"list-organisations","summary":"List the organisations (libraries, archives, museums) whose material is in Finna, with record counts, from the building facet","params":[{"name":"lookfor","type":"string","description":"Optional search terms; lists only the organisations that have matching records"},{"name":"lng","type":"string","description":"Language for organisation names","oneOf":["fi","sv","en-gb"],"default":"fi"}],"exampleUrl":"https://clify-dev.netlify.app/finna/list-organisations?lng=en-gb"},{"command":"search-authorities","summary":"Search authority records for people and organisations (public Finna API)","params":[{"name":"lookfor","type":"string","required":true,"description":"Name or search terms"},{"name":"type","type":"string","description":"Search field","default":"AllFields"},{"name":"filter","type":"string","description":"Facet filter as field:\"value\", e.g. to limit results to persons or to corporate bodies"},{"name":"page","type":"number","description":"Page number, starting at 1","default":1},{"name":"api_limit","type":"number","description":"Results per page (0-100) (sent to the site as \"limit\"; clify's own --limit only shapes the output)","default":20},{"name":"lng","type":"string","description":"Language","oneOf":["fi","sv","en-gb"],"default":"fi"}],"exampleUrl":"https://clify-dev.netlify.app/finna/search-authorities?lookfor=sibelius"},{"command":"get-authority","summary":"Get one authority record (person or organisation) by id, using an id from search-authorities (public Finna API)","params":[{"name":"id","type":"string","required":true,"description":"Authority record id exactly as returned by search-authorities, e.g. melinda.(FI-ASTERI-N)000030333 or ahaa-eac.EAC_2022113969"},{"name":"lng","type":"string","description":"Language","oneOf":["fi","sv","en-gb"],"default":"fi"}],"exampleUrl":"https://clify-dev.netlify.app/finna/get-authority?id=melinda.%28FI-ASTERI-N%29000030333"},{"command":"get-citation","summary":"Get ready-made citations (APA, Chicago, MLA, Harvard) for a record","params":[{"name":"id","type":"string","required":true,"description":"Finna record id"}],"exampleUrl":"https://clify-dev.netlify.app/finna/get-citation"},{"command":"export-record","summary":"Export a record as a citation-manager file (RIS, BibTeX, EndNote, RefWorks, MARC ...) and return the raw text","params":[{"name":"id","type":"string","required":true,"description":"Finna record id"},{"name":"style","type":"string","required":true,"description":"Export format, e.g. RIS, BibTeX, EndNote, MARC, MARCXML (RefWorks and EndNoteWeb redirect to external services)"}],"exampleUrl":"https://clify-dev.netlify.app/finna/export-record?style=RIS"}]}