Retrieve a list of your favorite items, such as friends, avatars, or worlds. You can filter the list by type, tag, and control pagination.

listFavorites(options: {
  type?: 'friend' | 'avatar' | 'world';
  n?: number;
  offset?: number;
  tag?: string;
}): Promise<Favorite[]>

• options (object):

  • type (string, optional):
    Filter favorites by type. Options: 'friend', 'avatar', 'world'.

  • n (number, optional):
    Number of favorites to retrieve (1-100). Default is 10.

  • offset (number, optional):
    Offset from the first favorite. Must be 0 or greater.

  • tag (string, optional):
    Filter favorites by tag.

• Promise<Favorite[]>: A promise that resolves to an array of favorite objects.

// Example: List all favorite avatars
const favoriteAvatars = await vrchatApi.favoritesApi.listFavorites({
  type: 'avatar',
  n: 20,
});
console.log(favoriteAvatars);

Add a new item (friend, avatar, or world) to your favorites. Note that you cannot add users who are not your friends to your favorite friends list.

addFavorite(options: {
  type: 'friend' | 'avatar' | 'world';
  favoriteId: string;
  tags: string[];
}): Promise<Favorite>

• options (object):

  • type (string, required):
    Type of favorite to add. Options: 'friend', 'avatar', 'world'.

  • favoriteId (string, required):
    The ID of the item to add to favorites.

    • For friends: User ID (usr_...)
    • For avatars: Avatar ID (avtr_...)
    • For worlds: World ID (wrld_...)

  • tags (string array, required):
    Tags associated with the favorite. Tags correspond to favorite groups.

    • For friends: 'group_0', 'group_1', 'group_2', 'group_3'
    • For avatars: 'avatars1', 'avatars2', 'avatars3', 'avatars4'
    • For worlds: 'worlds1', 'worlds2', 'worlds3', 'worlds4'

• Promise<Favorite>: A promise that resolves to the added favorite object.

// Example: Add a friend to favorites
const newFavoriteFriend = await vrchatApi.favoritesApi.addFavorite({
  type: 'friend',
  favoriteId: 'usr_abcdef12-3456-7890-abcd-ef1234567890', // Friend's user ID
  tags: ['group_0'],
});
console.log(newFavoriteFriend);

// Example: Add an avatar to favorites
const newFavoriteAvatar = await vrchatApi.favoritesApi.addFavorite({
  type: 'avatar',
  favoriteId: 'avtr_12345678-1234-1234-1234-1234567890ab', // Avatar ID
  tags: ['avatars1'],
});
console.log(newFavoriteAvatar);

// Example: Add a world to favorites
const newFavoriteWorld = await vrchatApi.favoritesApi.addFavorite({
  type: 'world',
  favoriteId: 'wrld_12345678-1234-1234-1234-1234567890ab', // World ID
  tags: ['worlds1'],
});
console.log(newFavoriteWorld);

Retrieve detailed information about a specific favorite item by its favorite ID.

showFavorite(options: {
  favoriteId: string;
}): Promise<Favorite>

• options (object):

  • favoriteId (string, required):
    The ID of the favorite. This is not the same as the item ID; it is the unique identifier for the favorite entry.

• Promise<Favorite>: A promise that resolves to the favorite object.

// Example: Get information about a specific favorite
const favoriteInfo = await vrchatApi.favoritesApi.showFavorite({
  favoriteId: 'fav_abcdef12-3456-7890-abcd-ef1234567890',
});
console.log(favoriteInfo);

Remove an item from your favorites list using its favorite ID.

removeFavorite(options: {
  favoriteId: string;
}): Promise<RequestSuccess>

• options (object):

  • favoriteId (string, required):
    The ID of the favorite to remove.

• Promise<RequestSuccess>: A promise that resolves to a success object indicating the operation was successful.

// Example: Remove a favorite item
const response = await vrchatApi.favoritesApi.removeFavorite({
  favoriteId: 'fav_abcdef12-3456-7890-abcd-ef1234567890',
});
console.log(response); // { success: true }

Retrieve a list of your favorite groups, such as friend groups, avatar groups, and world groups.

listFavoriteGroups(options: {
  ownerId: string;
  n?: number;
  offset?: number;
}): Promise<FavoriteGroup[]>

