Hivee 運営管理画面

エンドポイント

ベース URL は https://hivee.jp/api/v1 です。すべて GET で、応答の本文は { "data": ... } の形です。

イベント

GET/resolve

Hivee の URL を ID にする

パラメータ場所型説明
url必須クエリstringイベント(短縮 URL・?p= を含む)またはコミュニティの URL

応答の data: ResolvedUrl

curl "https://hivee.jp/api/v1/resolve?url=https%3A%2F%2Fhivee.jp%2Fevents%2Fbeesmash-48" \
  -H "Authorization: Bearer $HIVEE_API_KEY"
応答の例を見る
{
  "data": {
    "type": "event",
    "event_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
    "program_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07"
  }
}

GET/communities/{handle}/events

コミュニティのイベント一覧(開催日の新しい順)

パラメータ場所型説明
handle必須パスstringコミュニティ ID
limitクエリinteger1 ページの件数(1〜100、既定 50)
cursorクエリstring前の応答の next_cursor
statusクエリstringカンマ区切り(draft・private はキーのときだけ当たる)

応答の data: EventSummary[]

項目型説明
next_cursorstring | null次のページを取るときに cursor に渡す値。最後のページは null
curl "https://hivee.jp/api/v1/communities/beesmash/events" \
  -H "Authorization: Bearer $HIVEE_API_KEY"
応答の例を見る
{
  "data": [
    {
      "id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
      "url": "https://hivee.jp/events/beesmash-48",
      "title": "BeeSmash Weekly #48",
      "status": "published",
      "progress": "before",
      "starts_at": "2026-11-28T04:00:00Z",
      "ends_at": "2026-11-28T04:00:00Z",
      "venue_type": "offline",
      "venue": "HiveSquare 渋谷"
    }
  ],
  "next_cursor": "eyJvIjo1MH0"
}

GET/events/{id}

イベントとプログラム

パラメータ場所型説明
id必須パスuuidイベント ID

応答の data: Event

curl "https://hivee.jp/api/v1/events/<id>" \
  -H "Authorization: Bearer $HIVEE_API_KEY"
応答の例を見る
{
  "data": {
    "id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
    "url": "https://hivee.jp/events/beesmash-48",
    "title": "BeeSmash Weekly #48",
    "status": "published",
    "progress": "before",
    "starts_at": "2026-11-28T04:00:00Z",
    "ends_at": "2026-11-28T04:00:00Z",
    "venue_type": "offline",
    "venue": "HiveSquare 渋谷",
    "community": {
      "id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
      "handle": "beesmash",
      "name": "BeeSmash"
    },
    "programs": [
      {
        "id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
        "title": "本戦",
        "content": "string",
        "format": "double_elim",
        "entry_mode": "auto",
        "feeder": {
          "program_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
          "rank_from": 1,
          "rank_to": 1
        },
        "startgg_event_slug": "string",
        "pool_count": 1,
        "state": "running",
        "starts_at": "2026-11-28T04:00:00Z",
        "ends_at": "2026-11-28T04:00:00Z",
        "started_at": "2026-11-28T04:00:00Z",
        "ended_at": "2026-11-28T04:00:00Z"
      }
    ]
  }
}

GET/events/{id}/entrants

出場者

パラメータ場所型説明
id必須パスuuidイベント ID

応答の data: Entrant[]

curl "https://hivee.jp/api/v1/events/<id>/entrants" \
  -H "Authorization: Bearer $HIVEE_API_KEY"
応答の例を見る
{
  "data": [
    {
      "id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
      "display_name": "たぐ",
      "stream_name": "string",
      "is_team": false,
      "player": {
        "user_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
        "handle": "string"
      },
      "startgg_user_id": 1234567,
      "programs": [
        {
          "program_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
          "seed": 1,
          "disqualified": false
        }
      ]
    }
  ]
}

試合

GET/events/{id}/matches

試合

パラメータ場所型説明
id必須パスuuidイベント ID
programクエリuuidプログラム ID で絞る
stateクエリstringカンマ区切り(pending / ready / called / in_progress / completed)

応答の data: Match[]

curl "https://hivee.jp/api/v1/events/<id>/matches" \
  -H "Authorization: Bearer $HIVEE_API_KEY"
