Using /search Endpoint

In this tutorial, we will be using the /search endpoint to get a circular's download URL and Title. The /search endpoint returns a list containing similar circulars, taking keywords of the actual title of the circular.

This endpoint returns a list (or None if not found) containing the download URL and title of the circular.
It basically uses a search algorithm to find the circular based on the keywords.

Example: Input being mobile, it finds the circular Mobile Phone Usage Policy and returns the circular object.

Request Structure

Send a GET request to the following URL: https://bpsapi.rajtech.me/search/{query}?amount={amount}
or, send a GET request to: https://bpsapi.rajtech.me/search?query={query}&amount={amount}

{query} here is what you want to search for {amount} is the number of results you want to receive

Parameters:

• amount: integer. The amount of circulars to return. Defaults to 3 [Optional]

Example Requests

Python

Here is an example request using Python's requests library:

import requests

url = "https://bpsapi.rajtech.me/v1/search"
params = {'query': 'mobile', 'amount': 2}

request = requests.get(url, params=params)
print(request.text)

cURL

Here is an example request using cURL:

curl -X 'GET' \
  'https://bpsapi.rajtech.me/v1/search?query=mobile&amount=2' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json'

Node.js

Here is an example request using Node.js's node-fetch library:

import fetch from 'node-fetch';
const url = 'https://bpsapi.rajtech.me/v1/search';
const params = {query: 'mobile', amount: 2};

fetch(
    `${url}?${new URLSearchParams(params)}`,
    {
        method: 'GET',
        headers: {
            'Content-Type': 'application/json',
        },
    })

    .then( (res) => res.json())
    .then( (res) => console.log(res));

Example Response

{
  "status": "success",
  "http_status": 200,
  "data": [
    {
      "title": "Grade X - Syllabus for Half Yearly Exam",
      "link": "https://bpsdoha.com/circular/category/45-exam-time-table-syllabus-2023-24?download=1355",
      "id": "1355"
    },
    {
      "title": "Grade X & XII - Timetable for Half Yearly Exam",
      "link": "https://bpsdoha.com/circular/category/45-exam-time-table-syllabus-2023-24?download=1351",
      "id": "1351"
    }
  ]
}

---

Thanks for reading!