{"ok":true,"site":"avoindata-prh","host":"avoindata.prh.fi","about":"PRH (Finnish Patent and Registration Office) open-data APIs: search and look up Finnish companies (YTJ), browse trade register notices, and fetch digital (XBRL) financial statements.","commands":[{"command":"search-companies","summary":"Search Finnish companies (YTJ) by name, location, company form, main business line and registration date range","params":[{"name":"name","type":"string","description":"Company name. Matches current, previous, parallel and auxiliary trade names."},{"name":"location","type":"string","description":"Town or city (post office) of the company address"},{"name":"businessId","type":"string","description":"Exact Finnish business ID (Y-tunnus), e.g. 0112038-9"},{"name":"companyForm","type":"string","description":"Company form, as an abbreviation or numeric code from list-code-descriptions code=YRMU, e.g. OY or 16 (osakeyhtiö), OYJ or 17, AOY or 2"},{"name":"mainBusinessLine","type":"string","description":"Main business line as a TOL 2008 industry code or prefix, e.g. 62 (computer programming)"},{"name":"registrationDateStart","type":"string","description":"Earliest company registration date, ISO date YYYY-MM-DD"},{"name":"registrationDateEnd","type":"string","description":"Latest company registration date, ISO date YYYY-MM-DD"},{"name":"page","type":"number","description":"Result page number (starts at 1)"}],"exampleUrl":"https://clify-dev.netlify.app/avoindata-prh/search-companies?name=Nokia&location=Helsinki&companyForm=OY&mainBusinessLine=62&registrationDateStart=2023-01-01&registrationDateEnd=2024-12-31&page=2"},{"command":"get-company","summary":"Get full YTJ basic details of one company by business ID (Y-tunnus)","params":[{"name":"businessId","type":"string","required":true,"description":"Finnish business ID (Y-tunnus), format 1234567-8"}],"exampleUrl":"https://clify-dev.netlify.app/avoindata-prh/get-company?businessId=0112038-9"},{"command":"get-company-notices","summary":"Get a company's trade register details and its list of registered notices by business ID","params":[{"name":"businessId","type":"string","required":true,"description":"Exact Finnish business ID (Y-tunnus), format 1234567-8"}],"exampleUrl":"https://clify-dev.netlify.app/avoindata-prh/get-company-notices"},{"command":"get-notice","summary":"Get one registered trade register notice by its record year and number (record number YYYY/NNNNNN)","params":[{"name":"year","type":"string","required":true,"description":"Record year, the part before the slash in recordNumber, e.g. 2026"},{"name":"number","type":"string","required":true,"description":"Record number, the part after the slash in recordNumber, e.g. 178844"}],"exampleUrl":"https://clify-dev.netlify.app/avoindata-prh/get-notice"},{"command":"search-notices","summary":"Search companies with registered trade register notices by entry code and notice registration date range","params":[{"name":"entryCode","type":"string","description":"Notice entry code, e.g. HAL (board/management change) or VAL (authorised signatories)"},{"name":"noticeRegistrationDateStart","type":"string","description":"Earliest notice registration date, ISO date YYYY-MM-DD"},{"name":"noticeRegistrationDateEnd","type":"string","description":"Latest notice registration date, ISO date YYYY-MM-DD"},{"name":"page","type":"number","description":"Result page number (starts at 1)"}],"exampleUrl":"https://clify-dev.netlify.app/avoindata-prh/search-notices?entryCode=HAL&noticeRegistrationDateStart=2026-10-01&noticeRegistrationDateEnd=2026-10-15&page=2"},{"command":"list-code-descriptions","summary":"Get a YTJ code list (e.g. company forms YRMU) as tab-separated text: abbreviation, code, description","params":[{"name":"code","type":"string","required":true,"description":"Code list identifier, e.g. YRMU (company forms)"},{"name":"lang","type":"string","description":"Description language","oneOf":["fi","sv","en"],"default":"fi"}],"exampleUrl":"https://clify-dev.netlify.app/avoindata-prh/list-code-descriptions?code=YRMU&lang=fi"},{"command":"list-financial-periods","summary":"List the fiscal periods for which a company has digital (XBRL) financial statement data","params":[{"name":"businessId","type":"string","required":true,"description":"Finnish business ID (Y-tunnus), format 1234567-8"}],"exampleUrl":"https://clify-dev.netlify.app/avoindata-prh/list-financial-periods?businessId=0100379-9"},{"command":"get-financial-statement","summary":"Get one company's digital financial statement (XBRL income statement and balance sheet facts) for a fiscal period end date","params":[{"name":"businessId","type":"string","required":true,"description":"Finnish business ID (Y-tunnus), format 1234567-8"},{"name":"financialDate","type":"string","required":true,"description":"Fiscal period end date, ISO date YYYY-MM-DD (see list-financial-periods)"}],"exampleUrl":"https://clify-dev.netlify.app/avoindata-prh/get-financial-statement?businessId=0100379-9&financialDate=2024-12-31"},{"command":"list-financials-by-period","summary":"List all companies that have digital financial statements for a given fiscal period end date","params":[{"name":"financialDate","type":"string","required":true,"description":"Fiscal period end date, ISO date YYYY-MM-DD"},{"name":"page","type":"number","description":"Result page number (100 results per page). Paging was not verified."}],"exampleUrl":"https://clify-dev.netlify.app/avoindata-prh/list-financials-by-period?financialDate=2024-12-31"},{"command":"list-financial-statements","summary":"List filed digital financial statements (businessId, period end, registration date), optionally by registration date range","params":[{"name":"registrationDateStart","type":"string","description":"Earliest statement registration date, ISO date YYYY-MM-DD. The API appeared to ignore this filter."},{"name":"registrationDateEnd","type":"string","description":"Latest statement registration date, ISO date YYYY-MM-DD. The API appeared to ignore this filter."},{"name":"page","type":"number","description":"Result page number (100 results per page). Paging was not verified."}],"exampleUrl":"https://clify-dev.netlify.app/avoindata-prh/list-financial-statements?registrationDateStart=2026-10-01&registrationDateEnd=2026-10-15"},{"command":"get-api-schema","summary":"Get the OpenAPI (YAML) specification of one PRH open-data API, including all parameters and code meanings","params":[{"name":"api","type":"string","required":true,"description":"Which API's spec to fetch","oneOf":["opendata-ytj-api","opendata-registerednotices-api","opendata-xbrl-api"]},{"name":"lang","type":"string","description":"Language of the descriptions","oneOf":["fi","en","sv"],"default":"fi"}],"exampleUrl":"https://clify-dev.netlify.app/avoindata-prh/get-api-schema?lang=fi"}]}