{"openapi":"3.1.0","info":{"title":"privatefinancials API","description":"**privatefinancials.eu** — structured private-company financials and statutory\nfilings across EU national company registries, in one REST API.\n\nNo API key required for the public read endpoints. All responses are JSON;\nerrors follow [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807)\n(`application/problem+json`). Filing documents are returned as short-lived\npresigned URLs.\n\n* Interactive reference: [`/docs`](/docs) (Swagger UI) · [`/redoc`](/redoc)\n* Machine-readable spec: [`/openapi.json`](/openapi.json)\n* Start here: `GET /v1/registries` lists every covered registry with live counts.\n","contact":{"name":"privatefinancials.eu","url":"https://privatefinancials.eu/"},"license":{"name":"Proprietary"},"version":"0.1.0"},"servers":[{"url":"https://api.privatefinancials.eu","description":"Production"}],"paths":{"/v1/health":{"get":{"tags":["meta"],"summary":"Health","operationId":"health_v1_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":{"type":"string"},"type":"object","title":"Response Health V1 Health Get"}}}}}}},"/v1/registries":{"get":{"tags":["meta"],"summary":"List Registries","operationId":"list_registries_v1_registries_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RegistryOut"},"type":"array","title":"Response List Registries V1 Registries Get"}}}}}}},"/v1/companies/{country}/{company_number}":{"get":{"tags":["companies"],"summary":"Get Company","operationId":"get_company_v1_companies__country___company_number__get","parameters":[{"name":"country","in":"path","required":true,"schema":{"type":"string","minLength":2,"maxLength":2,"title":"Country"}},{"name":"company_number","in":"path","required":true,"schema":{"type":"string","minLength":1,"title":"Company Number"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyDetailOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{country}/{company_number}/filings":{"get":{"tags":["filings"],"summary":"List Company Filings","operationId":"list_company_filings_v1_companies__country___company_number__filings_get","parameters":[{"name":"country","in":"path","required":true,"schema":{"type":"string","minLength":2,"maxLength":2,"title":"Country"}},{"name":"company_number","in":"path","required":true,"schema":{"type":"string","minLength":1,"title":"Company Number"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedOut_FilingOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/filings/{registry}/{source_filing_id}":{"get":{"tags":["filings"],"summary":"Get Filing","operationId":"get_filing_v1_filings__registry___source_filing_id__get","parameters":[{"name":"registry","in":"path","required":true,"schema":{"type":"string","minLength":1,"title":"Registry"}},{"name":"source_filing_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"title":"Source Filing Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"CompanyDetailOut":{"properties":{"country_code":{"type":"string","title":"Country Code","description":"ISO-3166-1 alpha-2, e.g. 'GB'"},"registry":{"type":"string","title":"Registry","description":"source_registry slug, e.g. 'uk_ch'"},"company_number":{"type":"string","title":"Company Number"},"name":{"type":"string","title":"Name"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"status_normalized":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status Normalized"},"company_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Type"},"incorporated_on":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Incorporated On"},"dissolved_on":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Dissolved On"},"registered_address":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Registered Address"},"observed_at":{"type":"string","format":"date-time","title":"Observed At","description":"ISO-8601 UTC; from updated_at"},"filings_count":{"type":"integer","title":"Filings Count","default":0},"latest_filed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Latest Filed At"},"external_ids":{"items":{"$ref":"#/components/schemas/ExternalId"},"type":"array","title":"External Ids"}},"type":"object","required":["country_code","registry","company_number","name","observed_at"],"title":"CompanyDetailOut"},"ExternalId":{"properties":{"type":{"type":"string","title":"Type"},"value":{"type":"string","title":"Value"}},"type":"object","required":["type","value"],"title":"ExternalId"},"FilingOut":{"properties":{"registry":{"type":"string","title":"Registry","description":"source_registry slug, e.g. 'uk_ch'"},"source_filing_id":{"type":"string","title":"Source Filing Id","description":"Registry-native id; may contain slashes/specials (e.g. CZ 'B-XXXX/Y')."},"country_code":{"type":"string","title":"Country Code"},"company_number":{"type":"string","title":"Company Number"},"filing_type":{"type":"string","title":"Filing Type"},"filed_at":{"type":"string","format":"date-time","title":"Filed At"},"period_end_on":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Period End On"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"document_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Url","description":"Presigned GET URL, 5-minute TTL. None if no document attached."},"document_content_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Content Type"},"pages":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Pages"},"observed_at":{"type":"string","format":"date-time","title":"Observed At"}},"type":"object","required":["registry","source_filing_id","country_code","company_number","filing_type","filed_at","observed_at"],"title":"FilingOut"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"PaginatedOut_FilingOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/FilingOut"},"type":"array","title":"Items"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"}},"type":"object","required":["items"],"title":"PaginatedOut[FilingOut]"},"RegistryOut":{"properties":{"country_code":{"type":"string","title":"Country Code"},"registry":{"type":"string","title":"Registry"},"companies_count":{"type":"integer","title":"Companies Count"},"filings_count":{"type":"integer","title":"Filings Count"},"last_observed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Observed At"}},"type":"object","required":["country_code","registry","companies_count","filings_count"],"title":"RegistryOut"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"tags":[{"name":"meta","description":"Service health + registry catalog."},{"name":"companies","description":"Company lookup by (country, number) + filing history."},{"name":"filings","description":"Single filing by (registry, source filing id)."}]}