User Manual
Jump to section: Web Interface | Rest APIWeb Interface
The main entry point for web queries id the Catalogue page. It contains a filter and search form that
should be
pretty
self-explanatory. Some additional information:
- The form fields for authors, genres and endowments expect ID values, but all contain either autocomplete functionality or all available options are provided in select fields.
-
The
Authors,GenresandEndowmentspages contain full lists of all entries in the database. - IDs found there can be used for manual querying.
- As of now, there is no export functionality for JSON or CSV files (it's on the roadmap).
Rest API
If you prefer to go the direct route, you can also use the REST API directly to query the data. The documentation can be found in the main menu in OpenAPI format. Some quick facts:
- The API is served on
https://api.natlib.obnx.dev - The only supported method is
GET. - There is no authentication, everything is freely available.
- Please be nice and don't abuse this power – the whole project runs on a cheap Hetzner VPS.
- CORS-headers are set to
*.
Self-Hosting
If you are feeling particularly adventurous: the whole project as well as the database is open source and can be freely forked and copied.
Setup is intentionally a bit overengineered though. You can read up on the project quirks in the Repository README .