1. Configure Your API Base URL
Enter the URL where your compressed_hadith_sqlite folder is hosted (e.g., from GitHub Pages).
2. Available Endpoints
Get All Books Metadata
Returns a global list of all available languages and their corresponding books.
Loading...
Get Language Metadata
Returns all books and checksums for a specific language (e.g., ara, eng, ben).
Loading...
Download SQLite ZIP
Download the compressed SQLite database for a specific edition.
Loading...
3. Integration Guide
Follow these steps to integrate the API into your app:
- Fetch
all_info.jsonto get the list of supported languages. - Fetch the language-specific
info.jsonto get book names and SHA256 checksums. - Compare local checksums with the API to see if an update is required.
- Download the
.sqlite.zipfile and decompress it on the device. - Open the
.sqlitefile and use FTS5 for fast searching.