Public API v1
外部開発者が API キーを使って XRift のデータにアクセスするための Public API リファレンスです。
ベース URL: https://api.xrift.net/api/public/v1
認証
2 種類の認証方式をサポートしています。リクエスト時に Authorization ヘッダーでトークンを送信してください。
| 認証方式 | ヘッダー | 用途 |
|---|---|---|
| API キー | Authorization: Bearer xrift_sk_xxx | サードパーティ開発者向け(スコープ + レート制限あり) |
| CLI トークン | Authorization: Bearer xrf_xxx | CLI / 内部ツール向け(全権限、レート制限なし) |
API キーは XRift の設定画面 から取得できます。
- API キーは
xrift_sk_プレフィックスで識別されます - CLI トークンは
xrf_プレフィックスで識別されます - いずれの形式にも該当しないトークンは
401エラーになります
スコープ
API キー認証ではスコープによるアクセス制御が行われます。必要なスコープが不足している場合は 403 エラーが返されます。
| スコープ | アクセス対象 |
|---|---|
read:worlds | ワールド一覧・検索・詳細・人気ランキング・統計・ユーザーの公開ワールド |
read:users | ユーザー公開プロフィール・ユーザー検索 |
read:instances | インスタンス一覧・詳細・ワールドのインスタンス |
read:marketplace | マーケットプレイスの出品一覧・検索・詳細 |
read:events | イベント一覧・詳細 |
CLI トークンはスコープチェックをスキップし、全エンドポイントにアクセスできます。
エンドポイント
GET /worlds
ワールド一覧を取得します(ページネーション付き)。
- スコープ:
read:worlds
パラメータ
| パラメータ | 型 | デフォルト | 説明 |
|---|---|---|---|
limit | number | 20 | 取得件数(最大 50) |
offset | number | 0 | オフセット |
リクエスト例
curl -H "Authorization: Bearer xrift_sk_xxx" \
"https://api.xrift.net/api/public/v1/worlds?limit=10&offset=0"
レスポンス例
{
"data": [
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "My World",
"description": "サンプルワールド",
"ownerId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"isPublic": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z"
}
],
"pagination": {
"total": 100,
"limit": 10,
"offset": 0
}
}
GET /worlds/search
ワールドをキーワードで検索します。
- スコープ:
read:worlds
パラメータ
| パラメータ | 型 | 必須 | デフォルト | 説明 |
|---|---|---|---|---|
q | string | 必須 | - | 検索キーワード |
limit | number | - | 20 | 取得件数(最大 50) |
offset | number | - | 0 | オフセット |
リクエスト例
curl -H "Authorization: Bearer xrift_sk_xxx" \
"https://api.xrift.net/api/public/v1/worlds/search?q=tokyo&limit=5"
レスポンス例
{
"data": [
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "Tokyo Tower World",
"description": "東京タワーを再現したワールド"
}
],
"pagination": {
"total": 3,
"limit": 5,
"offset": 0
}
}
エラー
| ステータス | 条件 | レスポンス |
|---|---|---|
| 400 | q パラメータが未指定 | { "error": "Query parameter \"q\" is required" } |
GET /worlds/popular
人気ワールドランキングを取得します。
- スコープ:
read:worlds
パラメータ
| パラメータ | 型 | デフォルト | 説明 |
|---|---|---|---|
period | string | all | 集計期間(all / week / month) |
limit | number | 20 | 取得件数(最大 50) |
offset | number | 0 | オフセット |
リクエスト例
curl -H "Authorization: Bearer xrift_sk_xxx" \
"https://api.xrift.net/api/public/v1/worlds/popular?period=week&limit=10"
レスポンス例
{
"data": [
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "Popular World",
"description": "人気のワールド",
"ownerId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"isPublic": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z"
}
],
"pagination": {
"total": 50,
"limit": 10,
"offset": 0
},
"period": "week"
}
GET /worlds/:id
指定した ID のワールド詳細を取得します。
- スコープ:
read:worlds
パスパラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
id | string | ワールド ID |
リクエスト例
curl -H "Authorization: Bearer xrift_sk_xxx" \
"https://api.xrift.net/api/public/v1/worlds/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
レスポンス例
{
"data": {
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "My World",
"description": "サンプルワールド",
"ownerId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"isPublic": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z"
}
}
エラー
| ステータス | 条件 | レスポンス |
|---|---|---|
| 404 | ワールドが存在しない | { "error": "World not found" } |
GET /worlds/:id/stats
指定したワールドの公開統計情報を取得します。
- スコープ:
read:worlds
パスパラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
id | string | ワールド ID |
リクエスト例
curl -H "Authorization: Bearer xrift_sk_xxx" \
"https://api.xrift.net/api/public/v1/worlds/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/stats"
レスポンス例
{
"data": {
"worldId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"totalVisits": 12345,
"uniqueVisitors": 6789,
"visitsLast7Days": 234,
"visitsLast30Days": 890
}
}
日別の訪問数(dailyVisits)は非公開です。
エラー
| ステータス | 条件 | レスポンス |
|---|---|---|
| 404 | ワールドが存在しない | { "error": "World not found" } |
GET /worlds/:id/instances
指定したワールドのインスタンス一覧を取得します。公開インスタンスのみ返却されます。
- スコープ:
read:instances
パスパラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
id | string | ワールド ID |
パラメータ
| パラメータ | 型 | デフォルト | 説明 |
|---|---|---|---|
limit | number | 20 | 取得件数(最大 50) |
offset | number | 0 | オフセット |
リクエスト例
curl -H "Authorization: Bearer xrift_sk_xxx" \
"https://api.xrift.net/api/public/v1/worlds/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/instances?limit=10"
レスポンス例
{
"data": [
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"worldId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"currentUsers": 8,
"maxCapacity": 20,
"participants": [
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"displayName": "sawa-zen",
"userIconUrl": null
}
],
"createdAt": "2026-01-01T00:00:00.000Z"
}
],
"pagination": {
"total": 3,
"limit": 10,
"offset": 0
}
}
人数の扱いは GET /instances と同じです(参加人数は currentUsers を使い、participants の件数で数えない)。
エラー
| ステータス | 条件 | レスポンス |
|---|---|---|
| 404 | ワールドが存在しない | { "error": "World not found" } |
GET /users/search
ユーザーを表示名で検索します。
- スコープ:
read:users
パラメータ
| パラメータ | 型 | 必須 | デフォルト | 説明 |
|---|---|---|---|---|
q | string | 必須 | - | 検索キーワード(displayName の部分一致) |
limit | number | - | 20 | 取得件数(最大 50) |
offset | number | - | 0 | オフセット |
リクエスト例
curl -H "Authorization: Bearer xrift_sk_xxx" \
"https://api.xrift.net/api/public/v1/users/search?q=sawa&limit=10"
レスポンス例
{
"data": [
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"displayName": "sawa-zen",
"userIconUrl": "https://example.com/avatar.png",
"createdAt": "2026-01-01T00:00:00.000Z"
}
],
"pagination": {
"total": 1,
"limit": 10,
"offset": 0
}
}
エラー
| ステータス | 条件 | レスポンス |
|---|---|---|
| 400 | q パラメータが未指定 | { "error": "Query parameter \"q\" is required" } |
GET /users/:id
指定した ID のユーザー公開プロフィールを取得します。
- スコープ:
read:users
パスパラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
id | string | ユーザー ID |
リクエスト例
curl -H "Authorization: Bearer xrift_sk_xxx" \
"https://api.xrift.net/api/public/v1/users/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
レスポンス例
{
"data": {
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"displayName": "sawa-zen",
"userIconUrl": "https://example.com/avatar.png",
"createdAt": "2026-01-01T00:00:00.000Z"
}
}
エラー
| ステータス | 条件 | レスポンス |
|---|---|---|
| 404 | ユーザーが存在しない | { "error": "User not found" } |
GET /users/:id/worlds
指定したユーザーの公開ワールド一覧を取得します。公開かつ ACTIVE なワールドのみ返却されます。
- スコープ:
read:worlds
パスパラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
id | string | ユーザー ID |
パラメータ
| パラメータ | 型 | デフォルト | 説明 |
|---|---|---|---|
limit | number | 20 | 取得件数(最大 50) |
offset | number | 0 | オフセット |
リクエスト例
curl -H "Authorization: Bearer xrift_sk_xxx" \
"https://api.xrift.net/api/public/v1/users/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/worlds?limit=10"
レスポンス例
{
"data": [
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "My World",
"description": "サンプルワールド",
"ownerId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"isPublic": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z"
}
],
"pagination": {
"total": 5,
"limit": 10,
"offset": 0
}
}
エラー
| ステータス | 条件 | レスポンス |
|---|---|---|
| 404 | ユーザーが存在しない | { "error": "User not found" } |
GET /instances
アクティブなインスタンス一覧を取得します(ページネーション付き)。
- スコープ:
read:instances
パラメータ
| パラメータ | 型 | 必須 | デフォルト | 説明 |
|---|---|---|---|---|
worldId | string | - | - | 指定したワールドのインスタンスのみ取得 |
limit | number | - | 20 | 取得件数(最大 50) |
offset | number | - | 0 | オフセット |
リクエスト例
# 全インスタンス一覧
curl -H "Authorization: Bearer xrift_sk_xxx" \
"https://api.xrift.net/api/public/v1/instances"
# 特定ワールドのインスタンスのみ
curl -H "Authorization: Bearer xrift_sk_xxx" \
"https://api.xrift.net/api/public/v1/instances?worldId=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
レスポンス例
{
"data": [
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"worldId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"currentUsers": 8,
"maxCapacity": 20,
"participants": [
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"displayName": "sawa-zen",
"userIconUrl": null
}
],
"createdAt": "2026-01-01T00:00:00.000Z"
}
],
"pagination": {
"total": 5,
"limit": 20,
"offset": 0
}
}
参加人数は currentUsers、上限人数は maxCapacity を使ってください。participants はアイコンを並べるなどの表示用で、登録ユーザーのうち先頭 5 人までしか入りません(ゲストは含まれません)。participants の件数は参加人数と一致しないことがあります。
GET /instances/:id
指定した ID のインスタンス詳細を取得します。
インスタンスは全員が退出してから 5 分で自動的に削除されるため、保存しておいた ID が後から 404 になることがあります。残り続けるのは XRift Plus の常設インスタンスだけです。
- スコープ:
read:instances
パスパラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
id | string | インスタンス ID |
リクエスト例
curl -H "Authorization: Bearer xrift_sk_xxx" \
"https://api.xrift.net/api/public/v1/instances/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
レスポンス例
{
"data": {
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"worldId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"currentUsers": 8,
"maxCapacity": 20,
"participants": [
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"displayName": "sawa-zen",
"userIconUrl": null
}
],
"createdAt": "2026-01-01T00:00:00.000Z"
}
}
人数の扱いは GET /instances と同じです(参加人数は currentUsers を使い、participants の件数で数えない)。
エラー
| ステータス | 条件 | レスポンス |
|---|---|---|
| 404 | インスタンスが存在しない | { "error": "Instance not found" } |
GET /marketplace/items
マーケットプレイスに出品中のアイテム一覧を取得します。公開かつ審査を通ったアイテムだけが返ります。
- スコープ:
read:marketplace
パラメータ
| パラメータ | 型 | 必須 | デフォルト | 説明 |
|---|---|---|---|---|
sort | string | - | popular | 並び順(popular: 入手数の多い順 / newest: 新しい順 / trending: 直近の勢い順) |
ownerId | string | - | - | 指定したユーザーの出品だけに絞る |
limit | number | - | 20 | 取得件数(1〜50。50 を超える値は 50 として扱う) |
offset | number | - | 0 | オフセット(0 以上) |
sort=trending では、直近に入手されていないアイテムは一覧に含まれません。
リクエスト例
# 人気順
curl -H "Authorization: Bearer xrift_sk_xxx" \
"https://api.xrift.net/api/public/v1/marketplace/items?limit=10"
# 特定ユーザーの出品を新しい順に
curl -H "Authorization: Bearer xrift_sk_xxx" \
"https://api.xrift.net/api/public/v1/marketplace/items?ownerId=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&sort=newest"
レスポンス例
{
"data": [
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "Picture Frame",
"description": "写真を飾れる額縁",
"sceneUrl": "https://assets.xrift.net/.../remoteEntry.js",
"thumbnailUrl": "https://assets.xrift.net/.../thumbnail.png",
"githubUrl": null,
"fileSize": "1048576",
"status": "ACTIVE",
"securityScore": 0,
"isPublic": true,
"currentVersionNumber": 2,
"acquireCount": 42,
"permissions": {
"allowedDomains": [],
"allowedCodeRules": []
},
"owner": {
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"displayName": "sawa-zen",
"userIconUrl": "https://example.com/avatar.png"
},
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z"
}
],
"pagination": {
"total": 99,
"limit": 10,
"offset": 0
}
}
fileSizeはバイト数を文字列で返します
エラー
| ステータス | 条件 | レスポンス |
|---|---|---|
| 400 | sort が不正 | { "error": "sort は popular、newest、trending のいずれかを指定してください" } |
| 400 | ownerId が空文字 | { "error": "ownerId は空にできません" } |
| 400 | limit / offset が 10 進数の整数でない(1.5・1e2・0x10 など)、または limit が 0 | { "error": "limit は 1 以上の整数を指定してください" } |
存在しないユーザーの ID を ownerId に指定してもエラーにはならず、空の一覧が返ります。
GET /marketplace/items/search
マーケットプレイスに出品中のアイテムを、名前・説明文・作者名の部分一致で検索します。
- スコープ:
read:marketplace
パラメータ
| パラメータ | 型 | 必須 | デフォルト | 説明 |
|---|---|---|---|---|
q | string | 必須 | - | 検索キーワード |
sort | string | - | newest | 並び順(popular / newest / trending) |
ownerId | string | - | - | 指定したユーザーの出品だけに絞る |
limit | number | - | 20 | 取得件数(1〜50。50 を超える値は 50 として扱う) |
offset | number | - | 0 | オフセット(0 以上) |
リクエスト例
curl -H "Authorization: Bearer xrift_sk_xxx" \
"https://api.xrift.net/api/public/v1/marketplace/items/search?q=frame&limit=5"
レスポンス例
GET /marketplace/items と同じ形です。
エラー
| ステータス | 条件 | レスポンス |
|---|---|---|
| 400 | q パラメータが未指定(空白だけの場合も含む) | { "error": "Query parameter \"q\" is required" } |
| 400 | sort / ownerId / limit / offset が不正 | GET /marketplace/items と同じ |
GET /marketplace/items/:id
指定した ID のアイテムの詳細を取得します。
- スコープ:
read:marketplace
パスパラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
id | string | アイテム ID |
リクエスト例
curl -H "Authorization: Bearer xrift_sk_xxx" \
"https://api.xrift.net/api/public/v1/marketplace/items/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
レスポンス例
{
"data": {
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "Picture Frame",
"description": "写真を飾れる額縁",
"acquireCount": 42,
"owner": {
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"displayName": "sawa-zen"
}
}
}
(一部のフィールドを省略しています。全フィールドは GET /marketplace/items のレスポンス例を参照してください)
エラー
| ステータス | 条件 | レスポンス |
|---|---|---|
| 404 | アイテムが存在しない・非公開・審査中 | { "error": "Item not found" } |
非公開や審査中のアイテムは、持ち主の API キーで取得しても 404 になります。
GET /events
イベント一覧を取得します。繰り返しイベントは、指定した期間の中の各回に展開して返します。
- スコープ:
read:events
パラメータ
| パラメータ | 型 | 必須 | デフォルト | 説明 |
|---|---|---|---|---|
from | string | 必須 | - | 期間の開始(ISO 8601) |
to | string | 必須 | - | 期間の終了(ISO 8601)。from から 366 日以内 |
worldId | string | - | - | 会場のワールドで絞る |
instanceId | string | - | - | インスタンスで絞る |
ownerId | string | - | - | 主催者で絞る |
kind | string | - | - | scheduled(予定)/ instant(即席) |
status | string | - | - | upcoming / live / ended / cancelled |
order | string | - | asc | 開始日時の並び順(asc / desc) |
limit | number | - | 20 | 取得件数(1〜50。50 を超える値は 50 として扱う) |
offset | number | - | 0 | オフセット(0 以上) |
リクエスト例
curl -H "Authorization: Bearer xrift_sk_xxx" \
"https://api.xrift.net/api/public/v1/events?from=2026-12-01T00:00:00Z&to=2026-12-31T23:59:59Z&limit=10"
レスポンス例
{
"data": [
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx::2026-12-02T13:00:00.000Z",
"seriesId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"kind": "scheduled",
"status": "upcoming",
"title": "VR 近況報告会",
"description": "2 週に 1 回の近況報告会です",
"thumbnailUrl": null,
"worldId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"currentUsers": 0,
"instanceId": null,
"startAt": "2026-12-02T13:00:00.000Z",
"endAt": "2026-12-02T14:00:00.000Z",
"repeatFrequency": "biweekly",
"owner": {
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"displayName": "sawa-zen",
"userIconUrl": "https://example.com/avatar.png"
},
"createdAt": "2026-10-01T00:00:00.000Z",
"updatedAt": "2026-10-01T00:00:00.000Z"
}
],
"pagination": {
"total": 139,
"limit": 10,
"offset": 0
}
}
- 繰り返しイベントの各回の
idは{シリーズの ID}::{その回の本来の開始日時}の形で、seriesIdにシリーズの ID が入ります。単発のイベントのidはそのままの ID で、seriesIdはありません worldには会場のワールドの情報が入ります(ワールドに公開中のバージョンが無い場合は省略)instanceは即席イベント(kind: instant)のときだけ、開催中のインスタンスの情報が入りますstatusは、取得した時点の時刻をもとにした実際の状態です
エラー
| ステータス | 条件 | レスポンス例 |
|---|---|---|
| 400 | from / to が未指定 | { "error": "from と to(表示範囲)は必須です(ISO 8601)" } |
| 400 | from / to が日時として不正 | { "error": "from は有効な日時(ISO 8601)を指定してください" } |
| 400 | from が to より後 | { "error": "from は to 以前を指定してください" } |
| 400 | 期間が 366 日を超える | { "error": "取得期間(from〜to)は366日以内で指定してください" } |
| 400 | kind / status / order が不正、ownerId が空文字 | 各パラメータのエラー |
| 400 | limit / offset が 10 進数の整数でない、または limit が 0 | { "error": "limit は 1 以上の整数を指定してください" } |
GET /events/:id
指定した ID のイベントの詳細を取得します。
- スコープ:
read:events
パスパラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
id | string | イベント ID。繰り返しの回の ID({シリーズの ID}::{日時})も指定できます |
繰り返しの回の ID を指定すると、その回の詳細(その回の日時と、その回だけに加えた変更)を返します。シリーズの ID を指定すると、シリーズ(初回の日時)を返します。
回の ID には : が含まれるため、URL エンコードしてから指定してください。
リクエスト例
# 単発イベント・シリーズ
curl -H "Authorization: Bearer xrift_sk_xxx" \
"https://api.xrift.net/api/public/v1/events/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
# 繰り返しの回(xxxxxxxx-...::2026-12-02T13:00:00.000Z を URL エンコード)
curl -H "Authorization: Bearer xrift_sk_xxx" \
"https://api.xrift.net/api/public/v1/events/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx%3A%3A2026-12-02T13%3A00%3A00.000Z"
レスポンス例
GET /events の各要素と同じ形を data で返します。
{
"data": {
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx::2026-12-02T13:00:00.000Z",
"seriesId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"title": "VR 近況報告会",
"startAt": "2026-12-02T13:00:00.000Z",
"endAt": "2026-12-02T14:00:00.000Z",
"repeatFrequency": "biweekly"
}
}
(一部のフィールドを省略しています)
エラー
| ステータス | 条件 | レスポンス |
|---|---|---|
| 404 | イベントが存在しない、取り消された回、シリーズに存在しない日時 | { "error": "Event not found" } |
GET /stats
プラットフォーム全体の統計情報を取得します。
- スコープ: なし(認証のみ必要、どの API キーでもアクセス可能)
リクエスト例
curl -H "Authorization: Bearer xrift_sk_xxx" \
"https://api.xrift.net/api/public/v1/stats"
レスポンス例
{
"data": {
"totalUsers": 15000,
"totalPublicWorlds": 3200,
"totalPublicInstances": 850
}
}
共通エラーレスポンス
全エンドポイント共通で返される可能性のあるエラーです。
| ステータス | 意味 | レスポンス例 |
|---|---|---|
| 401 | 認証ヘッダーが未指定 | { "error": "Authentication required" } |
| 401 | トークン形式が不正 | { "error": "Invalid token format" } |
| 401 | API キーが無効 | { "error": "Invalid API key" } |
| 401 | API キーが無効化済み | { "error": "API key is deactivated" } |
| 401 | API キーが期限切れ | { "error": "API key has expired" } |
| 401 | CLI トークンが無効 | { "error": "Invalid CLI token" } |
| 401 | CLI トークンが期限切れ | { "error": "CLI token has expired" } |
| 403 | スコープ不足 | { "error": "Insufficient scope. Required: read:worlds" } |
| 429 | レート制限超過 | { "error": "Rate limit exceeded" } |
レート制限
- 1 時間あたり 1,000 リクエスト(デフォルト)
- API キー認証のみ適用(CLI トークンは対象外)
- 固定ウィンドウ方式で計算されます
レスポンスヘッダーで現在の使用状況を確認できます(API キー認証時のみ付与)。
| ヘッダー | 説明 |
|---|---|
X-RateLimit-Limit | 上限 |
X-RateLimit-Remaining | 残り回数 |
X-RateLimit-Reset | リセット時刻(Unix timestamp) |
レート制限を超過すると 429 Too Many Requests が返されます。X-RateLimit-Reset ヘッダーの時刻まで待ってからリトライしてください。