Zugriff und Auswahl des Endpunkts
Verwenden Sie api.redditsearchapi.com als Host und den auf dieser Website ausgegebenen Schlüssel für authentifizierte Datenabrufe. Bewahren Sie die Zugangsdaten auf Ihrem Server auf und veröffentlichen Sie sie nicht in Links oder Browsercode. Schlüssel und Kontoguthaben gehören zu diesem Domainkonto und gelten nicht als gemeinsamer Zugang zu den anderen Websites des Netzwerks.
Mit /v1/search kombinieren Sie Suchfilter. /v1/posts und /v1/comments beschränken den Abruf auf Beiträge beziehungsweise Kommentare; beide benötigen keinen Parameter id. Für einen bestimmten Datensatz ist /v1/item mit id vorgesehen. Wählen Sie den Endpunkt nach der Aufgabe und setzen Sie nicht voraus, dass alle Routen sämtliche Suchparameter akzeptieren.
/v1/subreddits unterstützt prefix zur Suche nach Communitynamen. Der öffentliche Endpunkt /v1/status benötigt keinen Schlüssel und kostet kein Guthaben. Er liefert eine statische Beschreibung des historischen Dienstumfangs und zeigt, dass die HTTP-Anwendung antwortet. Er prüft weder die Suchmaschine noch Verfügbarkeit, Vollständigkeit oder Latenz des Archivs und ist kein Zustandsmonitor der Datenbank.
Filter und Struktur der Datensätze
Für Suchabfragen stehen q, subreddit, author, kind, from, to, min_score, limit und page zur Verfügung. kind verwendet die Werte post und comment. Datumsangaben erfolgen als YYYY-MM-DD in UTC; to ist einschließlich. Übersetzen Sie die Beschriftungen Ihrer Eingabefelder, lassen Sie aber die technischen Parameternamen und die übermittelten Werte unverändert.
limit erlaubt 1 bis 100 Datensätze je Anfrage, page 1 bis 100 Seiten je Abfrage. Ergebnisse folgen der internen Reihenfolge _doc, nicht einer zeitlichen Reihenfolge oder einer Sortierung nach Relevanz oder Punktzahl. min_score ist ausschließlich ein Filter. Eine beliebige Abfragesprache oder eine garantiert vollständige Massenausleitung wird nicht angeboten.
Die Antwort enthält flache Datensätze statt fertig aufgebauter Diskussionsbäume. Sind parent_id oder link_id vorhanden, können Sie diese lokal zum Gruppieren verwenden. Vollständige Elternketten oder Gesprächsverläufe sind damit nicht zugesichert. Diese Beziehungsfelder sind auch keine verfügbaren Suchfilter. Prüfen Sie die tatsächlich vorhandenen Felder, bevor Ihre Anwendung daraus Verknüpfungen und Ansichten ableitet.
Summen, Fehler und Verbrauch
Die Beziehung eq kennzeichnet eine exakte Summe für die Abfrage, gte eine Untergrenze und unknown das Fehlen einer verlässlichen Summe, gegebenenfalls mit einem Nullwert. Daraus lässt sich keine vollständige Archivabdeckung ableiten. Auch aggregierte Communityzahlen sind nicht als garantiert exakte globale Werte zu verstehen. Begrenzte Seitennavigation beweist ebenfalls keinen vollständigen Export.
400 bedeutet eine ungültige Anfrage, 401 einen fehlenden oder ungültigen Schlüssel, 402 unzureichendes Guthaben und 429 eine erreichte Ratenbegrenzung. Unterscheiden Sie diese Ursachen in Ihrer Fehlerbehandlung. Prüfen Sie Eingaben und Zugangsdaten vor weiteren Versuchen. Eine falsche Konfiguration wird nicht dadurch behoben, dass die Anwendung dieselbe Anfrage immer wieder ungeprüft sendet.
Ein erfolgreicher Datenabruf kostet einen Credit, auch ohne Treffer. Ungültige Anfragen werden nicht belastet; bei Fehlern des Suchanbieters wird die Reservierung zurückgegeben. Ein Verbindungsfehler beim Client kann allerdings nach einem erfolgreichen, berechneten Serverabruf auftreten. Ein erfolgreicher erneuter Versuch kostet erneut Guthaben. Begrenzen Sie Wiederholungen und erfassen Sie ihren Anlass für die spätere Diagnose.
