# Boslive Icai — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Access the ICAI Board of Studies Knowledge Portal, including announcements, examination updates, Live Virtual Class (LVC) and Live Virtual Revisionary Class (LVRC) schedules, and study materials. Browse available courses, languages, and papers, and retrieve direct PDF links for any portal page.

**Category:** Education | **Website:** [boslive.icai.org/](https://boslive.icai.org/) | **Docs:** [parse.bot/marketplace/fb3000ee-bb99-4ce9-a68c-135d71c3aeaa/boslive-icai-org-api](https://parse.bot/marketplace/fb3000ee-bb99-4ce9-a68c-135d71c3aeaa/boslive-icai-org-api)

Pay-per-use API proxy. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-boslive-icai-org-api-fb3000ee/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_all_pdfs

Extracts all PDF links (both hyperlinked and embedded via iframe) from a specific page on the ICAI knowledge portal. Useful for extracting downloadable PDF documents from announcement detail pages or any portal page.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page_url` | string | Yes | Relative URL path of the page to extract PDFs from (e.g. announcement_details.php?id=589). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-boslive-icai-org-api-fb3000ee/get_all_pdfs \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"page_url":"<string>"}'
```

### get_announcement_details

Fetches details of a specific announcement by its ID, including the title, publication date, and embedded PDF URL if present. Most announcements consist of a title and a single embedded PDF document link.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `ann_id` | string | Yes | Announcement ID obtained from get_bos_announcements or get_examination_announcements results. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-boslive-icai-org-api-fb3000ee/get_announcement_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ann_id":"<string>"}'
```

### get_bos_announcements

Retrieves all Board of Studies announcements from the ICAI knowledge portal. Each announcement includes a title, publication date, direct URL, and an ID usable for fetching details. Results are ordered newest-first. No pagination — the portal returns the full list in one response.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-boslive-icai-org-api-fb3000ee/get_bos_announcements \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_examination_announcements

Retrieves all examination-related announcements from the ICAI knowledge portal. Each announcement includes a title, publication date, direct URL, and an ID. Results are ordered newest-first. No pagination.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-boslive-icai-org-api-fb3000ee/get_examination_announcements \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_lvc_schedule

Retrieves the Live Virtual Classes (LVC) schedule for a specific course level. Returns a table of upcoming classes with dates, paper names, topics, faculty, session times, and any associated links. Schedule availability depends on whether classes are currently announced for that course.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `course` | string | No | Course level code. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-boslive-icai-org-api-fb3000ee/get_lvc_schedule \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"course":"<string>"}'
```

### get_lvrc_schedule

Retrieves the Live Virtual Revisionary Classes (LVRC) schedule for a specific course level. Returns a table of scheduled revisionary classes with dates, paper names, topics, faculty, session times, and any associated links. Schedule availability depends on whether LVRC sessions are currently announced for that course.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `course` | string | No | Course level code. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-boslive-icai-org-api-fb3000ee/get_lvrc_schedule \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"course":"<string>"}'
```

### get_study_material_courses

Lists all available study material course categories from the ICAI knowledge portal. Each course includes a title, course code (used as input for get_study_material_languages), and a URL. The list includes Foundation, Intermediate, Final, and Self-Paced Online Modules.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-boslive-icai-org-api-fb3000ee/get_study_material_courses \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_study_material_languages

Lists available language options for a specific study material course. Currently English and Hindi mediums are offered for most courses. The language value from the result is used as input for get_study_material_papers.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `course_code` | string | Yes | Course code obtained from get_study_material_courses (e.g. foundation, intermediate, final, self-paced). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-boslive-icai-org-api-fb3000ee/get_study_material_languages \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"course_code":"<string>"}'
```

### get_study_material_papers

Lists available papers (grouped by exam applicability year) for a specific course and language combination. Each paper entry includes the title/year label, course code, language, year, and a URL for further navigation.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `course_code` | string | Yes | Course code obtained from get_study_material_courses (e.g. foundation, intermediate, final). |
| `language` | string | Yes | Language obtained from get_study_material_languages (English or Hindi). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-boslive-icai-org-api-fb3000ee/get_study_material_papers \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"course_code":"<string>","language":"<string>"}'
```