AvatarSDK 1.0.0

AvatarSDK

A .NET SDK for interacting with the avtr.icu avatar listing API. also known as Cute Avatar Search

Note: This README and the XML doc summaries in the source were generated with AI assistance. All SDK and test code was written by hand.

Installation

Add a reference to the AvatarSDK project

Usage

using AvatarSDK;

using var api = new API("MyApp/1.0 you@example.com");

// Search for avatars
List<AvatarDoc> results = await api.SearchAsync("cute fox", Platform.Windows);

// Fetch a specific avatar by ID
AvatarDoc? avatar = await api.GetAvatarAsync("avtr_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx");

// Get a random selection
List<AvatarDoc> random = await api.GetRandomAsync(Platform.Android);

// Get the latest listings
List<AvatarDoc> latest = await api.GetLatestAsync();

// Get all avatars by an author
List<AvatarDoc> byAuthor = await api.GetMoreByAuthorAsync("usr_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx");

Search options

SearchOptions lets you toggle content filters and sort order:

var opts = new SearchOptions
{
    Marketplace = true,
    SortMode    = SortMode.Newest,
};

var results = await api.SearchAsync("avatar", Platform.Windows, opts);

Uploading avatars

// Upload by ID
await api.UploadAvatarAsync("avtr_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx");

// Upload with full metadata
await api.UploadAvatarAsync(new AvatarDoc { Id = "avtr_...", Name = "My Avatar" });

// Bulk upload
await api.UploadBulkAsync(listOfAvatarDocs);

// Request a metadata refresh
await api.RequestAvatarUpdateAsync("avtr_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx");

API Reference

Error handling

All methods throw AvatarApiException on non-success responses:

try
{
    var avatar = await api.GetAvatarAsync("avtr_...");
}
catch (AvatarApiException ex)
{
    Console.WriteLine($"API error {ex.StatusCode}: {ex.Message}");
}

Running the tests

The test suite hits the live API to verify end-to-end behaviour:

dotnet test AvatarSDK-Tests/AvatarSDK-Tests.csproj

Legal Disclaimer

This SDK and the avtr.icu (Cute Avatar Search) service is a independent project and is not official.

• Non-Affiliation: This software and the associated API are not affiliated with, authorized, maintained, sponsored, or endorsed by VRChat Inc.
• Trademarks: "VRChat" is a registered trademark of VRChat Inc. The use of this name is strictly for identification and descriptive purposes and does not imply any association with or endorsement by the trademark holder.
• Compliance: Users of this SDK are responsible for ensuring their applications comply with the VRChat Terms of Service and Community Guidelines.