利用ガイド
このAPIを使うときの決まりごとです。個人が運営している無料のAPIなので、みんなが気持ちよく使えるよう、ご協力をお願いします。
基本
| ベースURL | https://vrc.hachune.space/api/v1 |
|---|---|
| メソッド | GET のみ（それ以外は 403） |
| 認証 | 不要（APIキーはありません） |
| 形式 | JSON（UTF-8）。ワールド一覧は配列、アバター一覧は items を含むオブジェクトです |
| 更新頻度 | アバターのデータは1日4回（0時・6時・12時・18時 JST）。応答は最大5分ほどキャッシュされることがあります |
守っていただきたいこと
- User-Agent を指定する：アプリ名とバージョン、できれば連絡先を入れてください（例：
my-app/1.0 (+https://example.com)）。Python-urllibの既定値など、一般的な既定値は403で拒否されます。 - リクエスト数を抑える：1つのIPアドレスから10秒間に40リクエストまでです。連続して取得するときは、0.3秒ほど間隔を空けてください。
- 取得結果は保存して使い回す：データは1日4回しか変わりません。毎回取りにいかず、手元にキャッシュしてください。
- ブラウザ以外からの大量取得はしない：全件を何度も取得するような使い方は、制限の対象になります。
- 他サイトのブラウザから直接呼ばない：CORS（他のサイトからのブラウザ通信）は許可していません。サーバー側から呼び出してください。
エラーのとき
| コード | 意味 | 対処 |
|---|---|---|
400 | パラメータが正しくありません | 必須の項目と形式を確認してください |
403 | User-Agent が未指定・拒否される値、または GET 以外のメソッド | User-Agent を指定し、GET で呼び出してください |
404 | 存在しないパス、または対象のデータがありません | パスとIDを確認してください |
429 | リクエストが多すぎます | Retry-After ヘッダの秒数だけ待ってから再開してください |
データと権利について
- データの出典は BOOTH および VRChat です。商品情報・画像・ワールド情報の権利は、それぞれの作者・運営に帰属します。
- セール情報（
on_saleなど）は、記録上の最高値との比較などから出した参考値で、BOOTHが公式に提供するものではありません。 - データは正確さを保証するものではありません。購入やダウンロードの前に、必ず元のページで内容を確認してください。
- このAPIは予告なく変更・停止することがあります。
出典表記のお願い（強制ではありません）
このAPIを使ったサービス・アプリ・Bot、VRChat内のワールドやアセットなどを公開するときは、出典としてこのAPIと、表示するアバター・ワールドの出店元（作者）を明示していただけるとありがたいです。義務ではなく、APIの利用条件でもありません。例文やQRコードは 開発者向け にあります。
お問い合わせ
不具合や要望は、運営ブログの torishio工房 からご連絡ください。