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 9d21bf8
Browse filesBrowse the repository at this point in the historyBrowse files
[[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: docs/AvatarsApi.md
+21-5Lines changed: 21 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -785,11 +785,11 @@ Name | Type | Description | Notes
785
785
[[Back to top]](#)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to Model list]](../README.md#documentation-for-models)[[Back to README]](../README.md)
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.
792
+
Search and list avatars by query filters. Without `marketplace`, you can only search your own or featured avatars.
793
793
794
794
### Example
795
795
@@ -835,10 +835,18 @@ max_unity_version = 'max_unity_version_example' # str | The maximum Unity versio
835
835
min_unity_version ='min_unity_version_example'# str | The minimum Unity version supported by the asset. (optional)
836
836
platform ='platform_example'# str | The platform the asset supports. (optional)
837
837
is_internal_variant = false # bool | Not quite sure what this actually does (exists on the website but doesn't seem to be used) (optional)
838
+
marketplace = vrchatapi.SearchAvatarsMarketplace() # SearchAvatarsMarketplace | Search avatars listed in the marketplace. (optional)
839
+
search ='search_example'# str | Text to search for. Requires `marketplace`. (optional)
840
+
metadata =True# bool | Wrap the results in an AvatarList. (optional)
print("Exception when calling AvatarsApi->search_avatars: %s\n"% e)
@@ -862,10 +870,18 @@ Name | Type | Description | Notes
862
870
**min_unity_version** | **str**| The minimum Unity version supported by the asset. | [optional]
863
871
**platform** | **str**| The platform the asset supports. | [optional]
864
872
**is_internal_variant** | **bool**| Not quite sure what this actually does (exists on the website but doesn't seem to be used) | [optional]
873
+
**marketplace** | [**SearchAvatarsMarketplace**](.md)| Search avatars listed in the marketplace. | [optional]
874
+
**search** | **str**| Text to search for. Requires `marketplace`. | [optional]
875
+
**metadata** | **bool**| Wrap the results in an AvatarList. | [optional]
876
+
**min_price** | **int**| | [optional]
877
+
**max_price** | **int**| | [optional]
878
+
**performance_at_least** | **int**| | [optional]
879
+
**min_asset_version** | **int**| | [optional]
880
+
**max_asset_version** | **int**| | [optional]
865
881
866
882
### Return type
867
883
868
-
[**list[Avatar]**](Avatar.md)
884
+
**object**
869
885
870
886
### Authorization
871
887
@@ -879,7 +895,7 @@ Name | Type | Description | Notes
879
895
### HTTP response details
880
896
| Status code | Description | Response headers |
881
897
|-------------|-------------|------------------|
882
-
**200** | | - |
898
+
**200** | Returns a list of Avatar objects, wrapped in a paginated object when `metadata` is `true`. | - |
883
899
**400** | The request failed validation. VRChat validates the request before it looks up the resource, so this response is returned even when the ID in the path does not exist. The message names the offending field or parameter. | - |
884
900
**401** | Error response due to missing auth cookie. | - |
[**get_economy_payout_status**](EconomyApi.md#get_economy_payout_status) | **GET** /user/{userId}/economy/payouts/status | Get Economy Payout Status
20
20
[**get_economy_payouts**](EconomyApi.md#get_economy_payouts) | **GET** /user/{userId}/economy/payouts/list | Get Economy Payouts
21
21
[**get_economy_status**](EconomyApi.md#get_economy_status) | **GET** /economy/status | Get Economy Status
22
+
[**get_economy_subscriptions**](EconomyApi.md#get_economy_subscriptions) | **GET** /economy/subscriptions | List Economy Subscriptions
22
23
[**get_license_group**](EconomyApi.md#get_license_group) | **GET** /licenseGroups/{licenseGroupId} | Get License Group
23
24
[**get_product_listing**](EconomyApi.md#get_product_listing) | **GET** /listing/{productId} | Get Product Listing
24
25
[**get_product_listing_alternate**](EconomyApi.md#get_product_listing_alternate) | **GET** /products/{productId} | Get Product Listing (alternate)
@@ -1155,6 +1156,86 @@ This endpoint does not need any parameter.
1155
1156
1156
1157
[[Back to top]](#)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to Model list]](../README.md#documentation-for-models)[[Back to README]](../README.md)
**n** | **int**| The number of objects to return. | [optional][default to 60]
1214
+
**offset** | **int**| A zero-based offset from the default object sorting from where search results start. | [optional]
1215
+
1216
+
### Return type
1217
+
1218
+
**list[object]**
1219
+
1220
+
### Authorization
1221
+
1222
+
[authCookie](../README.md#authCookie)
1223
+
1224
+
### HTTP request headers
1225
+
1226
+
-**Content-Type**: Not defined
1227
+
-**Accept**: application/json
1228
+
1229
+
### HTTP response details
1230
+
| Status code | Description | Response headers |
1231
+
|-------------|-------------|------------------|
1232
+
**200** | | - |
1233
+
**400** | The request failed validation. VRChat validates the request before it looks up the resource, so this response is returned even when the ID in the path does not exist. The message names the offending field or parameter. | - |
1234
+
**401** | Error response due to missing auth cookie. | - |
1235
+
**403** | Error response when requesting another user's economy subscriptions. | - |
1236
+
1237
+
[[Back to top]](#)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to Model list]](../README.md#documentation-for-models)[[Back to README]](../README.md)
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
[**get_instance**](InstancesApi.md#get_instance) | **GET** /instances/{worldId}:{instanceId} | Get Instance
12
12
[**get_instance_by_short_name**](InstancesApi.md#get_instance_by_short_name) | **GET** /instances/s/{shortName} | Get Instance By Short Name
13
13
[**get_instance_categories**](InstancesApi.md#get_instance_categories) | **GET** /instanceCategories | List Instance Categories
14
+
[**get_instance_count**](InstancesApi.md#get_instance_count) | **GET** /instances/count | Get Instance Count
14
15
[**get_instance_vibes**](InstancesApi.md#get_instance_vibes) | **GET** /instanceVibes | List Instance Vibes
15
16
[**get_recent_locations**](InstancesApi.md#get_recent_locations) | **GET** /instances/recent | List Recent Locations
16
17
[**get_short_name**](InstancesApi.md#get_short_name) | **GET** /instances/{worldId}:{instanceId}/shortName | Get Instance Short Name
@@ -577,6 +578,76 @@ This endpoint does not need any parameter.
577
578
578
579
[[Back to top]](#)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to Model list]](../README.md#documentation-for-models)[[Back to README]](../README.md)
579
580
581
+
# **get_instance_count**
582
+
> InstanceCount get_instance_count()
583
+
584
+
Get Instance Count
585
+
586
+
Returns instance and event counts as of `asOf`.
587
+
588
+
### Example
589
+
590
+
* Api Key Authentication (authCookie):
591
+
```python
592
+
from__future__import print_function
593
+
import time
594
+
import vrchatapi
595
+
from vrchatapi.rest import ApiException
596
+
from pprint import pprint
597
+
# Defining the host is optional and defaults to https://api.vrchat.cloud/api/1
598
+
# See configuration.py for a list of all supported configuration parameters.
599
+
configuration = vrchatapi.Configuration(
600
+
host="https://api.vrchat.cloud/api/1"
601
+
)
602
+
603
+
# The client must configure the authentication and authorization parameters
604
+
# in accordance with the API server security policy.
605
+
# Examples for each auth method are provided below, use the example that
# Enter a context with an instance of the API client
615
+
with vrchatapi.ApiClient(configuration) as api_client:
616
+
# Create an instance of the API class
617
+
api_instance = vrchatapi.InstancesApi(api_client)
618
+
619
+
try:
620
+
# Get Instance Count
621
+
api_response = api_instance.get_instance_count()
622
+
pprint(api_response)
623
+
except ApiException as e:
624
+
print("Exception when calling InstancesApi->get_instance_count: %s\n"% e)
625
+
```
626
+
627
+
### Parameters
628
+
This endpoint does not need any parameter.
629
+
630
+
### Return type
631
+
632
+
[**InstanceCount**](InstanceCount.md)
633
+
634
+
### Authorization
635
+
636
+
[authCookie](../README.md#authCookie)
637
+
638
+
### HTTP request headers
639
+
640
+
-**Content-Type**: Not defined
641
+
-**Accept**: application/json
642
+
643
+
### HTTP response details
644
+
| Status code | Description | Response headers |
645
+
|-------------|-------------|------------------|
646
+
**200** | Returns a single InstanceCount object. | - |
647
+
**401** | Error response due to missing auth cookie. | - |
648
+
649
+
[[Back to top]](#)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to Model list]](../README.md#documentation-for-models)[[Back to README]](../README.md)
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
[[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.5
8
+
The version of the OpenAPI document: 1.23.1-nightly.6
0 commit comments