Перейти до вмісту
UK
Отримати ключ API
Переглянути документацію

Довідник API

YouTube розширений пошук API

Отримайте API-ключ

Вступ до 700 YouTube пошук результатів за запитом, з відео деталями, ескізами і пошуковими фільтрами.

Створити запит

Максимальна кількість результатів пошуку для повернення.

Додаткові параметри
Можливості
POSThttps://data.flashdata.dev/v1/queries/realtime
Python 3 · requests
python3 -m pip install requests
import json

import requests

api_key = "YOUR_API_KEY"
payload = {
    "source": "youtube_search_extended",
    "query": "python",
    "params": {
        "max_results": 20,
    },
}

response = requests.post(
    "https://data.flashdata.dev/v1/queries/realtime",
    headers={"X-API-Key": api_key, "Accept": "application/json"},
    json=payload,
    timeout=120,
)
response.raise_for_status()
print(json.dumps(response.json(), ensure_ascii=False, indent=2))
Результати у відповідь HTTPавтентифікації X-API-Key

Параметри

Відправити source і query на рівні вершини. Параметри джерела відносяться до params. Додаткові поля можуть бути використані.

Тіло запиту

sourcestring / Обов’язково
Набір до youtube_search_extended.
querystring / Обов’язково
Пошук запитів.
1 до 2 000 ЗіркиЗа замовчуванням: Не встановити
paramsobject / Необов’язково
Settings для цього запиту.
За замовчуванням: {}
callback_urlstring · nullable / Необов’язково
Async і партії тільки. Public HTTPS завершена URL на порту 443, до 2,048 символів. Немає облікових даних користувача або фрагмента URL. Omit, використовуйте null або порожній рядок для повідомлення. У партії, встановивши це на кожному запиту, за межами парам.
За замовчуванням: Не встановити

Кількість результатів

params.max_resultsinteger / Необов’язково
Заявка на результат. Результати розіграшу можуть бути доступні.
1 до 700, цілі номериЗа замовчуванням: 20

Фільтри для пошуку

params.filtersobject · nullable / Необов’язково
Додаткова дата завантаження, тип результату, тривалість, сортування та функція фільтрів. Omit або використовувати null для нефільтрів.
За замовчуванням: Не встановити
params.filters.upload_datestring / Необов’язково
Фільтр за датою завантаження.
1 до 2 000 ЗіркиВартість: today / last_hour / this_week / this_month / this_yearЗа замовчуванням: Не встановити
params.filters.typestring / Необов’язково
Фільтр за типом результату.
1 до 2 000 ЗіркиВартість: video / channel / playlist / movieЗа замовчуванням: Не встановити
params.filters.durationstring / Необов’язково
Фільтрувати тривалість відео за хвилину.
1 до 2 000 ЗіркиВартість: <4 / 4-20 / >20За замовчуванням: Не встановити
params.filters.sort_bystring / Необов’язково
Замовити замовлення Використовуйте YouTube за замовчуванням.
1 до 2 000 ЗіркиВартість: rating / relevance / view_count / upload_dateЗа замовчуванням: Не встановити
params.filters.360boolean / Необов’язково
Набір true для потреб функції 360.
true або falseЗа замовчуванням: Не встановити
params.filters.3dboolean / Необов’язково
Налаштуйте true для того, щоб скористатися функцією 3d.
true або falseЗа замовчуванням: Не встановити
params.filters.4kboolean / Необов’язково
Налаштуйте true для того, щоб забезпечити функцію 4k.
true або falseЗа замовчуванням: Не встановити
params.filters.creative_commonsboolean / Необов’язково
Налаштуйте true для того, щоб забезпечити творчий характер.
true або falseЗа замовчуванням: Не встановити
params.filters.hdboolean / Необов’язково
Набір true для того, щоб забезпечити функцію hd.
true або falseЗа замовчуванням: Не встановити
params.filters.hdrboolean / Необов’язково
Набір true для того, щоб забезпечити функцію hdr.
true або falseЗа замовчуванням: Не встановити
params.filters.liveboolean / Необов’язково
Налаштуйте true для того, щоб забезпечити функцію життя.
true або falseЗа замовчуванням: Не встановити
params.filters.locationboolean / Необов’язково
Налаштуйте true для того, щоб скористатися функцією розташування.
true або falseЗа замовчуванням: Не встановити
params.filters.purchasedboolean / Необов’язково
Налаштуйте true для того, щоб забезпечити придбану функцію.
true або falseЗа замовчуванням: Не встановити
params.filters.subtitlesboolean / Необов’язково
Виберіть true для того, щоб забезпечити функцію субтитри.
true або falseЗа замовчуванням: Не встановити
params.filters.vr180boolean / Необов’язково
Набір true для потреб функції vr180.
true або falseЗа замовчуванням: Не встановити

Відповідь

Realtime повертається status: done. Читати вихід джерела на results[0].results; usage.credits облік заряду.

Пошукова робота містить запит, totalResults і повернуті елементи. totalResults підрахунок елементів цієї відповіді; це не загальна кількість відповідних відео YouTube.

Читати результат

Збережіть успішну відповідь JSON як response.json. Збережіть це як read-response.py і запустіть python read-response.py. Використовуються тільки Python- стандартна бібліотека і не дає нового запиту.

read-response.py
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 = [
    {"videoId": item.get("videoId"), "title": item.get("title"), "channel": item.get("channel")}
    for item in result.get("results", [])
]
print(json.dumps(output, ensure_ascii=False, indent=2))

