文件

TwitterDown API v1

透過單一 POST /twitter 端點解析 Twitter/X 影片資源。所有回應皆為結構化 JSON,並附帶明確的限流標頭。

概覽

TwitterDown API 為開發者提供穩定的 Twitter/X 影片解析能力,適合自動化流程、媒體封存、內容營運與內部工具整合。

  • 基礎網址:https://twitterdown.com/api/v1
  • 驗證方式:Bearer Token(API Key)
  • 回應格式:application/json

驗證與安全

所有請求都必須在 Authorization 標頭中攜帶有效的 API Key。金鑰與帳號綁定,且可在控制台中隨時撤銷。

Authorization: Bearer sk-xxxxxxxxxxxxxxxxxxxx

API Key

  1. 登入 TwitterDown 並啟用支援 API 的方案。
  2. 打開 Dashboard > API Keys。
  3. 建立與應用程式或環境對應的 API Key 標籤。

API Key 只會顯示一次,請在離開頁面前存入安全的密鑰管理工具。

核心端點

POST /twitter

POST /twitter 用於解析公開 Tweet 連結,並回傳縮圖、影片清晰度、推文內容、使用者名稱與狀態 ID。

POST https://twitterdown.com/api/v1/twitter
Content-Type: application/json
Authorization: Bearer sk-xxxx

{
  "url": "https://x.com/username/status/1234567890123456789"
}

成功回應 (200):

{
  "code": 0,
  "message": "ok",
  "data": {
    "thumbnail": "https://pbs.twimg.com/...jpg",
    "videos": [
      { "resolution": "720p", "quality": "HD", "url": "https://video.twimg.com/..." },
      { "resolution": "360p", "quality": "SD", "url": "https://video.twimg.com/..." }
    ],
    "text": "Tweet text",
    "username": "username",
    "statusId": "1234567890123456789",
    "processed_at": "2024-01-01T12:00:00.000Z"
  }
}

GET /twitter

回傳端點中繼資料,適用於 SDK 初始化、整合檢查與運行狀態讀取。

速率限制

  • 60 請求 / 分鐘
  • 1,000 請求 / 小時
  • 10,000 請求 / 天

請讀取每次回應中的 X-RateLimit-Limit、X-RateLimit-Remaining 和 X-RateLimit-Reset。超出配額時,API 會回傳 HTTP 429 與 Retry-After。

錯誤處理

所有錯誤皆以 JSON 回傳,包含數字錯誤碼與可讀的錯誤訊息。

{
  "code": -1,
  "message": "Readable error message"
}
狀態說明
400Missing or malformed request payload
401Missing or invalid API key
403Plan does not allow the requested operation
422Tweet URL could not be resolved
429Rate limit exceeded
500Unexpected server-side failure

請求範例

以下範例可直接用於後端整合、自動化腳本與內部開發工具。

JavaScript (fetch)

const res = await fetch("https://twitterdown.com/api/v1/twitter", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer sk-xxxx"
  },
  body: JSON.stringify({ url })
});
const data = await res.json();

Python(requests)

resp = requests.post(
  "https://twitterdown.com/api/v1/twitter",
  headers={
    "Authorization": "Bearer sk-xxxx",
    "Content-Type": "application/json",
  },
  json={"url": tweet_url},
)
print(resp.json())

想看更多整合思路? 瀏覽部落格中的 API 指南 查看整合模式、發佈說明與工作流程範例。

API

下一步

從參考文件進入線上測試,或先建立 API Key,再把端點接到你的應用。