@retroachievements/api/src/user/getUserPoints.ts

A well-tested library that lets you get achievement, user, and game data from RetroAchievements.

import {
  apiBaseUrl,
  buildRequestUrl,
  call,
  serializeProperties,
} from "../utils/internal";
import type { AuthObject } from "../utils/public";
import type { GetUserPointsResponse, UserPoints } from "./models";

/**
 * A call to this function will retrieve a given user's hardcore
 * and softcore points.
 *
 * @param authorization An object containing your username and webApiKey.
 * This can be constructed with `buildAuthorization()`.
 *
 * @param payload.username The user for which to retrieve the point totals for.
 *
 * @example
 * ```
 * const userPoints = await getUserPoints(
 *   authorization,
 *   { username: "xelnia" }
 * );
 * ```
 *
 * @returns An object containing metadata about a target user's points.
 * ```json
 * {
 *   points: 7640,
 *   softcorePoints: 25
 * }
 * ```
 */
export const getUserPoints = async (
  authorization: AuthObject,
  payload: { username: string }
): Promise<UserPoints> => {
  const { username } = payload;

  const url = buildRequestUrl(
    apiBaseUrl,
    "/API_GetUserPoints.php",
    authorization,
    { u: username }
  );

  const rawResponse = await call<GetUserPointsResponse>({ url });

  return serializeProperties(rawResponse);
};