​

Quickstart

​

1. Sign up

1. Open the Firmium dashboard.
2. Create an account with your email address.
3. Confirm the address via the link we send.

​

2. Get an API key

1. Sign in to the dashboard.
2. Go to API / Schnittstelle.
3. Create an API key and store it securely. The full key is shown only once.

Note: Treat the key like a password. Do not commit it to source control.

​

3. First API request

​

Search companies

curl -X POST https://www.firmium.de/api/v1/companies/search/ \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Beispiel GmbH"}'

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Beispiel GmbH",
      "registration_number": "HRB 123456",
      "country": "DE",
      "status": "Active"
    }
  ]
}

curl https://www.firmium.de/api/v1/companies/550e8400-e29b-41d4-a716-446655440000/ \
  -H "Authorization: Token YOUR_API_KEY"

​

4. Error handling

• 403 Forbidden: Key missing, invalid, or revoked, or your plan does not include API access.
• 400 Bad Request: Invalid search parameters.

​

5. Best practices

• Never store API keys in source code or public repositories.
• Rotate keys regularly and delete unused ones.
• Respect the rate limits.
• See Authentication for header details.

​

Next steps

• Authentication
• Introduction
• MCP server