{"openapi":"3.1.0","info":{"title":"LEI.report API","version":"1.0.0","description":"Free Legal Entity Identifier company details and company search API.","termsOfService":"https://lei.report/api/terms/","license":{"name":"GLEIF LEI data terms","url":"https://www.gleif.org/en/meta/lei-data-terms-of-use"}},"servers":[{"url":"https://lei.report"}],"tags":[{"name":"Companies"},{"name":"Mappings"},{"name":"Status"}],"paths":{"/api/v1/lei/{lei}":{"get":{"tags":["Companies"],"summary":"Get company details by LEI","operationId":"getCompanyByLei","security":[{"bearerAuth":[]},{}],"parameters":[{"name":"lei","in":"path","required":true,"description":"A 20-character Legal Entity Identifier.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful stable API envelope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}}}},"/api/v1/lei/{lei}/relationships":{"get":{"tags":["Companies"],"summary":"Get company ownership relationships","operationId":"getCompanyRelationships","security":[{"bearerAuth":[]},{}],"parameters":[{"name":"lei","in":"path","required":true,"description":"A 20-character Legal Entity Identifier.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful stable API envelope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}}}},"/api/v1/lei/{lei}/changes":{"get":{"tags":["Companies"],"summary":"Get company change history","operationId":"getCompanyChanges","security":[{"bearerAuth":[]},{}],"parameters":[{"name":"lei","in":"path","required":true,"description":"A 20-character Legal Entity Identifier.","schema":{"type":"string"}},{"name":"cursor","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}}],"responses":{"200":{"description":"Successful stable API envelope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}}}},"/api/v1/search":{"get":{"tags":["Companies"],"summary":"Search companies","operationId":"searchCompanies","security":[{"bearerAuth":[]},{}],"parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2}},{"name":"country","in":"query","schema":{"type":"string","minLength":2,"maxLength":2}},{"name":"status","in":"query","schema":{"type":"string"}},{"name":"cursor","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}}],"responses":{"200":{"description":"Successful stable API envelope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}}}},"/api/v1/bic/{bic}":{"get":{"tags":["Mappings"],"summary":"Find companies by BIC","operationId":"getBIC","security":[{"bearerAuth":[]},{}],"parameters":[{"name":"bic","in":"path","required":true,"description":"Business Identifier Code.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful stable API envelope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}}}},"/api/v1/isin/{isin}":{"get":{"tags":["Mappings"],"summary":"Find a company by ISIN","operationId":"getISIN","security":[{"bearerAuth":[]},{}],"parameters":[{"name":"isin","in":"path","required":true,"description":"International Securities Identification Number.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful stable API envelope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}}}},"/api/v1/mic/{mic}":{"get":{"tags":["Mappings"],"summary":"Resolve a MIC","operationId":"getMIC","security":[{"bearerAuth":[]},{}],"parameters":[{"name":"mic","in":"path","required":true,"description":"Market Identifier Code.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful stable API envelope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}}}},"/api/v1/gem/{gem}":{"get":{"tags":["Mappings"],"summary":"Resolve a GEM identifier","operationId":"getGEM","security":[{"bearerAuth":[]},{}],"parameters":[{"name":"gem","in":"path","required":true,"description":"Global Energy Monitor identifier.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful stable API envelope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}}}},"/api/v1/qcc/{qcc}":{"get":{"tags":["Mappings"],"summary":"Resolve a QCC identifier","operationId":"getQCC","security":[{"bearerAuth":[]},{}],"parameters":[{"name":"qcc","in":"path","required":true,"description":"QCC identifier.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful stable API envelope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"$ref":"#/components/responses/Problem"},"401":{"$ref":"#/components/responses/Problem"},"404":{"$ref":"#/components/responses/Problem"},"429":{"$ref":"#/components/responses/Problem"},"503":{"$ref":"#/components/responses/Problem"}}}},"/api/v1/status":{"get":{"tags":["Status"],"summary":"Get active dataset status","operationId":"getStatus","security":[],"responses":{"200":{"description":"Successful stable API envelope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"503":{"$ref":"#/components/responses/Problem"}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"lei_live"}},"schemas":{"Envelope":{"type":"object","required":["data","meta","links"],"properties":{"data":{},"meta":{"type":"object","required":["datasetVersion","sourcePublishedAt","schemaVersion","sourceUrl","licenseNotice"]},"links":{"type":"object"}}},"Problem":{"type":"object","required":["type","title","status","detail"],"properties":{"type":{"type":"string","format":"uri"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"}}}},"responses":{"Problem":{"description":"RFC problem response.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}}