max_results за замовчуванням до 20 і приймає 1 до 700. Це один більший запит пошуку, не 700 окремі партії робочих місць. Більші запити можуть зайняти довше, асинхронізуйте, зберігаючи зв'язок відправника.

Фільтри відносяться до params.filters. Результати роботи можуть бути доступні, а багаті поля для пунктів можуть бути null або відсутні. Розширений пошук має власний рівень використання.

Усі поля відповіді
ПолеОпис
sourcestringЗа запитом джерело API.
statusstringв режимі реального часу, якщо в реальному часі буде досягнуто запит.
created_atstringЧас створення відповіді в форматі ISO 8601.
usage.creditsnumberКредит, що стягується за запит, виходячи з тарифного плану.
results[0].querystringПошук запиту.
results[0].totalResultsintegerКількість результатів повернуто.
results[0].resultsarrayПошук результатів у повернуті замовлення.
results[0].results[].videoIdstringYouTube відео ID.
results[0].results[].titlestringНазва відео.
results[0].results[].channelstringНазва каналу.
results[0].results[].channelIdstring · nullableКанал ID при наявності.
results[0].results[].channelUrlstring · nullableКанал URL при наявності.
results[0].results[].durationnumber · nullableтривалість відео за секундами.
results[0].results[].durationStringstring · nullableФорматовано тривалість відео при наявності.
results[0].results[].viewCountnumber · nullableПереглядайте кількість, коли це можливо.
results[0].results[].uploadDatestring · nullableДата завантаження при наявності.
results[0].results[].descriptionstring · nullableОпис викрутки, до 500 символів, або null при наявності.
results[0].results[].thumbnailsarrayThumbnail URLs і розміри.

На полях описано типову відповідь JSON. JSON, звичайний текст і Markdown формати.

Async повертає одне надходження в роботу; повернення пакету на одну за кішка. Перевірити статус кожного завдання і отримати його результати за допомогою повернутих посилань.

Async & пакетний життєвий цикл

Подача повертається квитанції, не результати. Async створює одну роботу; пакет повертає окрему роботу в queries[] для кожного прийнятого запиту. Відстежуйте та отримайте кожну роботу самостійно.

Подати data.flashdata.dev; читати статус роботи та результати з api.flashdata.dev з тим же X-API-Key. Приклади базових прикладів API використовують Python і cURL.

  1. 1. Заощаджуйте роботу IDs

    Зберігати поля запиту джерела при переході на Async. Для Batch викласти кожен запит у масив запитів об'єкта JSON. Заощаджуйте кожну подану роботу ID.

    Async запит та отримання · Batch запит тіла

  2. 2. Статус на сервери

    GET https://api.flashdata.dev/v2/jobs/{jobId}

    pending / processing: опитування з затримкою та повагою Retry-After присутні. completed: результати fetch. failed: огляд job.error.

    Читать job.status, не статус отримання інформації.

    Перевірити статус · Python і cURL

    Статус на сервери API посилання
  3. 3. Результати Фетт

    GET https://api.flashdata.dev/v2/jobs/{jobId}/results

    Після завершення перевірте результат читати, після чого викинути 302 пам'ять URL без ключа API. Заощаджуйте JSON в межах 24 годин завершення.

    Результати розрахунків · Python і cURL · Формати відповідей

    Завантажити API

Половлення та вилучення існуючих результатів не споживають кредитні запити. Час вилучення не скасовує роботу: зберігайте ID замість подання дублікатів, які запроваджують роботу. Коди помилок та поведінка птиця.

Вебхуки завершення

Підписатися на запит

Комплекти callback_url на рівні асинхронного запиту, або всередині кожного запиту в партії, поза params. Не потрібно окремий запит на веб-візію. Realtime не надсилайте зворотні дзвінки.

Використовуйте публічний HTTPS URL на порту 443. FlashData POSTS повідомлення для кожного досягнення роботи completed або failed; подія містить посилання, не сам результат.

Acknowledge і перевірка

Повернутися 2xx після того, як багато хто приймає захід. Дублікат delivery_id, також відправлений як X-Delivery-Id. Не слідувати перенаправлення.

В'язані поставки птиця з експоненціальним відключенням, до 8 намагатися всього і в більшості 24 годин після завершення. Зберігайте опитування як падлогу.

Відкликання не відмічаються. Підтвердіть роботу ID, джерело та статус терміналу через автентифікована кінцева точка стану перед обробкою повідомлення. Доставка ID призначена для дедупації, не вистосування автентичності.

Приклад подій та полів вебхока
Ілюстрація повідомлення про завершення
{
  "delivery_id": "completion:job_example0001",
  "id": "job_example0001",
  "source": "youtube_search_extended",
  "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завершено або не вдалося.
linksarrayСтатус і посилання на результат. Повідомлення не включають вміст результатів або ключ API.
links[].relstringсамо або результати.
links[].hrefstringАбсолютний менеджмент API URL; автентичний з ключем API.
links[].methodstringGET.

Повна угода вебхока та обмеження URL

Відновлення пароля

Якщо ви не знаєте, що час запиту в режимі реального часу, прийняття може бути неоднозначним. Перевірити історію роботи перед переадресацією. Для подальших великих пошуків виберіть асим і відстежуйте повернутий ID.

Для автентифікації, балансу, запиту та обмеження, використовуйте посилання на спільну помилку. Термін подачі може бути ще створено роботу; перевірити існуючу роботу перед спрацьовуванням.

Помилки й коди стану · Коли птиця · Обмеження ставок

Покроковий посібник: Планування пошуку більшого кандидата

Ціни

Поточні ціни та ліміти плану