浏览文档
API 参考文档
YouTube 频道 API
通过标识名获取 YouTube 频道资料及近期视频,包括订阅者数量、频道图片和视频详情。
构建请求
填写频道标识,例如 @youtube,不要填写频道网址。
https://data.flashdata.dev/v1/queries/realtime参数
发送 source 和 handle 放在顶层。 数据源选项应放在 params. 可选字段可以省略。
请求体
sourcestring / 必填- 设为 youtube_channel。
handlestring / 必填- 频道账号句柄,例如 @jawed。@ 前缀为可选项。1 设为 100 个字符默认值:
未设置 paramsobject / 可选- 此请求的设置。默认值:
{} callback_urlstring · nullable / 可选- 仅支持异步和批量请求。完成通知 URL 必须是使用 443 端口的公开 HTTPS 地址,最多 2,048 个字符。不得包含用户凭证或 URL 片段。省略、设为 null 或空字符串时不发送通知。批量请求中,需在每个查询上设置此字段,不要放在 params 内部。默认值:
未设置
视频选择
params.video_limitinteger / 可选- 最多包含的视频数量。可用数量可能更少。1 设为 100,整数默认值:
20
响应
实时请求返回 status: done。在以下位置读取数据源输出: results[0].videos; usage.credits 记录费用。
频道资料位于 results[0];其 videos 数组包含近期视频。videoCount 描述的是频道的视频数量,而非返回数组的长度。
读取结果
将成功响应的 JSON 保存为 response.json。将以下代码保存为 read-response.py,再运行 python read-response.py。仅使用 Python 标准库,不发起新请求。
import json
from pathlib import Path
response = json.loads(Path("response.json").read_text(encoding="utf-8-sig"))
if response.get("status") not in ("done", "completed") or not isinstance(response.get("results"), list):
raise SystemExit("Expected completed result JSON; inspect the response or job status.")
if not response["results"]:
print("[]")
raise SystemExit(0)
result = response["results"][0]
output = {
"channelId": result.get("channelId"),
"name": result.get("name"),
"videos": [
{"videoId": item.get("videoId"), "title": item.get("title")}
for item in result.get("videos", [])
],
}
print(json.dumps(output, ensure_ascii=False, indent=2))在顶层发送 handle,可带或不带 @ 前缀。video_limit 应放在 params 中,取值范围为 1 至 100,默认为 20。示例请求 10 条。
请求的数量限制是上限,并非保证值。计数、图片 URL 和各视频详情在不可用时可能为 null。
所有响应字段
| 字段 | 描述 |
|---|---|
sourcestring | 请求的 API 数据源。 |
statusstring | 实时请求成功时为 done。 |
created_atstring | 响应创建时间,采用 ISO 8601 格式。 |
usage.creditsnumber | 根据你的套餐,此请求扣除的积分。 |
results[0].channelIdstring | 频道 ID。 |
results[0].channelHandlestring | 频道账号句柄。 |
results[0].namestring | 频道名称。 |
results[0].descriptionstring | 频道描述。 |
results[0].subscriberCountnumber · nullable | 订阅者数量。 |
results[0].videoCountnumber · nullable | 频道视频总数。 |
results[0].viewCountnumber · nullable | 频道观看次数(如有)。 |
results[0].avatarUrlstring · nullable | 频道头像 URL。 |
results[0].bannerUrlstring · nullable | 频道横幅 URL。 |
results[0].channelUrlstring | 频道页面 URL。 |
results[0].videosarray | 近期视频,最多 video_limit 条。 |
results[0].videos[].videoIdstring | 视频 ID。 |
results[0].videos[].titlestring | 视频标题。 |
results[0].videos[].durationnumber · nullable | 时长,以秒为单位。 |
results[0].videos[].viewCountnumber · nullable | 观看次数。 |
results[0].videos[].uploadDatestring · nullable | 上传日期。 |
results[0].videos[].thumbnailstring · nullable | 视频缩略图 URL。 |
以上字段对应默认 JSON 响应。JSON、纯文本与 Markdown 格式。
异步请求返回一个任务回执;批量请求则为每个以下条目返回一个回执: 频道 handle。使用返回的链接分别查看每个任务的状态并获取结果。
异步与批量请求生命周期
提交后返回的是回执,而非结果。异步请求创建一个任务;批量请求会在以下字段中为各项返回独立任务: queries[] ,对应每个已接受的查询。请分别跟踪和获取每个任务。
提交到 data.flashdata.dev;从 api.flashdata.dev 读取任务状态与结果,两者使用同一 X-API-Key。以下 API 基础链接提供 Python 与 cURL 示例。
1. 保存任务 ID
切换 Async 时保留该来源的请求字段。使用 Batch 时,将各请求放入 JSON 对象的 queries 数组。保存每个返回的任务 ID。
2. 检查状态
GET https://api.flashdata.dev/v2/jobs/{jobId}pending/processing:轮询时加入延迟,并遵循Retry-After(如有)。completed:获取结果。failed:检查job.error.读取 job.status,而非提交回执的 status。
任务状态 API 参考文档3. 获取结果
GET https://api.flashdata.dev/v2/jobs/{jobId}/results完成后先认证读取结果地址,再获取 302 存储 URL,不附带 API Key。在完成后的 24 小时内保存 JSON。
结果下载 API 参考文档
轮询和获取现有结果不会消耗查询积分。轮询超时不会取消任务:请保留任务 ID,避免重复提交会产生费用的任务。 错误代码与重试行为.
完成通知 Webhook
按查询订阅
设置 callback_url 放在异步请求的顶层,或 在每个查询内部 放在批量请求中,不要放在以下字段内部: params。无需单独发送 Webhook 注册请求。 实时请求不会发送回调。
使用端口为 443 的公开 HTTPS URL。每个任务达到以下状态时,FlashData 都会通过 POST 发送通知: completed 或 failed;事件包含的是链接,而不是结果本身。
确认接收并验证
返回 2xx ,确保先持久化接收事件。使用以下字段去重: delivery_id,也以以下形式发送: X-Delivery-Id。不会跟随重定向。
投递失败后使用指数退避重试,最多 总共 8 次尝试 ,且最多为 完成后 24 小时。请保留轮询作为备用方式。
回调不带签名。 通过以下接口确认任务 ID、数据源和终态: 需要身份验证的状态端点 ,再处理通知。交付 ID 用于去重,不能作为真实性证明。
Webhook 事件与字段示例
{
"delivery_id": "completion:job_example0001",
"id": "job_example0001",
"source": "youtube_channel",
"status": "completed",
"links": [
{
"rel": "self",
"href": "https://api.flashdata.dev/v2/jobs/job_example0001",
"method": "GET"
},
{
"rel": "results",
"href": "https://api.flashdata.dev/v2/jobs/job_example0001/results",
"method": "GET"
}
]
}| 字段 | 描述 |
|---|---|
delivery_idstring | 稳定的投递标识符。使用此值对通知去重;X-Delivery-Id 请求头也会携带此值。 |
idstring | 任务 ID。 |
sourcestring | 请求的数据源。 |
statusstring | completed 或 failed。 |
linksarray | 状态和结果链接。通知不包含结果内容或 API 密钥。 |
links[].relstring | self 或 results。 |
links[].hrefstring | Management API 的绝对 URL;使用你的 API 密钥进行身份验证。 |
links[].methodstring | GET. |
错误恢复
请使用频道 handle,而非视频 ID 或完整频道 URL。即使 handle 通过输入验证,已删除或无法访问的频道仍可能导致请求失败。缺少图片或计数本身并不意味着失败。
认证、余额、请求格式及限流错误的处理方法见 API 基础。提交超时可能已创建任务,重试前先检查已有任务。
分步指南:使用频道及其近期视频
价格
| 套餐 | 用量费率每 1,000 次标准请求 | 订阅 | 每个计费周期包含的积分 |
|---|---|---|---|
| 按量付费 | US$0.50 | 无月费 | 按需充值 |
| Micro | US$0.40 | US$49.00 / 月 | 包含 1,000 积分(相当于 US$50.00 的 API 用量) |
| Starter | US$0.35 | US$199.00 / 月 | 包含 4,000 积分(相当于 US$200.00 的 API 用量) |
| Pro | US$0.30 | US$499.00 / 月 | 包含 10,000 积分(相当于 US$500.00 的 API 用量) |
| Scale | US$0.25 | US$999.00 / 月 | 包含 20,000 积分(相当于 US$1,000.00 的 API 用量) |
| Business | US$0.20 | US$1,999.00 / 月 | 包含 40,000 积分(相当于 US$2,000.00 的 API 用量) |
一个账户套餐,三种产品共用积分。由套餐内积分覆盖的用量不会重复收费。
当前价格与套餐限额