{"id":24688460,"url":"https://github.com/octabytes/quran-api","last_synced_at":"2026-04-13T22:03:03.327Z","repository":{"id":108854014,"uuid":"337942139","full_name":"octabytes/quran-api","owner":"octabytes","description":"NodeJs Quran API","archived":false,"fork":false,"pushed_at":"2021-03-19T04:31:14.000Z","size":2314,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-27T23:46:36.808Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/octabytes.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2021-02-11T05:52:08.000Z","updated_at":"2021-03-19T04:30:36.000Z","dependencies_parsed_at":null,"dependency_job_id":"f5df5270-cf55-4d72-8398-e203f74a7d5e","html_url":"https://github.com/octabytes/quran-api","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/octabytes/quran-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octabytes%2Fquran-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octabytes%2Fquran-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octabytes%2Fquran-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octabytes%2Fquran-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/octabytes","download_url":"https://codeload.github.com/octabytes/quran-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octabytes%2Fquran-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31772642,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-13T20:17:16.280Z","status":"ssl_error","status_checked_at":"2026-04-13T20:17:08.216Z","response_time":93,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-26T17:17:18.792Z","updated_at":"2026-04-13T22:03:03.312Z","avatar_url":"https://github.com/octabytes.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# quran-api\n\nNodeJs Quran API\n\n# Run Local\n\nFirst of all you should have to install the Firebase CLI\n\n`npm install -g firebase-tools`\n\nClone repository\n\n`git clone https://github.com/octabytes/quran-api.git`\n\nInstall require packages\n\n`npm install`\n\nMove into firebase dir\n\n`cd quran-api/firebase` This is not upto date\n\n`cd ../hadith-api/firebase`\n\nRun local Firestore\n\n`firebase emulators:start --only firestore --import=./cache`\n\nYour emulators start running on [http://localhost:4000/firestore](http://localhost:4000/firestore)\n\nRun API\n\n`export FIRESTORE_EMULATOR_HOST=\"localhost:8080\"`\n\n`npm start` or watch `npm run watch`\n\nOpen in browser\n\n[http://localhost:5000/v1/welcome](http://localhost:5000/v1/welcome)\n\n# Documentation\n\n1. Get `Ayah` by `id`\n   Id made with **surah number** and **ayah number** for example `1-2` which means\n   first surah and second ayah.\n\n`http://localhost:5000/v1/ayah/:id`\n\n2. Get `Ayah` by Ayah number\n\n`http://localhost:5000/v1/ayah/number/:number`\n\n3. Get list of `Ayah` by surah number\n\n`http://localhost:5000/v1/surah/:number?`\n\n4. Get surah list\n\n`http://localhost:5000/v1/surah/list`\n\n### Paginate data\n\nUsing Cursor\n`http://localhost:5000/v1/ayah/surah/?cursor=query_cursor`\n\nUsing Offset\n`http://localhost:5000/v1/ayah/surah/1?offset=30`\n\n### Max result\n\nBy default max results are 30\n\n`http://localhost:5000/v1/ayah/surah/1?maxResult=5`\n\n### Direction\n\nDirection is used to get Ayahs from start or from end, for example get surah 2 first 5 ayahs\n\n`http://localhost:5000/v1/ayah/surah/1?direction=start`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctabytes%2Fquran-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foctabytes%2Fquran-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctabytes%2Fquran-api/lists"}