A good developer experience starts with tools that fit your existing workflow. To make integration easier, we published an OpenAPI specification for the entire API. This single file describes all endpoints, request parameters, response schemas, and authentication methods.

What is included

The specification is hosted at firmafind.at/openapi.yaml. It covers every user endpoint:

• Company search for Austria and the Czech Republic, including full company profiles.
• Official document listings and PDF downloads.
• Edikte / insolvency listings.
• The public, rate-limited search route.

It configures the x-api-key header, rates, and credit costs so your API client handles auth correctly out of the box.

How to use the spec

Instead of copying URLs and headers manually, you can load the YAML file directly into your tools:

• API clients: Import the URL into Postman, Insomnia, or Bruno to get a preconfigured collection of endpoints.
• Code generation: Generate typed clients for TypeScript, Python, Go, or PHP using tools like openapi-generator or openapi-typescript-codegen.
• Testing: Paste the URL into Redoc or Swagger Editor to play with request formats.

Where to find it

You can access the file from the API documentation page. We update the spec alongside our API so it always matches current production behavior.

If you have feedback or suggestions for the schema, let us know at [email protected].