v6 documentation is incomplete, want to contribute?

VRChat.community

API documentation, SDKs, and more
API Reference
Discord

Get Avatar

Get information about a specific Avatar.

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

GET
/avatars/{avatarId}

Authorization

auth<token>

Auth Token via Cookie

In: cookie

Path Parameters

avatarIdstring

Must be a valid avatar ID.

Response Body

curl -X GET "https://api.vrchat.cloud/api/1/avatars/string"
fetch("https://api.vrchat.cloud/api/1/avatars/string")
package main

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

func main() {
  url := "https://api.vrchat.cloud/api/1/avatars/string"

  req, _ := http.NewRequest("GET", url, nil)
  
  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/string"

response = requests.request("GET", url)

print(response.text)
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.time.Duration;

HttpClient client = HttpClient.newBuilder()
  .connectTimeout(Duration.ofSeconds(10))
  .build();

HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
  .uri(URI.create("https://api.vrchat.cloud/api/1/avatars/string"))
  .GET()
  .build();

try {
  HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString());
  System.out.println("Status code: " + response.statusCode());
  System.out.println("Response body: " + response.body());
} catch (Exception e) {
  e.printStackTrace();
}
using System;
using System.Net.Http;
using System.Text;

var client = new HttpClient();
var response = await client.GetAsync("https://api.vrchat.cloud/api/1/avatars/string");
var responseBody = await response.Content.ReadAsStringAsync();
{
  "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",
  "listingDate": "string",
  "lock": true,
  "lowestPrice": 0,
  "name": "string",
  "performance": {
    "android": "string",
    "android-sort": 0,
    "ios": "string",
    "ios-sort": 0,
    "standalonewindows": "string",
    "standalonewindows-sort": 0
  },
  "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
  }
}

{
  "error": {
    "message": "Can't find avatar!",
    "status_code": 404
  }
}