방송 목록 API
구현 상태: 예정
방송 목록 조회 및 필터링 API입니다.
Endpoint
GET /broadcasts
Header
Content-Type: application/json
X-API-Key: {API_KEY}
Query Parameter
| 필드 | 타입 | 필수 | 설명 |
|---|---|---|---|
category |
string | 선택 | 카테고리 필터 |
status |
string | 선택 | LIVE | READY | ENDED |
page |
number | 선택 | 기본값 1 |
pageSize |
number | 선택 | 기본값 20 |
keyword |
string | 선택 | 제목/닉네임 검색어 |
onlyOnAir |
boolean | 선택 | 기본값 false |
Request Example
curl -sS \
-H "X-API-Key: {API_KEY}" \
"{BASE_URL}/broadcasts?status=LIVE&page=1&pageSize=20"
Response (성공)
{
"success": true,
"data": {
"items": [
{
"broadcastId": "string",
"title": "string",
"category": "string",
"status": "LIVE",
"viewerCount": 152,
"thumbnailUrl": "string",
"broadcasterNickname": "string",
"broadcasterProfileImage": "string",
"donationEnabled": true,
"startedAt": "2026-03-17T10:00:00Z"
}
],
"page": 1,
"pageSize": 20,
"totalCount": 1,
"hasNext": false
}
}
공통 에러 코드
UNAUTHORIZED_API_KEYINVALID_PARAMETERINTERNAL_ERROR