応答の例を見る
{
  "data": [
    {
      "id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
      "event_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
      "program_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
      "bracket": "winners",
      "round": 1,
      "round_label": "準決勝",
      "match_number": 1,
      "code": "W3-1",
      "pool": 1,
      "state": "in_progress",
      "slots": [
        {
          "participant_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
          "display_name": "string",
          "score": 1,
          "characters": [
            {
              "code": "mario",
              "color": 1
            }
          ]
        },
        {
          "participant_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
          "display_name": "string",
          "score": 1,
          "characters": [
            {
              "code": "mario",
              "color": 1
            }
          ]
        }
      ],
      "winner_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
      "dq": {
        "participant_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
        "both": false
      },
      "winner_to": {
        "match_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
        "seat": "a"
      },
      "loser_to": {
        "match_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
        "seat": "a"
      },
      "station_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
      "stream_url": "string",
      "called_at": "2026-11-28T04:00:00Z",
      "started_at": "2026-11-28T04:00:00Z",
      "ended_at": "2026-11-28T04:00:00Z"
    }
  ]
}

GET/matches/{id}

試合 1 件

パラメータ場所型説明
id必須パスuuid試合 ID

応答の data: Match

curl "https://hivee.jp/api/v1/matches/<id>" \
  -H "Authorization: Bearer $HIVEE_API_KEY"
応答の例を見る
{
  "data": {
    "id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
    "event_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
    "program_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
    "bracket": "winners",
    "round": 1,
    "round_label": "準決勝",
    "match_number": 1,
    "code": "W3-1",
    "pool": 1,
    "state": "in_progress",
    "slots": [
      {
        "participant_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
        "display_name": "string",
        "score": 1,
        "characters": [
          {
            "code": "mario",
            "color": 1
          }
        ]
      },
      {
        "participant_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
        "display_name": "string",
        "score": 1,
        "characters": [
          {
            "code": "mario",
            "color": 1
          }
        ]
      }
    ],
    "winner_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
    "dq": {
      "participant_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
      "both": false
    },
    "winner_to": {
      "match_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
      "seat": "a"
    },
    "loser_to": {
      "match_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
      "seat": "a"
    },
    "station_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
    "stream_url": "string",
    "called_at": "2026-11-28T04:00:00Z",
    "started_at": "2026-11-28T04:00:00Z",
    "ended_at": "2026-11-28T04:00:00Z"
  }
}

台・配信

GET/events/{id}/stations

台と進行中の試合

パラメータ場所型説明
id必須パスuuidイベント ID

応答の data: Station[]

curl "https://hivee.jp/api/v1/events/<id>/stations" \
  -H "Authorization: Bearer $HIVEE_API_KEY"
応答の例を見る
{
  "data": [
    {
      "id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
      "name": "1 台目",
      "type": "stream",
      "available": false,
      "description": "string",
      "current_match": null
    }
  ]
}

GET/events/{id}/stream-queue

配信中の試合と配信キュー

パラメータ場所型説明
id必須パスuuidイベント ID

応答の data: StreamQueue

curl "https://hivee.jp/api/v1/events/<id>/stream-queue" \
  -H "Authorization: Bearer $HIVEE_API_KEY"
応答の例を見る
{
  "data": {
    "stream_url": "string",
    "current_match": null,
    "queue": [
      {
        "position": 1,
        "match": {
          "id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
          "event_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
          "program_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
          "bracket": "winners",
          "round": 1,
          "round_label": "準決勝",
          "match_number": 1,
          "code": "W3-1",
          "pool": 1,
          "state": "in_progress",
          "slots": [
            {
              "participant_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
              "display_name": "string",
              "score": 1,
              "characters": [
                {
                  "code": "mario",
                  "color": 1
                }
              ]
            },
            {
              "participant_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
              "display_name": "string",
              "score": 1,
              "characters": [
                {
                  "code": "mario",
                  "color": 1
                }
              ]
            }
          ],
          "winner_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
          "dq": {
            "participant_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
            "both": false
          },
          "winner_to": {
            "match_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
            "seat": "a"
          },
          "loser_to": {
            "match_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
            "seat": "a"
          },
          "station_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
          "stream_url": "string",
          "called_at": "2026-11-28T04:00:00Z",
          "started_at": "2026-11-28T04:00:00Z",
          "ended_at": "2026-11-28T04:00:00Z"
        }
      }
    ]
  }
}

順位

GET/programs/{id}/standings

順位

パラメータ場所型説明
id必須パスuuidプログラム ID

応答の data: Standings

curl "https://hivee.jp/api/v1/programs/<id>/standings" \
  -H "Authorization: Bearer $HIVEE_API_KEY"
応答の例を見る
{
  "data": {
    "program_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
    "format": "string",
    "complete": false,
    "provisional": false,
    "combined": false,
    "phases": [
      {
        "program_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
        "title": "string"
      }
    ],
    "rows": [
      {
        "placement": 1,
        "participant_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07",
        "display_name": "string",
        "wins": 1,
        "losses": 1,
        "disqualified": false,
        "pool": 1,
        "source_program_id": "0b7c5a52-9d8e-4f1a-b3c6-2e4d8f9a1c07"
      }
    ]
  }
}
エンドポイント | Hivee 開発者向け