• options (object):

  • ownerId (string, required):
    The user ID of the owner of the favorite groups. Typically, this will be your own user ID.

  • n (number, optional):
    Number of favorite groups to retrieve (1-100). Default is 10.

  • offset (number, optional):
    Offset from the first favorite group. Must be 0 or greater.

• Promise<FavoriteGroup[]>: A promise that resolves to an array of favorite group objects.

// Example: List your favorite groups
const favoriteGroups = await vrchatApi.favoritesApi.listFavoriteGroups({
  ownerId: 'usr_yourUserIdHere',
});
console.log(favoriteGroups);

Retrieve detailed information about a specific favorite group by its type and name.

showFavoriteGroup(options: {
  favoriteGroupType: 'friend' | 'avatar' | 'world';
  favoriteGroupName: string;
  userId: string;
}): Promise<FavoriteGroup>

• options (object):

  • favoriteGroupType (string, required):
    Type of the favorite group. Options: 'friend', 'avatar', 'world'.

  • favoriteGroupName (string, required):
    Name of the favorite group. For friends: 'group_0', 'group_1', etc. For avatars and worlds: group names like 'avatars1', 'worlds1', etc.

  • userId (string, required):
    The user ID of the owner of the favorite group.

• Promise<FavoriteGroup>: A promise that resolves to the favorite group object.

// Example: Get information about a specific favorite group
const favoriteGroup = await vrchatApi.favoritesApi.showFavoriteGroup({
  favoriteGroupType: 'friend',
  favoriteGroupName: 'group_0',
  userId: 'usr_yourUserIdHere',
});
console.log(favoriteGroup);

Update properties of a favorite group, such as its display name, visibility, and tags.

updateFavoriteGroup(options: {
  favoriteGroupType: 'friend' | 'avatar' | 'world';
  favoriteGroupName: string;
  userId: string;
  displayName?: string;
  visibility?: 'private' | 'public';
  tags?: string[];
}): Promise<FavoriteGroup>

• options (object):

  • favoriteGroupType, favoriteGroupName, userId (required):
    Same as in showFavoriteGroup.

  • displayName (string, optional):
    New display name for the favorite group.

  • visibility (string, optional):
    Visibility of the favorite group. Options: 'private', 'public'.

  • tags (string array, optional):
    Tags associated with the favorite group.

• Promise<FavoriteGroup>: A promise that resolves to the updated favorite group object.

// Example: Update a favorite group's display name
const updatedFavoriteGroup = await vrchatApi.favoritesApi.updateFavoriteGroup({
  favoriteGroupType: 'avatar',
  favoriteGroupName: 'avatars1',
  userId: 'usr_yourUserIdHere',
  displayName: 'My Favorite Avatars',
});
console.log(updatedFavoriteGroup);

Remove all items from a specific favorite group.

clearFavoriteGroup(options: {
  favoriteGroupType: 'friend' | 'avatar' | 'world';
  favoriteGroupName: string;
  userId: string;
}): Promise<RequestSuccess>

• options (object):

  • Same as in showFavoriteGroup

• Promise<RequestSuccess>: A promise that resolves to a success object indicating the operation was successful.

// Example: Clear all items from a favorite group
const response = await vrchatApi.favoritesApi.clearFavoriteGroup({
  favoriteGroupType: 'world',
  favoriteGroupName: 'worlds1',
  userId: 'usr_yourUserIdHere',
});
console.log(response); // { success: true }

Retrieve information about the maximum number of favorites and favorite groups you can have.

getFavoriteLimits(): Promise<FavoriteLimits>

• No parameters

• Promise<FavoriteLimits>: A promise that resolves to an object containing favorite limits.

  type FavoriteLimits = {
    defaultMaxFavoriteGroups: number;
    defaultMaxFavoritesPerGroup: number;
    maxFavoriteGroups: {
      avatar: number;
      friend: number;
      world: number;
    };
    maxFavoritesPerGroup: {
      avatar: number;
      friend: number;
      world: number;
    };
  };

// Example: Get favorite limits
const favoriteLimits = await vrchatApi.favoritesApi.getFavoriteLimits();
console.log(favoriteLimits);
/*
{
  defaultMaxFavoriteGroups: 4,
  defaultMaxFavoritesPerGroup: 32,
  maxFavoriteGroups: { avatar: 4, friend: 4, world: 4 },
  maxFavoritesPerGroup: { avatar: 32, friend: 32, world: 32 }
}
*/