https://github.com/vrchatapi/vrchatapi-elixir

VRChat API for Elixir
https://github.com/vrchatapi/vrchatapi-elixir

api elixir sdk vrchat

Last synced: about 1 month ago
JSON representation

VRChat API for Elixir

• Host: GitHub
• URL: https://github.com/vrchatapi/vrchatapi-elixir
• Owner: vrchatapi
• License: mit
• Fork: true (polyjitter/vrchatapi-elixir)
• Created: 2022-11-29T05:16:36.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-27T18:33:42.000Z (5 months ago)
• Last Synced: 2024-09-22T12:32:48.291Z (about 1 month ago)
• Topics: api, elixir, sdk, vrchat
• Language: Elixir
• Homepage: https://hex.pm/packages/vrchat
• Size: 26.5 MB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# VRChat API Library for Elixir

An Elixir client to interact with the unofficial VRChat API. Supports all REST calls specified in the [API specification](https://github.com/vrchatapi/specification).

This package has its own documentation available on HexDocs, but it is recommended to also refer to the main [VRChat API documentation](https://vrchatapi.github.io/).

## Disclaimer

This is the official response of the VRChat Team (from Tupper more specifically) on the usage of the VRChat API.

> 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.

As stated, this documentation was not created with the help of the official VRChat team. Therefore this documentation is not an official documentation of the VRChat API and may not be always up to date with the latest versions. If you find that a page or endpoint is not longer valid please create an issue and tell us so we can fix it.

### Building

To install the required dependencies and to build the elixir project, run:

```

mix local.hex --force

mix do deps.get, compile

```

## Installation

The package can be installed by adding `vrchat` to your list of dependencies in `mix.exs`:

```elixir

def deps do

  [{:vrchat, "~> 1.11.1"}]

end

```

Documentation can be found at [https://hexdocs.pm/vrchat](https://hexdocs.pm/vrchat).

## Usage

```elixir

{:ok, user, conn} = VRChat.Authentication.login(

  username: "...",

  password: "...",

  totp_token: "..."

)

VRChat.Avatars.get_avatar(conn, user.currentAvatar)

```

`get_current_user` validates the username and password, and returns a

new client with a usable auth key sent as a cookie for usage in the

rest of the api.

## Configuration

You can override the URL of your server (e.g. if you have a separate development and production server in your configuration files)

```elixir

config :vrchat, base_url: "https://api.vrchat.cloud/api/1"

```