@retroachievements/api/dist/user/getUserProfile.d.ts

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

import type { AuthObject } from "../utils/public";
import type { UserProfile } from "./models";
/**
 * A call to this function will retrieve summary information about
 * a given user, targeted by username.
 *
 * @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 summary for.
 *
 * @example
 * ```
 * const userSummary = await getUserProfile(
 *   authorization,
 *   { username: "xelnia" }
 * );
 * ```
 *
 * @returns An object containing profile summary metadata about a target user.
 */
export declare const getUserProfile: (authorization: AuthObject, payload: {
    username: string;
}) => Promise<UserProfile>;