Skip to content

hi-reeve/bible-api

Repository files navigation

Bible API

A simple Bible API based on Bible API build using NestJs and host using render

Installation

Clone this repo and install this project with pnpm

  cd my-project
  pnpm i

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

BASE_URL : https://api.scripture.api.bible/v1

API_KEY : YOUR_API_KEY

REDIS_URL : YOUR_REDIS_URL

REDIS_CACHE_TTL : 3600

Demo

Demo

API Reference

Get all available bible version

  GET /bible
Query Type Description
name string Required. Bible name search

Get bible detail

  GET /bible/${bibleId}
Parameter Type Description
bibleId string Required. Id of bible version

Get all books on selected bible

  GET /bible/${bibleId}/books
Parameter Type Description
bibleId string Required. Id of bible version

Get books detail

  GET /bible/${bibleId}/books/${booksId}
Parameter Type Description
bibleId string Required. Id of bible version
booksId string Required. Id of selected books

Get all chapters on books

  GET /bible/${bibleId}/books/${booksId}/chapters
Parameter Type Description
bibleId string Required. Id of bible version
booksId string Required. Id of selected books

Get chapter detail

  GET /bible/${bibleId}/chapters/${chapterId}
Parameter Type Description
bibleId string Required. Id of bible version
chapterId string Required. Id of selected chapter

Get verses list on chapters

  GET /bible/${bibleId}/chapters/${chapterId}/verses
Parameter Type Description
bibleId string Required. Id of bible version
chapterId string Required. Id of selected chapter

Search on entire bible

  GET /bible/${bibleId}/search
Query Type Description
query string Required. query string of the search content

Contributing

Contributions are always welcome!

About

a simple bible api using nestjs

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published