RoomScope

최종 업데이트

계정

key가 속한 워크스페이스의 요금제, 한도, 크레딧 사용량.

모든 작업은 API key로 인증하며 (Authorization: Bearer <key>) 오류 응답은 다음 문서에서 설명하는 공통 오류 형식을 따릅니다: 오류. 이 페이지는 API의 OpenAPI 문서에서 생성되었습니다.

요금제와 한도 조회

GET/v1/entitlements

결제 기간의 워크스페이스 요금제, 모듈, 속도 제한, 크레딧 지갑: limits.watchlistMax, credits.resetAt(해당 기간의 크레딧이 초기화되는 시점), exports(현재는 앱 내 내보내기, 일일 한도가 적용되지 않는 동안 perDay는 null), money(추정 총액 기준 다이아몬드 1개의 USD 가치, 크리에이터 몫, 월간 VND 환율: 표시용 추정치이며 TikTok의 실제 지급액이 아닙니다).

스코프keys:manage크레딧무료

쿼리 파라미터

쿼리 파라미터 · GET /v1/entitlements
NameTypeDescription
periodOptional
string결제 기간 시작일, YYYY-MM-01. 기본값은 현재 기간입니다.

요청

curl "https://api.toktokdata.live/v1/entitlements" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

응답

200 OK
{  "data": {    "workspaceId": "4388fdb0-ef68-5d01-ac84-b683b2b355e8",    "planCode": "agency",    "tier": "agency",    "modules": [      "live",      "lookup"    ],    "limits": {      "requestsPerWindow": 150,      "rateWindowMs": 1000,      "apiRequestsPerSecond": 150,      "requestsPerDay": 1200000,      "maxApiKeys": 0,      "wsConcurrencyCap": 200,      "maxRoomMinutesPerMonth": 800000,      "historyWindowDays": 365,      "maxSeats": 10,      "seatsUsed": 2,      "exportFormats": [        "csv",        "xlsx"      ],      "watchlistMax": 25    },    "credits": {      "period": "2026-11-01",      "monthlyAllotment": 36000000,      "hardCap": 36000000,      "spent": 0,      "remaining": 0,      "resetAt": "2026-12-01T00:00:00.000Z"    },    "money": {      "diamondUsdGross": 0.01,      "creatorShare": 0.5,      "vndPerUsd": 25500,      "rateLabel": "estimate · 2026-11"    },    "exports": {      "perDay": null,      "usedToday": 1    }  },  "provenance": {    "observedAt": "2026-11-01T11:19:24.411834Z",    "freshness": "near_realtime",    "source": "plan_entitlement",    "sourceKind": "derived",    "coverageStatus": "observed",    "methodologyVersion": "entitlements-v1",    "window": {      "from": "2026-11-01",      "to": "2026-12-01",      "label": "2026-11"    }  }}

오류

  • 400 파라미터 또는 본문이 잘못되었습니다. code에 문제가 표시됩니다.
  • 401 API key가 없거나 알 수 없는 key입니다.
  • 403 key에 필요한 스코프가 없거나, 요금제에 해당 기능이 포함되어 있지 않습니다.
  • 429 요청 속도를 초과했습니다. Retry-After를 따르세요.

크레딧 사용량 조회

GET/v1/usage

결제 기간의 작업별 크레딧 사용량.

스코프keys:manage크레딧무료

쿼리 파라미터

쿼리 파라미터 · GET /v1/usage
NameTypeDescription
periodOptional
string결제 기간 시작일, YYYY-MM-01. 기본값은 현재 기간입니다.
limitOptional
integer최대 행 수.

요청

curl "https://api.toktokdata.live/v1/usage" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

응답

200 OK
{  "period": "2026-11-01",  "balance": {    "remaining": 0,    "spent": 0  },  "items": [],  "provenance": {    "observedAt": "2026-11-01T10:00:00.000Z",    "freshness": "near_realtime",    "source": "credit_ledger",    "sourceKind": "derived",    "coverageStatus": "observed",    "methodologyVersion": "usage-v1",    "window": {      "from": "2026-11-01",      "to": "2026-12-01",      "label": "2026-11"    }  }}

오류

  • 400 파라미터 또는 본문이 잘못되었습니다. code에 문제가 표시됩니다.
  • 401 API key가 없거나 알 수 없는 key입니다.
  • 403 key에 필요한 스코프가 없거나, 요금제에 해당 기능이 포함되어 있지 않습니다.
  • 429 요청 속도를 초과했습니다. Retry-After를 따르세요.
이 페이지가 도움이 되었나요?