Przeglądaj dokumentację
Dokumentacja API
Zdobądź wyniki odpowiedzi, lub złożyć pracę i odzyskać je później. Wybierz sposób, w jaki aplikacja lub agent czeka na pracę.
Na tej stronie
Wybierz tryb żądania
Google Search i YouTube Data obsługują oba tryby. YouTube Download wymaga async, Batch lub Bulk; nie obsługuje realtime. Parametry źródłowe pozostają takie same przy przełączaniu się z czasu rzeczywistego na async.
| Tryb | Używanie | Co otrzymujesz |
|---|---|---|
| Realtime | W obecnej interakcji potrzebny jest wynik wyszukiwania. | HTTP w tej samej odpowiedzi. |
| Async | Prace powinny być kontynuowane po odłączeniu procesu lub pobieraniu mediów. | Zadania ID natychmiast; pobrać status i wyniki oddzielnie. |
Realtime POST data.flashdata.dev/v1/queries/realtime → wyniki
Async POST data.flashdata.dev/v1/queries → praca ID
GET api.flashdata.dev/v2/jobs/{id} → status
GET api.flashdata.dev/v2/jobs/{id}/results → wynikiWyślij wniosek
Ustaw FLASHDATA_API_KEY na klucz umożliwiający google_search. Wybierz realtime lub async; każdy wniosek uruchamia jedno billable search. Przechowuj skrypty, paragony i wyniki w tym samym nowym katalogu roboczym.
Przykłady Python używają Python 3.10 + i Requests. Każdy skrypt działa niezależnie i odczytuje zapisane pliki z wcześniejszych etapów. Alternatywne rozwiązanie cURL wymaga Bash, cURL 7.76 + i jq.
python3 -m pip install requestsRealtime: uzyskać wynik teraz
POST /v1/queries/realtime zwraca status: done i tablicę wyników. Przeczytaj result.json; nie ma potrzeby przeprowadzania sondaży.
Zapisz jako realtime.py i uruchom python3 realtime.py.
import json
import os
from pathlib import Path
import requests
response = requests.post(
"https://data.flashdata.dev/v1/queries/realtime",
headers={"X-API-Key": os.environ["FLASHDATA_API_KEY"]},
json={"source": "google_search", "query": "battery recycling research", "params": {"num": 5}},
timeout=120, allow_redirects=False,
)
response.raise_for_status()
result = response.json()
Path("result.json").write_text(json.dumps(result, indent=2), encoding="utf-8")
print(json.dumps(result, indent=2))curl --fail-with-body --silent --show-error \
'https://data.flashdata.dev/v1/queries/realtime' \
--header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
--header 'Content-Type: application/json' \
--data '{"source":"google_search","query":"battery recycling research","params":{"num":5}}' \
--output result.json &&
jq '{source, status, results, usage}' result.jsonAsync: zapisać pokwitowanie zadania
POST /v1/queries zwraca oczekiwany pokwitowanie zadania, a nie wyniki wyszukiwania. Zapisz submission.json i kontynuuj ze statusem i żądaniami wyników poniżej.
Zapisz jako submit_async.py i uruchom python3 submit_async.py.
import json
import os
from pathlib import Path
import requests
response = requests.post(
"https://data.flashdata.dev/v1/queries",
headers={"X-API-Key": os.environ["FLASHDATA_API_KEY"]},
json={"source": "google_search", "query": "battery recycling research", "params": {"num": 5}},
timeout=30, allow_redirects=False,
)
response.raise_for_status()
result = response.json()
Path("submission.json").write_text(json.dumps(result, indent=2), encoding="utf-8")
print(json.dumps(result, indent=2)){
"id": "job_EXAMPLE",
"source": "google_search",
"status": "pending"
}curl --fail-with-body --silent --show-error \
'https://data.flashdata.dev/v1/queries' \
--header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
--header 'Content-Type: application/json' \
--data '{"source":"google_search","query":"battery recycling research","params":{"num":5}}' \
--output submission.json &&
jq '{id, source, status, links}' submission.json{
"id": "job_EXAMPLE",
"source": "google_search",
"status": "pending"
}Sprawdź pracę async
Przeczytaj job.status używając ID w submission.json. W przypadku oczekujących lub przetwarzanych informacji przed ponownym sprawdzeniem należy poczekać na opóźnienie Retry-After; Python drukuje go, a cURL zapisuje w status-headers.txt. Użyj backupu, jeśli nie ma zwróconej podpowiedzi. Udany wniosek o status nie oznacza, że zadanie zostało zakończone.
| job.status | Następna akcja |
|---|---|
| pending / processing | Czekaj, sprawdź jeszcze raz tę samą pracę ID. |
| completed | Odzyskaj zapisany wynik. |
| failed | Przeczytaj job.error. Napraw sprawę przed przedłożeniem nowej pracy. |
Zapisz jako job_status.py i uruchom python3 job_status.py.
import json
import os
from pathlib import Path
import requests
job_id = json.loads(Path("submission.json").read_text(encoding="utf-8"))["id"]
response = requests.get(
f"https://api.flashdata.dev/v2/jobs/{job_id}",
headers={"X-API-Key": os.environ["FLASHDATA_API_KEY"]},
timeout=30, allow_redirects=False,
)
response.raise_for_status()
Path("job.json").write_text(json.dumps(response.json(), indent=2), encoding="utf-8")
print(json.dumps(response.json()["job"], indent=2))
print("Retry-After:", response.headers.get("Retry-After", "not provided"))JOB_ID=$(jq -er '.id' submission.json)
curl --fail-with-body --silent --show-error \
"https://api.flashdata.dev/v2/jobs/$JOB_ID" \
--header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
--dump-header status-headers.txt --output job.json &&
jq '.job | {id, source, status, error}' job.jsonPobieranie zakończonego wyniku
Uruchom to po zakończeniu job.status. Domyślna odpowiedź na wyniki to 302: Lokalizacja wskazuje na podpisana pamięć URL. Poniższe dwa żądania zachowują klucz API na FlashData i zapisują oryginalne JSON na result.json. Dla YouTube Download, ten JSON opisuje nośniki dostarczone do Państwa pamięci masowej; nie jest to plik wideo ani audio.
Zapisz jako job_result.py i uruchom python3 job_result.py.
import json
import os
from pathlib import Path
import requests
receipt = json.loads(Path("submission.json").read_text(encoding="utf-8"))
job_id = receipt["id"]
response = requests.get(
f"https://api.flashdata.dev/v2/jobs/{job_id}/results",
headers={"X-API-Key": os.environ["FLASHDATA_API_KEY"]},
timeout=30, allow_redirects=False,
)
response.raise_for_status()
if response.status_code != 302:
raise RuntimeError(f"Expected a result redirect, got {response.status_code}")
url = response.headers["Location"]
if not url.startswith("https://"):
raise ValueError("Expected an HTTPS storage URL")
# A separate request: no FlashData key is sent to storage.
result = requests.get(url, timeout=120)
result.raise_for_status()
data = result.json() # Requests automatically decodes Content-Encoding: gzip.
Path("result.json").write_text(json.dumps(data, indent=2), encoding="utf-8")
print(json.dumps(data, indent=2))JOB_ID=$(jq -er '.id' submission.json)
RESULT_URL=$(curl --fail-with-body --silent --show-error \
"https://api.flashdata.dev/v2/jobs/$JOB_ID/results" \
--header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
--output /dev/null --write-out '%{redirect_url}') &&
curl --fail-with-body --silent --show-error --compressed --proto '=https' \
"${RESULT_URL:?Expected a signed result URL}" --output result.json &&
jq '{source, status, results, usage}' result.jsonPostępowanie z opóźnieniami i niepowodzeniem
| Sytuacja | Co zrobić |
|---|---|
| Złożenie w wyznaczonym czasie | POST może już zostać zaakceptowany. Sprawdź zapisany rachunek i historię konta przed ponownym uruchomieniem; powtarzające się POST mogą tworzyć nowe zadania billable. |
| 409 · result_not_ready | Kontynuuj sondaże. Nie tworzyć innej pracy. |
| 422 · result_not_ready | Robota się nie powiodła. Przeczytaj job.error przed ponownym uruchomieniem. |
| 429 | Honor Retry-After lub retry_after; zmniejszyć szybkość składania danych, gdy ilość oczekujących jest pełna. |
| 410 · result_expired | Wyniki przechowywania wygasają 24 godziny po zakończeniu leczenia. Użyj zapisanej kopii. |