RoomScope

อัปเดตล่าสุด

อันดับ

บอร์ดอันดับทางการแยกตามบอร์ด ภูมิภาค และรอบ

ทุกการดำเนินการยืนยันตัวตนด้วย API key (Authorization: Bearer <key>) และข้อผิดพลาดใช้โครงสร้างร่วมที่อธิบายไว้ใน ข้อผิดพลาด. สร้างจากเอกสาร OpenAPI ของ API

แสดงรายการรอบที่ผ่านมาของบอร์ด

GET/v1/rankings/history

รอบที่จบแล้วของบอร์ดหนึ่ง เรียงจากใหม่ไปเก่า ภายในช่วงเวลาประวัติของแพ็กเกจ

สโคปrank:readเครดิตอ่านข้อมูลแคช

พารามิเตอร์ query

พารามิเตอร์ query · GET /v1/rankings/history
NameTypeDescription
boardRequired
stringคีย์ของบอร์ด: daily, hourly, popular_live, gaming_daily, gaming_weekly, shopping_daily, shopping_weekly (ต้องใช้ shop:read) หรือบอร์ดลีก league_a1 … league_d5
regionOptional
stringรหัสภูมิภาคตาม ISO 3166-1 alpha-2
Default: VN
cursorOptional
stringcursor แบบทึบจาก nextCursor ของหน้าก่อนหน้า
limitOptional
integerจำนวนรอบต่อหน้า ช่วง 1–24.
Default: 24
leagueTierOptional
stringตัวกรองระดับลีก A1 … D5

คำขอ

curl "https://api.toktokdata.live/v1/rankings/history?board=daily" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

ผลลัพธ์

200 OK
{  "data": {    "board": "daily",    "region": "VN",    "periods": [      {        "periodKey": "2026-10-31",        "observedAt": "2026-11-01T10:46:44.935Z",        "coverageStatus": "observed",        "publishable": true,        "entries": [          {            "rank": 1,            "creatorUid": "990000000000000001",            "uniqueId": "linh.live",            "nickname": "Linh Live",            "avatarUrl": null,            "isLive": false,            "roomId": null,            "score": 99000,            "leagueClass": null,            "leagueClassSource": null,            "leagueClassAsOf": null,            "movement": "same",            "previousRank": null,            "masked": false,            "unmaskTier": null          },          {            "rank": 2,            "creatorUid": "990000000000000102",            "uniqueId": "creator.02",            "nickname": "Creator 02",            "avatarUrl": null,            "isLive": false,            "roomId": null,            "score": 98000,            "leagueClass": null,            "leagueClassSource": null,            "leagueClassAsOf": null,            "movement": "same",            "previousRank": null,            "masked": false,            "unmaskTier": null          }        ]      }    ],    "nextCursor": null,    "hasMore": false,    "historyWindowDays": 365,    "historyTruncated": false  },  "provenance": {    "observedAt": "2026-11-01T10:46:44.935Z",    "freshness": "historical",    "source": "tiktok_observed_rank_board",    "sourceKind": "official",    "coverageStatus": "observed",    "methodologyVersion": "rankings-official-v1",    "window": null  }}

ข้อผิดพลาด

  • 400 พารามิเตอร์หรือ body ไม่ถูกต้อง code จะระบุปัญหา
  • 401 ไม่มี API key หรือไม่รู้จัก API key
  • 402 กระเป๋าเครดิตของเวิร์กสเปซมีไม่พอสำหรับการเรียกนี้ resetAt บอกเวลาที่เครดิตจะรีเซ็ต
  • 403 คีย์ไม่มีสโคปที่ต้องการ หรือแพ็กเกจไม่รวมฟีเจอร์นี้
  • 429 เกินอัตราคำขอ ให้ปฏิบัติตาม Retry-After

ดึงบอร์ดทางการ

GET/v1/rankings/official

บอร์ดหนึ่งของภูมิภาคหนึ่ง ตามที่ TikTok เผยแพร่ บอร์ดจะถูกจำลองก็ต่อเมื่อความครอบคลุมผ่านเกณฑ์แล้วเท่านั้น ให้อ่าน publishable และ coverage ก่อนแสดงรายการ รายการที่เกินกว่าที่แพ็กเกจแสดงชื่อได้จะยังคงมี rank และ score แต่จะส่งกลับมาพร้อม masked: true โดยไม่มีข้อมูลตัวตน และมี unmaskTier ที่ปลดล็อกการแสดงชื่อ ในรอบปัจจุบัน ทุกรายการจะมี sparkline คือคะแนนในแต่ละรอบจากเจ็ดรอบล่าสุดที่จบแล้ว เรียงจากเก่าไปใหม่ เป็น null ในรอบที่ไม่ได้อยู่บนบอร์ด

สโคปrank:readเครดิตอ่านข้อมูลแคช

พารามิเตอร์ query

