API
The read-only JSON API of knxprod-index.
Online index
knxprod-index, the service at index.tinkerbus.org that lists manufacturer product data and serves checked copies.
knxprod-index is a small service that finds the .knxprod files (ETS product databases) that KNX manufacturers
publish on their own download pages, reads what is in them, and, for sources where that is allowed, keeps a checked
copy and serves it. The links on manufacturer pages break and move, so the service downloads the files, reads their
metadata (manufacturer, products with order numbers, application programs, oldest ETS version), stores each file under
its SHA-256, and offers search through a REST API.
It is independent of any KNX tool: the API is the only interface. Tinkerbus has an optional client for it in Catalog > Online.
Hosted instance: https://index.tinkerbus.org
| Page | What it covers |
|---|---|
| API | Endpoints, parameters, status codes, rate limits |
| How it works | The registry, crawl, fetch, check and serve jobs |
| Crawler and contact | Who the crawler is, how it behaves, and how to reach us (site operators start here) |
| Self-hosting | Build, configure and run your own instance |
Rights
Listing a file is not the same as serving a copy. A source is crawled only when someone has read the site’s terms of use and recorded that. A source is mirrored, and its copies served from the index, only when the licence of the files was read and recorded as allowing it. Without that, a source stays a list of links and the file endpoint answers 404. Entries can be removed on request. See Crawler and contact.
How it works
The five stages of knxprod-index: registry, crawl, fetch, check and serve.
Crawler and contact
About the knxprod-index crawler, for site operators and manufacturers: who we are, how it behaves, how to ask us to stop.
Self-hosting
Build, configure and run your own knxprod-index instance.