https://github.com/mayocream/vrchat-go
VRChat Go OpenAPI client
https://github.com/mayocream/vrchat-go
Last synced: 10 months ago
JSON representation
VRChat Go OpenAPI client
- Host: GitHub
- URL: https://github.com/mayocream/vrchat-go
- Owner: mayocream
- License: apache-2.0
- Created: 2024-09-12T09:07:04.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-09T04:31:57.000Z (over 1 year ago)
- Last Synced: 2025-08-15T16:58:54.271Z (10 months ago)
- Language: Go
- Size: 83 KB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# VRChat API Library for Go
A Go client to interact with the unofficial VRChat API. Supports all REST calls specified in the [API specification](https://github.com/vrchatapi/specification).
The `*.gen.go` files are generated by using [mayocream/openapi-codegen](https://github.com/mayocream/openapi-codegen).
## Disclaimer
> Use of the API using applications other than the approved methods (website, VRChat application) are not officially supported. You may use the API for your own application, but keep these guidelines in mind:
> * We do not provide documentation or support for the API.
> * Do not make queries to the API more than once per 60 seconds.
> * Abuse of the API may result in account termination.
> * Access to API endpoints may break at any given time, with no warning.
## Getting Started
```go
package main
import (
"github.com/mayocream/vrchat-go"
)
func main() {
client := vrchat.NewClient("https://vrchat.com/api/1")
err := client.Authenticate("username", "password", "totp")
if err != nil {
panic(err)
}
user, err := client.GetCurrentUser()
if err != nil {
panic(err)
}
println("logged in as ", user.DisplayName)
}
```
Read full example [here](examples/main.go).