{"ok":true,"site":"digi-kansalliskirjasto","host":"digi.kansalliskirjasto.fi","about":"Finnish National Library's Digi service (digitized newspapers, journals, books, maps, music and more). The CLI searches full text and metadata, reads issue (binding) details and page OCR text, browses serial titles by year, searches user-made clippings, lists collections, and harvests OAI-PMH metadata.","commands":[{"command":"search-materials","summary":"Full-text and metadata search over digitized materials. Returns matching pages (bindings) with OCR highlights.","params":[{"name":"query","type":"string","required":true,"description":"Search terms. Supports Digi query syntax (quotes, AND/OR, wildcards)."},{"name":"format","type":"string","description":"Material type to search. Sent as a single-element formats array. An empty value can cause a server error, so it defaults to NEWSPAPER.","oneOf":["NEWSPAPER","JOURNAL","PRINTING","BOOK","MANUSCRIPT","MAP","MUSIC_NOTATION","PICTURE","CARD_INDEX","ARK_KIRJE","ARK_KASIKIRJOITUS"],"default":"NEWSPAPER"},{"name":"orderBy","type":"string","description":"Sort order. DATE is oldest first and DATE_DESC is newest first.","oneOf":["RELEVANCE","DATE","DATE_DESC"],"default":"RELEVANCE"},{"name":"startDate","type":"string","description":"Earliest publication date, ISO format, e.g. 1900-01-01"},{"name":"endDate","type":"string","description":"Latest publication date, ISO format, e.g. 1939-12-31"},{"name":"fuzzy","type":"boolean","description":"Fuzzy matching, which tolerates OCR errors","default":false},{"name":"requireAllKeywords","type":"boolean","description":"true means all terms must match (AND); false means any term (OR)","default":true},{"name":"queryTargetsOcrText","type":"boolean","description":"Search the OCR full text","default":true},{"name":"queryTargetsMetadata","type":"boolean","description":"Also search metadata such as titles and authors","default":false},{"name":"offset","type":"number","description":"Result offset","default":0},{"name":"count","type":"number","description":"Results per page","default":20}],"exampleUrl":"https://clify-dev.netlify.app/digi-kansalliskirjasto/search-materials"},{"command":"search-articles","summary":"Search component parts (articles or sections within issues) by keyword. Returns article titles with their binding and page.","params":[{"name":"query","type":"string","required":true,"description":"Search terms"},{"name":"format","type":"string","description":"Material type to search. Sent as a single-element formats array. An empty value causes a server error, so it defaults to NEWSPAPER.","oneOf":["NEWSPAPER","JOURNAL","PRINTING","BOOK","MANUSCRIPT","MAP","MUSIC_NOTATION","PICTURE","CARD_INDEX","ARK_KIRJE","ARK_KASIKIRJOITUS"],"default":"NEWSPAPER"},{"name":"orderBy","type":"string","description":"Sort order","oneOf":["RELEVANCE","DATE","DATE_DESC"],"default":"RELEVANCE"},{"name":"startDate","type":"string","description":"Earliest publication date, ISO format, e.g. 1900-01-01"},{"name":"endDate","type":"string","description":"Latest publication date, ISO format, e.g. 1939-12-31"},{"name":"offset","type":"number","description":"Result offset","default":0},{"name":"count","type":"number","description":"Results per page","default":20}],"exampleUrl":"https://clify-dev.netlify.app/digi-kansalliskirjasto/search-articles"},{"command":"get-binding","summary":"Get details of one issue or volume (binding): title, date, ISSN, page list with image URLs, PDF link and citation info.","params":[{"name":"id","type":"number","required":true,"description":"Binding id (bindingId from search results)"}],"exampleUrl":"https://clify-dev.netlify.app/digi-kansalliskirjasto/get-binding?id=407492"},{"command":"get-page-ocr","summary":"Get the OCR text blocks of one page of a binding.","params":[{"name":"bindingId","type":"number","required":true,"description":"Binding id"},{"name":"page","type":"number","required":true,"description":"Page number, 1-based"},{"name":"oldOcr","type":"boolean","description":"Return the original OCR instead of the re-OCR version","default":false}],"exampleUrl":"https://clify-dev.netlify.app/digi-kansalliskirjasto/get-page-ocr?bindingId=407492&page=8"},{"command":"get-ocr-hits","summary":"Get the positions (bounding boxes) of a search term on one page of a binding.","params":[{"name":"bindingId","type":"number","required":true,"description":"Binding id"},{"name":"page","type":"number","required":true,"description":"Page number"},{"name":"term","type":"string","required":true,"description":"Term to locate, as in search result 'terms'"}],"exampleUrl":"https://clify-dev.netlify.app/digi-kansalliskirjasto/get-ocr-hits?page=34&term=Sibelius"},{"command":"list-page-component-parts","summary":"List the component parts (articles or sections) that appear on a given page of a binding.","params":[{"name":"bindingId","type":"number","required":true,"description":"Binding id"},{"name":"page","type":"number","required":true,"description":"Page number"}],"exampleUrl":"https://clify-dev.netlify.app/digi-kansalliskirjasto/list-page-component-parts?bindingId=2581142&page=1"},{"command":"get-title-info","summary":"Get descriptive metadata for a serial title by ISSN: publishing period, places, supplements, political orientation, predecessors and successors.","params":[{"name":"issn","type":"string","required":true,"description":"ISSN or local title id (publicationId), e.g. 1457-4314 or fk14195"}],"exampleUrl":"https://clify-dev.netlify.app/digi-kansalliskirjasto/get-title-info?issn=1457-4314"},{"command":"list-title-years","summary":"List the years for which a serial title (newspaper or journal) has digitized issues.","params":[{"name":"issn","type":"string","required":true,"description":"ISSN or local title id"}],"exampleUrl":"https://clify-dev.netlify.app/digi-kansalliskirjasto/list-title-years"},{"command":"list-title-issues","summary":"List all digitized issues of a serial title for one year, with binding ids and dates.","params":[{"name":"issn","type":"string","required":true,"description":"ISSN or local title id"},{"name":"year","type":"number","required":true,"description":"Publication year"}],"exampleUrl":"https://clify-dev.netlify.app/digi-kansalliskirjasto/list-title-issues"},{"command":"list-serial-publications","summary":"List all digitized newspaper and journal titles, with ISSN or id, years, languages, places and coverage. The response is large.","params":[],"exampleUrl":"https://clify-dev.netlify.app/digi-kansalliskirjasto/list-serial-publications"},{"command":"search-clippings","summary":"Search user-made clippings (cut-out articles with category, subject and keywords) by keyword and date.","params":[{"name":"query","type":"string","required":true,"description":"Search terms"},{"name":"orderBy","type":"string","description":"Sort order","oneOf":["RELEVANCE","CREATED_DESC"],"default":"RELEVANCE"},{"name":"startDate","type":"string","description":"Earliest publication date, ISO format"},{"name":"endDate","type":"string","description":"Latest publication date, ISO format"},{"name":"offset","type":"number","description":"Result offset","default":0},{"name":"count","type":"number","description":"Results per page","default":20}],"exampleUrl":"https://clify-dev.netlify.app/digi-kansalliskirjasto/search-clippings"},{"command":"get-clipping","summary":"Get one user clipping (article) by id: title, text, keywords and source binding.","params":[{"name":"articleId","type":"number","required":true,"description":"Clipping id (articleId from search-clippings)"}],"exampleUrl":"https://clify-dev.netlify.app/digi-kansalliskirjasto/get-clipping"},{"command":"list-clipping-categories","summary":"List clipping categories and subjects (ids and Finnish names) used to classify clippings.","params":[],"exampleUrl":"https://clify-dev.netlify.app/digi-kansalliskirjasto/list-clipping-categories"},{"command":"search-clipping-keywords","summary":"Look up keywords that users have assigned to clippings.","params":[{"name":"query","type":"string","description":"Keyword prefix or text to match"},{"name":"maxResults","type":"number","description":"Maximum number of values to return","default":26}],"exampleUrl":"https://clify-dev.netlify.app/digi-kansalliskirjasto/search-clipping-keywords"},{"command":"search-filter-values","summary":"Look up values for search filters: titles, collections, publishers, publishing places, tags or authors.","params":[{"name":"type","type":"string","required":true,"description":"Which filter dimension to look up","oneOf":["title","collection","publisher","publishing-place","tag","author"]},{"name":"query","type":"string","description":"Text to match"},{"name":"maxResults","type":"number","description":"Maximum number of values to return","default":26}],"exampleUrl":"https://clify-dev.netlify.app/digi-kansalliskirjasto/search-filter-values"},{"command":"get-public-access-cutoffs","summary":"Show, per material type, the date up to which material is freely viewable. Newer material is restricted for anonymous users.","params":[],"exampleUrl":"https://clify-dev.netlify.app/digi-kansalliskirjasto/get-public-access-cutoffs"},{"command":"list-collections","summary":"List the collection tree (collection ids and names, nested by category).","params":[],"exampleUrl":"https://clify-dev.netlify.app/digi-kansalliskirjasto/list-collections"},{"command":"get-collection","summary":"Get a collection's name, HTML description and material types.","params":[{"name":"id","type":"number","required":true,"description":"Collection id"}],"exampleUrl":"https://clify-dev.netlify.app/digi-kansalliskirjasto/get-collection"},{"command":"harvest-oai-records","summary":"Harvest Dublin Core metadata records for a collection through the public OAI-PMH interface (ListRecords).","params":[{"name":"set","type":"string","required":true,"description":"OAI set spec: col-{collectionId}, e.g. col-742"},{"name":"metadataPrefix","type":"string","description":"Metadata format","default":"qdc_finna"}],"exampleUrl":"https://clify-dev.netlify.app/digi-kansalliskirjasto/harvest-oai-records?set=col-742"}]}