Downloads

Machine-readable spec: OpenAPI JSON. AI agents: /llms.txt · /docs/llms.txt · /llms-full.txt. Loxone PicoC guides: /docs/loxone (Community login for detail pages).

The OpenAPI file is a machine-readable map of every endpoint, parameter, and response field. Use it with Postman, Insomnia, or code generators — no need to copy fields by hand from these wiki pages.

Everyday example

You use Postman. Import openapi.json, set environment variable API_KEY=sf_live_YOUR_KEY, and every request template already knows the paths and headers.

When to use / when not

Use when:

• Generating a typed client (Python, TypeScript, etc.)
• Importing into API testing tools
• CI contract tests

Do not use when:

• You are new to SpotpriceAPI — start with Getting Started instead
• You need integration advice (EMS patterns) — read the endpoint guides; OpenAPI is the contract only

What you need

• Browser or curl
• No API key required for the download itself

Step by step

1. Download OpenAPI JSON or fetch:

curl -o openapi.json https://spotpriceapi.com/docs/download/openapi.json

2. Postman: Import → file or URL. 3. Insomnia: Import from URL. 4. Code gen: openapi-generator-cli generate -i openapi.json -g python -o ./client 5. Store your real key in an environment variable — never commit it.

What is in the file

Common mistakes

• Hardcoding sf_live_YOUR_KEY in generated code that goes to git
• Expecting business guidance (fair use, Loxone wiring) inside OpenAPI — that lives in these docs
• Using an old cached copy — check Changelog after API updates

Next steps

• Getting Started — first live call
• Code Samples — portal snippets with your key
• Changelog — spec changes over time