QuranJS

Search API

Search Quran content with language support and pagination.

The Search API enables searching through Quranic content with multi-language support.

const results = await client.search.search("light");

console.log(`Found ${results.totalResults} results`);

results.results.forEach((result) => {
  console.log(`${result.verseKey}: ${result.highlightedText}`);
});

SearchResult Type

Prop

Type

With Language

import { Language } from "@quranjs/api";

const results = await client.search.search("نور", {
  language: Language.ARABIC,
  size: 10,
  page: 1,
});

Options

Pagination

const results = await client.search.search("mercy", {
  size: 10,    // Results per page (default: 30)
  page: 1,     // Page number
  language: Language.ENGLISH,
});

console.log(`Page ${results.currentPage} of ${results.totalPages}`);

Language-Specific

const english = await client.search.search("mercy", {
  language: Language.ENGLISH,
});

const arabic = await client.search.search("رحمة", {
  language: Language.ARABIC,
});

const urdu = await client.search.search("رحمت", {
  language: Language.URDU,
});

Last updated on