Function Reference

All methods live on the RMPClient class. They are async and return Promises (or async iterators). Always call close() when finished.

Schools #

searchSchools

Search schools by name. Returns a paginated list of matching schools.

Returns: SchoolSearchResult

const result = await client.searchSchools("Stanford");
for (const school of result.schools) {
  console.log(school.name, school.overall_quality);
}
if (result.has_next_page) {
  const page2 = await client.searchSchools("Stanford", { cursor: result.next_cursor });
}

getSchool

Fetch a single school by its legacy numeric ID. Includes category summary ratings when available.

Returns: School

Throws: ParsingError if the school is not found.

const school = await client.getSchool("1466");
console.log(school.name, school.reputation, school.safety);

getCompareSchools

Fetch two schools in parallel and return them as a pair.

Returns: CompareSchoolsResult

const cmp = await client.getCompareSchools("1466", "1491");
console.log(cmp.school_1.name, "vs", cmp.school_2.name);

getSchoolRatingsPage

Fetch one page of ratings for a school. All ratings are pre-fetched and cached on first call.

Returns: SchoolRatingsPage

const page = await client.getSchoolRatingsPage("1466", { page_size: 5 });
console.log(page.school.name, page.ratings.length);

iterSchoolRatings

Async iterator that yields every rating for a school. Handles pagination automatically.

Yields: SchoolRating

for await (const rating of client.iterSchoolRatings("1466")) {
  console.log(rating.date, rating.comment, rating.overall);
}

Professors #

searchProfessors

Search professors by name. Optionally restrict to a specific school.

Returns: ProfessorSearchResult

const result = await client.searchProfessors("Smith");
for (const prof of result.professors) {
  console.log(prof.name, prof.department, prof.overall_rating);
}

listProfessorsForSchool

List professors at a specific school.

Returns: ProfessorSearchResult

const result = await client.listProfessorsForSchool(1466, { page_size: 10 });
for (const prof of result.professors) {
  console.log(prof.name);
}

iterProfessorsForSchool

Async iterator that yields every professor at a school.

Yields: Professor

for await (const prof of client.iterProfessorsForSchool(1466)) {
  console.log(prof.name, prof.overall_rating);
}

getProfessor

Fetch a single professor by their legacy numeric ID.

Returns: Professor

Throws: ParsingError if the professor is not found.

const prof = await client.getProfessor("2823076");
console.log(prof.name, prof.department, prof.overall_rating);

getProfessorRatingsPage

Fetch one page of ratings for a professor. All ratings are pre-fetched and cached on first call.

Returns: ProfessorRatingsPage

const page = await client.getProfessorRatingsPage("2823076", { page_size: 5 });
console.log(page.professor.name, page.ratings.length);

iterProfessorRatings

Async iterator that yields every rating for a professor.

Yields: Rating

for await (const rating of client.iterProfessorRatings("2823076", {
  since: new Date("2024-01-01"),
})) {
  console.log(rating.date, rating.quality, rating.comment);
}

Low-level #

rawQuery

Send a raw JSON / GraphQL payload to the RMP endpoint.

Returns: The full parsed response body.

const data = await client.rawQuery({ query: "{ viewer { id } }" });
console.log(data);

close

Close the HTTP client (aborts in-flight requests) and clear all rating caches.

await client.close();