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 }}
This repository was archived by the owner on Apr 12, 2026. It is now read-only.
<!doctype html><htmllang=en-us><head><metacharset=utf-8><metaname=viewportcontent="width=device-width,minimum-scale=1"><metaname=authorcontent="Dart SDK | VRChat API Documentation"><metaname=descriptioncontent="Dart is a client-side language allowing compilation for Android, iOS, web, and terminal."><metaname=keywordscontent="vrchat,api,vrchatapi"><metaname=generatorcontent="Hugo 0.114.1"><linkhref=https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.cssrel=stylesheetintegrity=sha384-EVSTQN3/azprG1Anm3QDgpJLIm9Nao0Yz1ztcQTwFspd3yD65VohhpuuCOmLASjCcrossorigin=anonymous><linkrel=stylesheethref=/assets/css/api_custom_highlight.css><linkrel=stylesheethref=/assets/css/main.css><linkrel="shortcut icon" href=/favicon.icotype=image/x-icon><title>Dart SDK | VRChat API Documentation</title><metaproperty="og:title" content="Dart SDK"><metaproperty="og:description" content="Dart is a client-side language allowing compilation for Android, iOS, web, and terminal."><metaproperty="og:type" content="article"><metaproperty="og:url" content="https://vrchatapi.github.io/sdk/dart/"><metaproperty="article:section" content="sdk"><metaname=twitter:cardcontent="summary"><metaname=twitter:titlecontent="Dart SDK"><metaname=twitter:descriptioncontent="Dart is a client-side language allowing compilation for Android, iOS, web, and terminal."><scriptasyncdefersrc="https://www.googletagmanager.com/gtag/js?id=G-FBCK0H6BHS"></script>
2
-
<script>window.dataLayer=window.dataLayer||[];functiongtag(){dataLayer.push(arguments)}gtag("js",newDate),gtag("config","G-FBCK0H6BHS")</script></head><bodyclass=overflow-hidden><navclass="navbar navbar-expand-lg navbar-dark bg-dark"><divclass=container-fluid><aclass=navbar-brandhref=/><imgsrc=/assets/img/website_logo.pngalt="VRChat API Project" width=250class="d-inline d-md-none my-1">
3
-
<imgsrc=/assets/img/website_logo.pngalt="VRChat API Project" height=50class="d-none d-md-inline my-1"></a>
<spanclass=navbar-toggler-icon></span></button><divclass="collapse navbar-collapse" id=navbarSupportedContent><ulclass="navbar-nav ms-auto mb-2 mb-lg-0"><liclass="nav-item me-5"><atarget=_blankclass="nav-link fs-5 active fw-bold" href=https://github.com/vrchatapi>GitHub</a></li><liclass="nav-item me-5"><atarget=_blankclass="nav-link fs-5" href="https://metrics.vrchat.community/?orgId=1&refresh=1m">API Status</a></li><liclass="nav-item me-5 dropdown"><aclass="nav-link fs-5 dropdown-toggle" href=#id=navbarDropdownrole=buttondata-bs-toggle=dropdownaria-expanded=false>Reference</a><ulclass=dropdown-menuaria-labelledby=navbarDropdown><li><aclass="dropdown-item py-3" href=/docs/api>HTTP API</a></li><li><atarget=_blankclass="dropdown-item py-3" href=https://vrchat.vercel.app/>Swagger UI</a></li><li><hrclass=dropdown-divider></li><li><aclass="dropdown-item py-3" href=/tutorials/getting-started>Getting Started</a></li><li><aclass="dropdown-item py-3" href=/tutorials>Tutorials</a></li></ul></li><liclass="nav-item me-5 dropdown"><aclass="nav-link fs-5 dropdown-toggle" href=#id=languagesDropdownrole=buttondata-bs-toggle=dropdownaria-expanded=false>Languages</a><ulclass=dropdown-menuaria-labelledby=languagesDropdown><li><aclass="dropdown-item py-3" href=/sdk/javascript>Node SDK</a></li><li><aclass="dropdown-item py-3" href=/sdk/python>Python SDK</a></li><li><aclass="dropdown-item py-3" href=/sdk/java>Java SDK</a></li><li><aclass="dropdown-item py-3" href=/sdk/dart>Dart SDK</a></li><li><aclass="dropdown-item py-3" href=/sdk/rust>Rust SDK</a></li><li><aclass="dropdown-item py-3" href=/sdk/csharp>C# SDK</a></li></ul></li></ul><atarget=_blankhref=https://discord.gg/qjZE9C9fkBclass="d-flex text-decoration-none btn btn-outline-light me-3 px-4 py-3" type=submit>Join Discord</a></div></div></nav><mainid=contentstyle=position:fixed><divclass="container-fluid px-3 px-md-5"><divclass=row><divclass="col-12 col-md-8"><divclass="position-relative overflow-auto pe-3 pe-md-5 pb-3 pb-md-5" style="height:calc(100vh - 84px)"><navaria-label=breadcrumbclass=mt-5><olclass=breadcrumb><liclass=breadcrumb-item><ahref=/>Home</a></li><liclass=breadcrumb-item><ahref=/sdk>SDK</a></li><liclass="breadcrumb-item active" aria-current=page>Dart SDK</li></ol></nav><h1class="fw-bold display-2">Dart SDK</h1><divid=sdk-readme-content><p><pclass=md__image><imgclass="img-fluid rounded" src="https://github.com/vrchatapi/vrchatapi.github.io/blob/745d83b7c3df891b774b9eadbff8686aa746f5c0/assets/img/lang/lang_dart_banner_1500x300.png?raw=true" alt></p></p><h1id=vrchat_dart>vrchat_dart</h1><p>A Dart client to interact with the unofficial VRChat API. Supports all REST calls specified in <ahref=https://github.com/vrchatapi/specification>https://github.com/vrchatapi/specification</a>. Also supports websocket streaming for status updates.</p><h2id=disclaimer>Disclaimer</h2><p>This is the official response of the VRChat Team (from Tupper more specifically) on the usage of the VRChat API.</p><blockquote><p>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:</p><ul><li>We do not provide documentation or support for the API.</li><li>Do not make queries to the API more than once per 60 seconds.</li><li>Abuse of the API may result in account termination.</li><li>Access to API endpoints may break at any given time, with no warning.</li></ul></blockquote><p>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.</p><h2id=getting-started>Getting Started</h2><p>See the <ahref=https://github.com/vrchatapi/vrchatapi-dart/blob/master/vrchat_dart/example/main.dart>example</a> for getting started in Dart.</p><p>See <ahref=https://github.com/vrchatapi/vrchatapi-dart/tree/master/vrchat_dart/example_flutter>example_flutter</a> for help getting started in Flutter.</p><h2id=contributing>Contributing</h2><p>Contributions to <ahref=https://pub.dev/packages/vrchat_dart_generated>vrchat_dart_generated</a> should only be done to keep it up to date with the <ahref=https://github.com/vrchatapi/specification>specification</a>. Run <code>generate.sh</code> to generate the code.</p><p>Contributions to vrchat_dart are welcome, but do not add features that should be handled by the OpenAPI specification.</p><p>Join the <ahref=https://discord.gg/Ge2APMhPfD>Discord server</a> to get in touch with us.</p></div><divclass="d-block d-md-none"><hrclass=my-5><atarget=_blankhref=https://github.com/vrchatapi/vrchatapi-dartclass="btn btn-gold fw-bold text-uppercase mt-3 d-block btn-lg">Go to GitHub Repository</a><navid=tutorial-navbarclass="navbar navbar-light flex-column align-items-stretch bg-light p-3 mt-3"><aclass="navbar-brand fw-bold py-2" href=#>Dart SDK</a><hrclass=mt-1><navclass="row text-center text-nowrap"><divclass=col>Stars<br><strong>3</strong></div><divclass=col>Last updated<br><strong><spandata=relative-date>2021-10-09T23:37:03Z</span></strong></div><divclass=col>License<br><strong>MIT</strong></div></nav></nav><navclass="navbar navbar-light flex-column align-items-stretch bg-light p-3 mt-3"><divclass="navbar-brand fw-bold py-2" href=#>Links</div><hrclass=mt-1><navclass="nav nav-pills flex-column"><atarget=_blankhref=https://pub.dev/packages/vrchat_dartclass=nav-link>pub.dev</a></nav></nav><divclass="bg-light p-3 mt-3"><divid=footerslot=footerclass="pt-2 pb-3"><divclass="row pt-2 align-items-center"><divclass="col-12 ps-4"><divclass=text-center>VRChat API Documentation<br>made with ❤️ by the Community</div><smallclass="legal mt-2">"VRChat" and the VRChat logo are registered trademarks of VRChat Incorporated in the United States.
6
-
All trademarks referred to herein are the property of their respective owners.
7
-
All company, product and service names used in this website are for identification purposes only, in
8
-
accordance with Fair Use.
9
-
Use of these names, logos, and brands does not imply endorsement.</small></div><divclass="col-4 pt-4 text-center"><ahref=https://discord.gg/qjZE9C9fkB>Support</a></div><divclass="col-4 pt-4 text-center"><ahref=mailto:me@ruby.js.org>Inquiries</a></div><divclass="col-4 pt-4 pe-5"><ahref=https://github.com/vrchatapiclass="mx-auto d-block" style=width:30px><svgviewBox="0 0 128 128" width="30"><gfill="#181616"><pathfill-rule="evenodd" clip-rule="evenodd" d="M64 5.103c-33.347.0-60.388 27.035-60.388 60.388.0 26.682 17.303 49.317 41.297 57.303 3.017.56 4.125-1.31 4.125-2.905.0-1.44-.056-6.197-.082-11.243-16.8 3.653-20.345-7.125-20.345-7.125-2.747-6.98-6.705-8.836-6.705-8.836-5.48-3.748.413-3.67.413-3.67 6.063.425 9.257 6.223 9.257 6.223 5.386 9.23 14.127 6.562 17.573 5.02.542-3.903 2.107-6.568 3.834-8.076-13.413-1.525-27.514-6.704-27.514-29.843.0-6.593 2.36-11.98 6.223-16.21-.628-1.52-2.695-7.662.584-15.98.0.0 5.07-1.623 16.61 6.19C53.7 35 58.867 34.327 64 34.304c5.13.023 10.3.694 15.127 2.033 11.526-7.813 16.59-6.19 16.59-6.19 3.287 8.317 1.22 14.46.593 15.98 3.872 4.23 6.215 9.617 6.215 16.21.0 23.194-14.127 28.3-27.574 29.796 2.167 1.874 4.097 5.55 4.097 11.183.0 8.08-.07 14.583-.07 16.572.0 1.607 1.088 3.49 4.148 2.897 23.98-7.994 41.263-30.622 41.263-57.294C124.388 32.14 97.35 5.104 64 5.104z"/><pathd="M26.484 91.806c-.133.3-.605.39-1.035.185-.44-.196-.685-.605-.543-.906.13-.31.603-.395 1.04-.188.44.197.69.61.537.91zm2.446 2.729c-.287.267-.85.143-1.232-.28-.396-.42-.47-.983-.177-1.254.298-.266.844-.14 1.24.28.394.426.472.984.17 1.255zm2.382 3.477c-.37.258-.976.017-1.35-.52-.37-.538-.37-1.183.01-1.44.373-.258.97-.025 1.35.507.368.545.368 1.19-.01 1.452zm3.261 3.361c-.33.365-1.036.267-1.552-.23-.527-.487-.674-1.18-.343-1.544.336-.366 1.045-.264 1.564.23.527.486.686 1.18.333 1.543zm4.5 1.951c-.147.473-.825.688-1.51.486-.683-.207-1.13-.76-.99-1.238.14-.477.823-.7 1.512-.485.683.206 1.13.756.988 1.237zm4.943.361c.017.498-.563.91-1.28.92-.723.017-1.308-.387-1.315-.877.0-.503.568-.91 1.29-.924.717-.013 1.306.387 1.306.88zm4.598-.782c.086.485-.413.984-1.126 1.117-.7.13-1.35-.172-1.44-.653-.086-.498.422-.997 1.122-1.126.714-.123 1.354.17 1.444.663zm0 0"/></g></svg></a></div></div></div></div></div></div></div><divclass="col-12 col-md-4 d-none d-md-block"><atarget=_blankhref=https://github.com/vrchatapi/vrchatapi-dartclass="btn btn-gold fw-bold text-uppercase mt-3 d-block btn-lg">Go to GitHub Repository</a><navid=tutorial-navbarclass="navbar navbar-light flex-column align-items-stretch bg-light p-3 mt-3"><aclass="navbar-brand fw-bold py-2" href=#>Dart SDK</a><hrclass=mt-1><navclass="row text-center text-nowrap"><divclass=col>Stars<br><strong>3</strong></div><divclass=col>Last updated<br><strong><spandata=relative-date>2021-10-09T23:37:03Z</span></strong></div><divclass=col>License<br><strong>MIT</strong></div></nav></nav><navclass="navbar navbar-light flex-column align-items-stretch bg-light p-3 mt-3"><divclass="navbar-brand fw-bold py-2" href=#>Links</div><hrclass=mt-1><navclass="nav nav-pills flex-column"><atarget=_blankhref=https://pub.dev/packages/vrchat_dartclass=nav-link>pub.dev</a></nav></nav><divclass="bg-light p-3 mt-3"><divid=footerslot=footerclass="pt-2 pb-3"><divclass="row pt-2 align-items-center"><divclass="col-12 ps-4"><divclass=text-center>VRChat API Documentation<br>made with ❤️ by the Community</div><smallclass="legal mt-2">"VRChat" and the VRChat logo are registered trademarks of VRChat Incorporated in the United States.
10
-
All trademarks referred to herein are the property of their respective owners.
11
-
All company, product and service names used in this website are for identification purposes only, in
<script>window.addEventListener("load",function(){[...document.querySelectorAll("*")].filter(e=>e.nodeName=="TABLE").map(e=>{console.log("Adding table to table",e),e.classList.add("table")})})</script></body></html>
0 commit comments