# Yz Chsi — 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.

> Search and explore graduate and doctoral programs across Chinese institutions on yz.chsi.com.cn. Browse institutions by name, province, or major; retrieve program details and school information; and access admission brochures to compare programs and enrollment requirements in one place.

**Category:** Education | **Website:** [yz.chsi.com.cn/](https://yz.chsi.com.cn/) | **Docs:** [parse.bot/marketplace/d98cda57-a2b5-4d29-a982-38e12b0d79de/yz-chsi-com-cn-api](https://parse.bot/marketplace/d98cda57-a2b5-4d29-a982-38e12b0d79de/yz-chsi-com-cn-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-yz-chsi-com-cn-api-d98cda57/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_brochure_detail

Retrieve the full text content of a specific admission brochure page. Returns both plain text and HTML representations of the brochure content.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Full URL of the brochure detail page obtained from get_brochure_list |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-yz-chsi-com-cn-api-d98cda57/get_brochure_detail \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"<string>"}'
```

### get_brochure_list

Get a list of admission brochures (招生简章) for a specific institution using its internal schId. Returns brochure titles, detail page URLs, and publication dates.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `sch_id` | string | Yes | Internal school ID obtained from search_institutions or get_school_info (e.g., '367878' for Peking University) |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-yz-chsi-com-cn-api-d98cda57/get_brochure_list \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sch_id":"<string>"}'
```

### get_school_info

Retrieve school information and its unique internal schId by searching with the institution code and name. Both parameters are required for accurate matching. Returns the school's internal ID, name, institution code, and profile URL.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `dwdm` | string | Yes | Standard institution code (e.g., '10001' for Peking University, '10246' for Fudan University) |
| `dwmc` | string | Yes | Institution name in Chinese (e.g., '北京大学', '复旦大学') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-yz-chsi-com-cn-api-d98cda57/get_school_info \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"dwdm":"<string>","dwmc":"<string>"}'
```

### search_doctoral_programs

Search for graduate or doctoral programs by major name keyword. Returns a paginated list of institutions offering matching programs with their codes, names, and provinces. Each result identifies the institution and whether it has a graduate school.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `xxfs` | string | No | Study mode |
| `zymc` | string | No | Major name keyword to search in Chinese (e.g., '生物', '药学', '计算机') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-yz-chsi-com-cn-api-d98cda57/search_doctoral_programs \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"xxfs":"<string>","zymc":"<string>"}'
```

### search_institutions

Search the general graduate admissions institution library by name or province. Returns a list of institutions with their internal schId and display name. Paginated via offset parameter in increments of 20.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `ssdm` | string | No | Province code filter (e.g., '11' for Beijing, '31' for Shanghai) |
| `start` | integer | No | Pagination offset (increments of 20) |
| `yxmc` | string | No | Institution name keyword to search in Chinese (e.g., '北京', '清华') |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-yz-chsi-com-cn-api-d98cda57/search_institutions \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ssdm":"<string>","start":"<integer>","yxmc":"<string>"}'
```
