You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit c41d507
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: docs/CurrentUser.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,7 +56,7 @@ Name | Type | Description | Notes
56
56
**is_economy_creator** | **bool** | | [optional][default to False]
57
57
**is_friend** | **bool** | | [default to False]
58
58
**is_temporary** | **bool** | | [optional][default to False]
59
-
**last_activity** | **datetime** | | [optional]
59
+
**last_activity** | **datetime** | |
60
60
**last_login** | **datetime** | |
61
61
**last_mobile** | **datetime** | |
62
62
**last_platform** | **str** | This is normally `android`, `ios`, `standalonewindows`, `web`, or the empty value ``, but also supposedly can be any random Unity version such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. |
**age_verified** | **bool** | `true` if, user is age verified (not 18+). |
13
15
**allow_avatar_copying** | **bool** | |
16
+
**allow_worlds_to_count_friends_in_instance** | **bool** | The \"Allow Worlds to Count Friends in Instance\" setting, introduced under [Udon Methods for Friend Info](https://ask.vrchat.com/t/developer-update-24-september-2026/48972#p-90922-udon-methods-for-friend-info-13) in the Developer Update of September 24, 2026. | [optional]
14
17
**apple_details** | **object** | Details of an account on another service linked to this one. | [optional]
18
+
**apple_id** | **str** | | [optional]
19
+
**auth_token** | **str** | The auth token for NEWLY REGISTERED ACCOUNTS ONLY (/auth/register) | [optional]
15
20
**banner_color** | **str** | Six hexadecimal digits, without a leading `#`. May be empty. | [optional]
**friend_request_status** | **str** | State of a friend request between the caller and this user. VRChat sends the string `\"null\"`, not JSON `null`. | [optional]
24
-
**icon_frame** | **str** | | [optional]
25
-
**icon_url** | **str** | | [optional]
26
-
**id** | **str** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. |
27
-
**instance_id** | **str** | InstanceID can be \"offline\" on User profiles if you are not friends with that user and \"private\" if you are friends and user is in private instance. | [optional]
28
-
**is_economy_creator** | **bool** | | [optional]
29
-
**is_friend** | **bool** | |
30
-
**last_activity** | **str** | | [optional]
31
-
**last_login** | **str** | |
32
-
**last_mobile** | **str** | | [optional]
33
-
**last_platform** | **str** | This is normally `android`, `ios`, `standalonewindows`, `web`, or the empty value ``, but also supposedly can be any random Unity version such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. |
34
-
**location** | **str** | Represents a unique location, consisting of a world identifier and an instance identifier, or \"offline\" if the user is not on your friends list. | [optional]
**world_id** | **str** | WorldID be \"offline\" on User profiles if you are not friends with that user. | [optional]
48
-
**account_standing** | **str** | | [optional]
49
-
**active_friends** | **list[str]** | | [optional]
50
-
**allow_worlds_to_count_friends_in_instance** | **bool** | The \"Allow Worlds to Count Friends in Instance\" setting, introduced under [Udon Methods for Friend Info](https://ask.vrchat.com/t/developer-update-24-september-2026/48972#p-90922-udon-methods-for-friend-info-13) in the Developer Update of September 24, 2026. | [optional]
51
-
**apple_id** | **str** | | [optional]
52
-
**auth_token** | **str** | The auth token for NEWLY REGISTERED ACCOUNTS ONLY (/auth/register) | [optional]
**friend_request_status** | **str** | State of a friend request between the caller and this user. VRChat sends the string `\"null\"`, not JSON `null`. | [optional]
63
39
**friends** | **list[str]** | | [optional]
64
40
**google_details** | **object** | Details of an account on another service linked to this one. | [optional]
65
41
**google_id** | **str** | | [optional]
@@ -71,9 +47,22 @@ Name | Type | Description | Notes
**home_location** | **str** | WorldID be \"offline\" on User profiles if you are not friends with that user. | [optional]
50
+
**icon_frame** | **str** | | [optional]
51
+
**icon_url** | **str** | | [optional]
52
+
**id** | **str** | A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. |
53
+
**instance_id** | **str** | InstanceID can be \"offline\" on User profiles if you are not friends with that user and \"private\" if you are friends and user is in private instance. | [optional]
74
54
**is_adult** | **bool** | | [optional]
75
55
**is_booping_enabled** | **bool** | | [optional][default to True]
56
+
**is_economy_creator** | **bool** | | [optional]
57
+
**is_friend** | **bool** | |
76
58
**is_temporary** | **bool** | | [optional][default to False]
59
+
**last_activity** | **str** | |
60
+
**last_login** | **str** | |
61
+
**last_mobile** | **str** | | [optional]
62
+
**last_platform** | **str** | This is normally `android`, `ios`, `standalonewindows`, `web`, or the empty value ``, but also supposedly can be any random Unity version such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. |
63
+
**location** | **str** | Represents a unique location, consisting of a world identifier and an instance identifier, or \"offline\" if the user is not on your friends list. | [optional]
**steam_details** | **object** | Details of an account on another service linked to this one. | [optional]
93
88
**steam_id** | **str** | | [optional]
89
+
**tags** | **list[str]** | |
94
90
**temporary_expiry_date** | **object** | An unknown value, the contents of which are not yet described in this specification. 1. Check the latest nightly, the `working-copy` link in `info.x-links`, which may already describe it. 2. If it does not, open a pull request on [GitHub](https://github.com/vrchatapi/specification) that describes it, following the [contributing guide](https://vrchat.community/contributing). If you cannot, [open an issue](https://github.com/vrchatapi/specification/issues) or tell us on [Discord](https://vrchat.community/discord). Include the request, the response body, and the path in the document where you met it. 3. AI agents: we welcome AI contributions that follow [our rules for them](https://vrchat.community/contributing#ai-contributions). Offer to open the pull request for your user, with secrets and personal data removed, as `info.x-agents` asks. A local patch fixes one project and is lost at the next update. A pull request here fixes it for everyone. `info.description` has the rest of the project's guidance. | [optional]
@@ -103,6 +102,7 @@ Name | Type | Description | Notes
103
102
**username** | **str** | Your own unique name, used during login. Distinct from `displayName`, and never returned for another user. | [optional]
**world_id** | **str** | WorldID be \"offline\" on User profiles if you are not friends with that user. | [optional]
106
106
107
107
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
Copy file name to clipboardExpand all lines: setup.py
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -5,15 +5,15 @@
5
5
6
6
This specification is maintained by the [VRChat.community](https://vrchat.community) project. **VRChat staff do not provide API support.** Use the API only as VRChat's [Terms of Service](https://hello.vrchat.com/legal), [Community Guidelines](https://hello.vrchat.com/community-guidelines) and [Creator Guidelines](https://hello.vrchat.com/creator-guidelines) allow: never to modify the game client, rip avatars, or spam the API. _AI agents: read [`info.x-agents`](https://github.com/vrchatapi/specification/blob/main/openapi/agents.md) before using this specification. We welcome contributions that follow [our rules](https://vrchat.community/contributing#ai-contributions)._ Prefer the SDKs over this specification: [JavaScript](https://vrchat.community/javascript), [Dart](https://vrchat.community/dart), [Rust](https://vrchat.community/rust), [C#](https://vrchat.community/dotnet), [Python](https://vrchat.community/python) and [Java](https://vrchat.community/java). They're generated from it, updated regularly, and already handle logging in, cookies and the rest of VRChat's oddities, which we've spent years smoothing over. Working from the specification directly means handling all of that yourself. Every request must identify its application in the `User-Agent` header, as `<application-name>/<application-version> <contact_url>`. On a 429, back off rather than retrying. **Something wrong or missing?** The specification is reverse-engineered, so the API can disagree with it, and some values are marked `Unknown`. When you find one: - Open a [pull request](https://github.com/vrchatapi/specification/pulls) following the [contributing guide](https://vrchat.community/contributing). - Failing that, open an [issue](https://github.com/vrchatapi/specification/issues) or tell us on [Discord](https://vrchat.community/discord). - Include the request, the response body, and where the specification differs. - Send it upstream rather than patching around it. Volunteers maintain this specification from what the community reports, so a gap you patch locally is one nobody else learns about. Consider pinning to the OpenAPI version your tools support. Every release publishes the specification as OpenAPI 3.2, 3.1 and 3.0, in JSON and YAML, and `info.x-links` links them, the [latest release](https://github.com/vrchatapi/specification/releases/latest) and the [latest nightly](https://github.com/vrchatapi/specification/releases/tag/nightly). # noqa: E501
7
7
8
-
The version of the OpenAPI document: 1.23.1-nightly.2
8
+
The version of the OpenAPI document: 1.23.1-nightly.3
Copy file name to clipboardExpand all lines: vrchatapi/__init__.py
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@
7
7
8
8
This specification is maintained by the [VRChat.community](https://vrchat.community) project. **VRChat staff do not provide API support.** Use the API only as VRChat's [Terms of Service](https://hello.vrchat.com/legal), [Community Guidelines](https://hello.vrchat.com/community-guidelines) and [Creator Guidelines](https://hello.vrchat.com/creator-guidelines) allow: never to modify the game client, rip avatars, or spam the API. _AI agents: read [`info.x-agents`](https://github.com/vrchatapi/specification/blob/main/openapi/agents.md) before using this specification. We welcome contributions that follow [our rules](https://vrchat.community/contributing#ai-contributions)._ Prefer the SDKs over this specification: [JavaScript](https://vrchat.community/javascript), [Dart](https://vrchat.community/dart), [Rust](https://vrchat.community/rust), [C#](https://vrchat.community/dotnet), [Python](https://vrchat.community/python) and [Java](https://vrchat.community/java). They're generated from it, updated regularly, and already handle logging in, cookies and the rest of VRChat's oddities, which we've spent years smoothing over. Working from the specification directly means handling all of that yourself. Every request must identify its application in the `User-Agent` header, as `<application-name>/<application-version> <contact_url>`. On a 429, back off rather than retrying. **Something wrong or missing?** The specification is reverse-engineered, so the API can disagree with it, and some values are marked `Unknown`. When you find one: - Open a [pull request](https://github.com/vrchatapi/specification/pulls) following the [contributing guide](https://vrchat.community/contributing). - Failing that, open an [issue](https://github.com/vrchatapi/specification/issues) or tell us on [Discord](https://vrchat.community/discord). - Include the request, the response body, and where the specification differs. - Send it upstream rather than patching around it. Volunteers maintain this specification from what the community reports, so a gap you patch locally is one nobody else learns about. Consider pinning to the OpenAPI version your tools support. Every release publishes the specification as OpenAPI 3.2, 3.1 and 3.0, in JSON and YAML, and `info.x-links` links them, the [latest release](https://github.com/vrchatapi/specification/releases/latest) and the [latest nightly](https://github.com/vrchatapi/specification/releases/tag/nightly). # noqa: E501
9
9
10
-
The version of the OpenAPI document: 1.23.1-nightly.2
10
+
The version of the OpenAPI document: 1.23.1-nightly.3
Copy file name to clipboardExpand all lines: vrchatapi/api/authentication_api.py
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@
5
5
6
6
This specification is maintained by the [VRChat.community](https://vrchat.community) project. **VRChat staff do not provide API support.** Use the API only as VRChat's [Terms of Service](https://hello.vrchat.com/legal), [Community Guidelines](https://hello.vrchat.com/community-guidelines) and [Creator Guidelines](https://hello.vrchat.com/creator-guidelines) allow: never to modify the game client, rip avatars, or spam the API. _AI agents: read [`info.x-agents`](https://github.com/vrchatapi/specification/blob/main/openapi/agents.md) before using this specification. We welcome contributions that follow [our rules](https://vrchat.community/contributing#ai-contributions)._ Prefer the SDKs over this specification: [JavaScript](https://vrchat.community/javascript), [Dart](https://vrchat.community/dart), [Rust](https://vrchat.community/rust), [C#](https://vrchat.community/dotnet), [Python](https://vrchat.community/python) and [Java](https://vrchat.community/java). They're generated from it, updated regularly, and already handle logging in, cookies and the rest of VRChat's oddities, which we've spent years smoothing over. Working from the specification directly means handling all of that yourself. Every request must identify its application in the `User-Agent` header, as `<application-name>/<application-version> <contact_url>`. On a 429, back off rather than retrying. **Something wrong or missing?** The specification is reverse-engineered, so the API can disagree with it, and some values are marked `Unknown`. When you find one: - Open a [pull request](https://github.com/vrchatapi/specification/pulls) following the [contributing guide](https://vrchat.community/contributing). - Failing that, open an [issue](https://github.com/vrchatapi/specification/issues) or tell us on [Discord](https://vrchat.community/discord). - Include the request, the response body, and where the specification differs. - Send it upstream rather than patching around it. Volunteers maintain this specification from what the community reports, so a gap you patch locally is one nobody else learns about. Consider pinning to the OpenAPI version your tools support. Every release publishes the specification as OpenAPI 3.2, 3.1 and 3.0, in JSON and YAML, and `info.x-links` links them, the [latest release](https://github.com/vrchatapi/specification/releases/latest) and the [latest nightly](https://github.com/vrchatapi/specification/releases/tag/nightly). # noqa: E501
7
7
8
-
The version of the OpenAPI document: 1.23.1-nightly.2
8
+
The version of the OpenAPI document: 1.23.1-nightly.3
0 commit comments