Bangladesh Education Board Results API

Rust API for Bangladesh Education Board result lookups, deployed as a Vercel serverless function.

Overview

• Runtime: Rust + Axum
• Deployment target: Vercel
• API style: JSON over HTTP (GET and POST)
• Hosted endpoint pattern: https://<your-project>.vercel.app/fetch

API Contract

Endpoint

• POST /fetch
• GET /fetch (query parameters)

Required Parameters

reg in the response is always populated. If the board result page exposes a registration number, that parsed value is returned. Otherwise the submitted request value is echoed back in reg.

Example Request (Production)

curl -sS -X POST "https://eduboardapi.vercel.app/fetch" \
  -H "Content-Type: application/json" \
  -d '{
    "exam": "ssc",
    "year": "2024",
    "board": "dinajpur",
    "roll": "277795",
    "reg": "2117829469"
  }'

Example Response

{
  "roll": "277795",
  "reg": "2117829469",
  "name": "Student Name",
  "father_name": "Father Name",
  "mother_name": "Mother Name",
  "board": "Dinajpur",
  "group": "Science",
  "exam_type": "SSC",
  "dob": "01-Jan-2008",
  "institute": "Institute Name",
  "result": "Passed",
  "gpa": "5.00",
  "grades": [
    { "code": "101", "subject": "Bangla", "grade": "A+" }
  ]
}

Deploy to Vercel

One-Click

Use the button at the top of this README.

CLI

vercel
vercel --prod

Vercel Runtime Layout

• api/axum.rs: Vercel function entrypoint for the Axum router
• vercel.json: Rewrite /fetch to /api/axum while serving landing page files at /
• index.html, styles.css, script.js: Static landing page and quick API playground
• src/lib.rs: Shared application builder (build_app) used by the Vercel function and Rust consumers

Use From Rust

1. Call Result Service Directly

[dependencies]
eduboardapi = { package = "EduBoardAPI", git = "https://github.com/Junaid433/eduboardapi" }
tokio = { version = "1", features = ["macros", "rt-multi-thread"] }

use eduboardapi::config::AppConfig;
use eduboardapi::models::RequestData;
use eduboardapi::services::{fetch_result, HttpClient};

#[tokio::main]
async fn main() {
    let client = HttpClient::new(AppConfig::default());
    let req = RequestData {
        exam: "ssc".to_string(),
        year: "2024".to_string(),
        board: "dinajpur".to_string(),
        roll: "277794".to_string(),
        reg: "2117829468".to_string(),
    };

    let result = fetch_result(&client, &req).await.unwrap();
    println!("{:#?}", result);
}

2. Reuse Router in a Rust Service

let app = eduboardapi::build_app();

License

MIT