v6 documentation is incomplete, want to contribute?

VRChat.community

API documentation, SDKs, and more
API Reference
Discord

Search Avatars

Search and list avatars by query filters. You can only search your own or featured avatars. It is not possible as a normal user to search other peoples avatars.

Requests made through this page are proxied through an intermediary server due to Cross-Origin Resource Sharing restrictions.

GET
/avatars

Authorization

auth<token>

Auth Token via Cookie

In: cookie

Query Parameters

featured?boolean

Filters on featured results.

sort?SortOption

The sort order of the results.

Default"popularity"
Value in"popularity" | "heat" | "trust" | "shuffle" | "random" | "favorites" | "reportScore" | "reportCount" | "publicationDate" | "labsPublicationDate" | "created" | "_created_at" | "updated" | "_updated_at" | "order" | "relevance" | "magic" | "name"
user?string

Set to me for searching own avatars.

Value in"me"
userId?string

Filter by UserID.

n?integer

The number of objects to return.

Default60
Range1 <= value <= 100
order?OrderOption

Result ordering

Default"descending"
Value in"ascending" | "descending"
offset?integer

A zero-based offset from the default object sorting from where search results start.

tag?string

Tags to include (comma-separated). Any of the tags needs to be present.

notag?string

Tags to exclude (comma-separated).

releaseStatus?ReleaseStatus

Filter by ReleaseStatus.

Default"public"
Value in"public" | "private" | "hidden" | "all"
maxUnityVersion?string

The maximum Unity version supported by the asset.

minUnityVersion?string

The minimum Unity version supported by the asset.

platform?string

The platform the asset supports.

Response Body

Returns a list of Avatar objects.

Error response due to missing auth cookie.

error?Response
curl -X GET "https://api.vrchat.cloud/api/1/avatars?featured=true&sort=popularity&user=me&userId=string&n=60&order=descending&offset=0&tag=string&notag=string&releaseStatus=public&maxUnityVersion=string&minUnityVersion=string&platform=string" \
  -H "auth: <token>"
fetch("https://api.vrchat.cloud/api/1/avatars?featured=true&sort=popularity&user=me&userId=string&n=60&order=descending&offset=0&tag=string&notag=string&releaseStatus=public&maxUnityVersion=string&minUnityVersion=string&platform=string", {
  headers: {
    "auth": "<token>"
  }
})
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "https://api.vrchat.cloud/api/1/avatars?featured=true&sort=popularity&user=me&userId=string&n=60&order=descending&offset=0&tag=string&notag=string&releaseStatus=public&maxUnityVersion=string&minUnityVersion=string&platform=string"

  req, _ := http.NewRequest("GET", url, nil)
  req.Header.Add("auth", "<token>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}
import requests

url = "https://api.vrchat.cloud/api/1/avatars?featured=true&sort=popularity&user=me&userId=string&n=60&order=descending&offset=0&tag=string&notag=string&releaseStatus=public&maxUnityVersion=string&minUnityVersion=string&platform=string"

response = requests.request("GET", url, headers = {
  "auth": "<token>"
})

print(response.text)
[
  {
    "acknowledgements": "string",
    "assetUrl": "string",
    "assetUrlObject": {},
    "authorId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
    "authorName": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "description": "string",
    "featured": false,
    "highestPrice": 0,
    "id": "avtr_912d66a4-4714-43b8-8407-7de2cafbf55b",
    "imageUrl": "string",
    "lock": true,
    "lowestPrice": 0,
    "name": "string",
    "productId": "string",
    "publishedListings": [
      {
        "description": "string",
        "displayName": "string",
        "imageId": "string",
        "listingId": "string",
        "listingType": "string",
        "priceTokens": 0
      }
    ],
    "releaseStatus": "public",
    "searchable": false,
    "styles": {
      "primary": "string",
      "secondary": "string",
      "supplementary": [
        "string"
      ]
    },
    "tags": [
      "string"
    ],
    "thumbnailImageUrl": "string",
    "unityPackageUrl": "string",
    "unityPackageUrlObject": {
      "unityPackageUrl": "string"
    },
    "unityPackages": [
      {
        "id": "unp_52b12c39-4163-457d-a4a9-630e7aff1bff",
        "assetUrl": "https://api.vrchat.cloud/api/1/file/file_cd0caa7b-69ba-4715-8dfe-7d667a9d2537/65/file",
        "assetUrlObject": {},
        "assetVersion": 4,
        "created_at": "2020-09-10T06:13:27.777Z",
        "impostorizerVersion": "0.17.0",
        "performanceRating": "Excellent",
        "platform": "standalonewindows",
        "pluginUrl": "",
        "pluginUrlObject": {},
        "unitySortNumber": 20180414000,
        "unityVersion": "2022.3.6f1",
        "worldSignature": "AHiPAWerwCpeYrxDthF5TU2SdUWEWnm43UAn8PKRXlS8k8tVRQ==",
        "impostorUrl": "string",
        "scanStatus": "string",
        "variant": "string"
      }
    ],
    "updated_at": "2019-08-24T14:15:22Z",
    "version": 68
  }
]

{
  "error": {
    "message": "\"Missing Credentials\"",
    "status_code": 401
  }
}