{"openapi":"3.1.0","info":{"title":"RegisterLens API","version":"1.0.0","description":"Unofficial copy of the Central Bank of Ireland public registers. Not affiliated with or endorsed by the Central Bank of Ireland; always confirm on registers.centralbank.ie. Every call needs a key (X-API-Key) with prepaid search credit or Pro; there is no free tier (looking firms up on the website is free). Search credits: EUR 0.05 a call, bought upfront at /account, no daily or per-minute limit; a key with none left gets 402. Pro: 10,000 requests a day included, the change feed, CSV exports, new entrants and exits, and history (as_of and firm timelines, recorded from the first load onwards)."},"servers":[{"url":"https://search.registerlens.ie"}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","in":"header","name":"X-API-Key"}},"responses":{"Error":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}},"paths":{"/api/health":{"get":{"summary":"Service and data freshness","security":[{}],"responses":{"200":{"description":"OK"},"503":{"description":"Database unreachable"}}}},"/api/search":{"get":{"summary":"Search firms by name, trading name, CBI reference or register number","security":[{"ApiKey":[]}],"parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string"},"description":"1 to 200 characters"},{"name":"register","in":"query","required":false,"schema":{"type":"string"},"description":"Limit to one register (slug)"},{"name":"historic","in":"query","required":false,"schema":{"type":"boolean"},"description":"Include entities no longer on any list"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer"},"description":"Up to 100"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer"},"description":"Up to 10,000"}],"responses":{"200":{"description":"Matches, best first","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/api/firms/{id}":{"get":{"summary":"One firm: registrations, other names, change history; for passported firms, home-country LEI, registration number and regulators; for any firm with an LEI, its parent companies and the other regulated firms in its group","security":[{"ApiKey":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"RegisterLens firm id"},{"name":"as_of","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"Pro: the state at the end of that day (Irish time). Not before history starts (the first load) or in the future."}],"responses":{"200":{"description":"The firm","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/api/firms/by-reference/{ref}":{"get":{"summary":"One firm by CBI reference","security":[{"ApiKey":[]}],"parameters":[{"name":"ref","in":"path","required":true,"schema":{"type":"string"},"description":"e.g. C42802"},{"name":"as_of","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"Pro: the state at the end of that day (Irish time). Not before history starts (the first load) or in the future."}],"responses":{"200":{"description":"The firm","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/api/firms/{id}/history":{"get":{"summary":"Pro: one dated timeline of register changes, CRO changes and printed dates, newest first","security":[{"ApiKey":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"RegisterLens firm id"}],"responses":{"200":{"description":"The timeline","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/api/firms/by-reference/{ref}/history":{"get":{"summary":"Pro: the timeline, by CBI reference","security":[{"ApiKey":[]}],"parameters":[{"name":"ref","in":"path","required":true,"schema":{"type":"string"},"description":"e.g. C42802"}],"responses":{"200":{"description":"The timeline","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/api/registers":{"get":{"summary":"Every register with entry counts and dates","security":[{"ApiKey":[]}],"responses":{"200":{"description":"Registers","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/api/registers/{slug}":{"get":{"summary":"One register","security":[{"ApiKey":[]}],"parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string"},"description":"Register slug"}],"responses":{"200":{"description":"The register","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/api/registers/{slug}/firms":{"get":{"summary":"Entries on one register","security":[{"ApiKey":[]}],"parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string"},"description":"Register slug"},{"name":"sort","in":"query","required":false,"schema":{"enum":["name","ref","date"]},"description":"Default name"},{"name":"include_removed","in":"query","required":false,"schema":{"type":"boolean"},"description":"Include entries no longer listed"},{"name":"as_of","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"Pro: the state at the end of that day (Irish time). Not before history starts (the first load) or in the future."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer"},"description":"Up to 1000"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer"},"description":"Up to 100,000"}],"responses":{"200":{"description":"A page of entries","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/api/changes":{"get":{"summary":"Additions, removals, reinstatements and renames, newest first","security":[{"ApiKey":[]}],"parameters":[{"name":"since","in":"query","required":false,"schema":{"type":"string"},"description":"ISO date or date-time"},{"name":"until","in":"query","required":false,"schema":{"type":"string"},"description":"ISO date (includes that day) or date-time"},{"name":"type","in":"query","required":false,"schema":{"enum":["added","removed","reinstated","renamed"]}},{"name":"register","in":"query","required":false,"schema":{"type":"string"},"description":"Register slug"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer"},"description":"Up to 1000"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"A page of changes","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/api/moves":{"get":{"summary":"New entrants and exits, newest first: authorisations, first listings, removals, companies dissolved or in liquidation (Pro)","security":[{"ApiKey":[]}],"parameters":[{"name":"since","in":"query","required":false,"schema":{"type":"string"},"description":"YYYY-MM-DD (default: 90 days ago)"},{"name":"until","in":"query","required":false,"schema":{"type":"string"},"description":"YYYY-MM-DD"},{"name":"direction","in":"query","required":false,"schema":{"enum":["entrant","exit"]}},{"name":"kind","in":"query","required":false,"schema":{"enum":["authorised","passported_in","listed","reinstated","removed","company_status"]}},{"name":"register","in":"query","required":false,"schema":{"type":"string"},"description":"Register slug"},{"name":"category","in":"query","required":false,"schema":{"type":"string"},"description":"Register group slug"},{"name":"format","in":"query","required":false,"schema":{"enum":["json","csv"]},"description":"csv streams every row"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer"},"description":"Up to 1000 (json)"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"A page of moves","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"402":{"$ref":"#/components/responses/Error"},"403":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/api/export/{file}":{"get":{"summary":"A whole register as CSV ({slug}.csv), or every register (all.csv)","security":[{"ApiKey":[]}],"parameters":[{"name":"file","in":"path","required":true,"schema":{"type":"string"},"description":"e.g. all.csv"},{"name":"include_removed","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"as_of","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"Pro: the state at the end of that day (Irish time). Not before history starts (the first load) or in the future."}],"responses":{"200":{"description":"CSV","content":{"text/csv":{}}},"401":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}}}}}}