Custom Metadata Providers
This guide is for making and adding custom metadata providers. ABS provides a few common providers (such as Audible, Google, iTunes, audiobookcovers), but does not include all providers or providers that do not have a public API. Beginning in server version 2.8.0, users can add custom metadata providers. This allows users to build custom tools or programs to allow ABS to interface with other metadata providers.
Adding custom provider in ABS
A custom provider can be added to ABS through "Metadata Tools" in the server settings.
To add a custom provider you will need the address of the provider (a URL if a public community provider or the IP and port if you're running the custom provider yourself).
If an authorization token is needed you will also add that here.
Creating custom provider
The request and response format that ABS expects for the API is defined in this OpenAPI spec.
Community providers
These custom metadata providers have been made by the community and are not maintained as part of the core project. Please refer to the provider documentation for information about how to set up the provider and the authorization value.
Issues with these providers should be brought up to the provider author and not in the main ABS repositories.
If you have made a custom provider and want to share, you can open a PR for this file to add your information to the table.
| Provider | Repository | Notes |
|---|---|---|
| abs-tract | https://github.com/ahobsonsayers/abs-tract | Provides Goodreads and Kindle metadata |
| lubimyczytac-abs | https://github.com/lakafior/lubimyczytac-abs | Provides Lubimyczytac (biggest polish site about books) metadata |
| audioteka-abs | https://github.com/lakafior/audioteka-abs | Provides Audioteka (supports Polish and Czech language) metadata |
| abs-agg | https://github.com/vito0912/abs-agg | Provides metadata from: ARD Audiothek, Audioteka, Big Finish, BookBeat, Goodreads, Graphic Audio, Hardcover, LibriVox, Storytel |
| abs-storytel | https://github.com/Revisor01/abs-storytel-provider | Provides Storytel metadata |
| abs-opds | https://github.com/DeXP/abs-opds | OPDS books catalog (biggest russian: Flibusta, inxp-web) Note: does not provide syncing reading progress |
| Abs-Ximalaya | https://github.com/shanyan-wcx/Abs-Ximalaya | Provides Ximalaya (喜马拉雅) metadata |
Community hosted providers
These providers are hosted by community members so you can easily add them to your ABS server without running additional software. These are not hosted by the ABS team or authors of the providers, so issues should not be opened with the provider or ABS repositories.
If you host a custom provider and want to share, you can open a PR for this file to add your information to the table.
| Provider | Address | Auth | Contact | Notes |
|---|---|---|---|---|
| abs-agg | https://provider.vito0912.de/ardaudiothek https://provider.vito0912.de/audioteka/lang:pl https://provider.vito0912.de/bigfinish https://provider.vito0912.de/bookbeat/market:austria https://provider.vito0912.de/goodreads https://provider.vito0912.de/graphicaudio https://provider.vito0912.de/hardcover https://provider.vito0912.de/librivox https://provider.vito0912.de/storytel/language:en | abs | Vito0912 on GitHub | Each provider has different optional parameters. See full documentation |