พารามิเตอร์ query · GET /v1/rankings/official
NameTypeDescription
boardRequired
stringคีย์ของบอร์ด: daily, hourly, popular_live, gaming_daily, gaming_weekly, shopping_daily, shopping_weekly (ต้องใช้ shop:read) หรือบอร์ดลีก league_a1 … league_d5
regionOptional
stringรหัสภูมิภาคตาม ISO 3166-1 alpha-2
Default: VN
periodOptional
"current" | "history"current คือรอบที่กำลังดำเนินอยู่ history คือรอบล่าสุดที่จบแล้ว
Default: current
limitOptional
integerจำนวนรายการสูงสุด ช่วง 1–200.
Default: 200
liveOnlyOptional
"true" | "false"เฉพาะครีเอเตอร์ที่กำลังไลฟ์อยู่ขณะนี้
Default: false
leagueTierOptional
stringตัวกรองระดับลีก A1 … D5

คำขอ

curl "https://api.toktokdata.live/v1/rankings/official?board=daily" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

ผลลัพธ์

200 OK
{  "data": {    "board": {      "kind": "official",      "board": "daily",      "region": "VN",      "periodKey": "2026-10-31",      "resetAt": null,      "publishable": true,      "coverage": {        "completeBoards": 1,        "expectedBoards": 22,        "ratio": 0.045454545454545456,        "threshold": 0.8      },      "entries": [        {          "rank": 1,          "creatorUid": "990000000000000001",          "uniqueId": "linh.live",          "nickname": "Linh Live",          "avatarUrl": null,          "isLive": true,          "roomId": "7990000000000000001",          "score": 99000,          "leagueClass": null,          "leagueClassSource": null,          "leagueClassAsOf": null,          "movement": "new",          "previousRank": null,          "masked": false,          "unmaskTier": null,          "sparkline": [            null,            812000,            846500,            901200,            955000,            1010300,            99000          ]        },        {          "rank": 2,          "creatorUid": "990000000000000102",          "uniqueId": "creator.02",          "nickname": "Creator 02",          "avatarUrl": null,          "isLive": false,          "roomId": null,          "score": 98000,          "leagueClass": null,          "leagueClassSource": null,          "leagueClassAsOf": null,          "movement": "new",          "previousRank": null,          "masked": false,          "unmaskTier": null,          "sparkline": [            null,            803880,            838035,            892188,            945450,            1000197,            97020          ]        }      ]    }  },  "provenance": {    "observedAt": "2026-11-01T10:46:44.935Z",    "freshness": "historical",    "source": "tiktok_observed_rank_board",    "sourceKind": "official",    "coverageStatus": "observed",    "methodologyVersion": "rankings-official-v1",    "window": {      "from": null,      "to": null,      "label": "daily"    }  }}

ข้อผิดพลาด

  • 400 พารามิเตอร์หรือ body ไม่ถูกต้อง code จะระบุปัญหา
  • 401 ไม่มี API key หรือไม่รู้จัก API key
  • 402 กระเป๋าเครดิตของเวิร์กสเปซมีไม่พอสำหรับการเรียกนี้ resetAt บอกเวลาที่เครดิตจะรีเซ็ต
  • 403 คีย์ไม่มีสโคปที่ต้องการ หรือแพ็กเกจไม่รวมฟีเจอร์นี้
  • 429 เกินอัตราคำขอ ให้ปฏิบัติตาม Retry-After

แสดงรายการภูมิภาคที่ครอบคลุม

GET/v1/rankings/regions

ภูมิภาคที่ปัจจุบันมีบอร์ดที่บันทึกได้ พร้อมชื่อสำหรับแสดงผล ควรแคชไว้หนึ่งวัน

สโคปrank:readเครดิตอ่านข้อมูลแคช

คำขอ

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

ผลลัพธ์

200 OK
{  "data": {    "regions": [      {        "region": "VN",        "label": "VN · Vietnam",        "coverage": {          "completeBoards": 1,          "expectedBoards": 22,          "ratio": 0.045454545454545456,          "threshold": 0.8        },        "boards": [          "daily"        ],        "notOfferedBoards": []      }    ]  },  "provenance": {    "observedAt": "2026-11-01T10:46:44.935Z",    "freshness": "historical",    "source": "tiktok_observed_rank_board",    "sourceKind": "official",    "coverageStatus": "observed",    "methodologyVersion": "rankings-official-v1",    "window": null  }}

ข้อผิดพลาด

  • 400 พารามิเตอร์หรือ body ไม่ถูกต้อง code จะระบุปัญหา
  • 401 ไม่มี API key หรือไม่รู้จัก API key
  • 402 กระเป๋าเครดิตของเวิร์กสเปซมีไม่พอสำหรับการเรียกนี้ resetAt บอกเวลาที่เครดิตจะรีเซ็ต
  • 403 คีย์ไม่มีสโคปที่ต้องการ หรือแพ็กเกจไม่รวมฟีเจอร์นี้
  • 429 เกินอัตราคำขอ ให้ปฏิบัติตาม Retry-After
หน้านี้มีประโยชน์หรือไม่