API-Referenz

Basis-URL https://api.xsignalfeed.com. Alle Antworten sind JSON, im Fehlerfall im unter Fehler beschriebenen Umschlag, und tragen im Erfolgsfall die unter Ratenlimits aufgeführten Header. Mit * markierte Felder sind Pflicht.

Überwachung

Wählen Sie, welchen Konten dieser Schlüssel folgt. Für jedes erhalten Sie alle Ereignistypen, die Ihr Schlüssel erlaubt, oder nur die gewählten.

EndpunktNameScopeGuthaben
GET /v1/monitor/targetsÜberwachte Konten auflistentargets:read0
POST /v1/monitor/targetsEin Konto überwachentargets:write0
GET /v1/monitor/targets/{target}Überwachtes Konto abrufentargets:read0
PATCH /v1/monitor/targets/{target}Ereignistypen eines Kontos wählentargets:write0
DELETE /v1/monitor/targets/{target}Überwachung eines Kontos beendentargets:write0
POST /v1/monitor/targets:batchÜberwachungsoperationen im Batch ausführentargets:write0

Stichwörter

Beobachten Sie die X-Suche nach Phrasen. Die Suchanfrage akzeptiert die eigene Syntax von X: exakte Phrasen in Anführungszeichen, OR, -exclusions, #hashtags, $cashtags, from:, to:, lang:, filter:media, -filter:replies, -filter:retweets. Wir beobachten den Tab „Neueste“, die Ergebnisse sind also chronologisch, und jede Sprache oder Schrift funktioniert.

EndpunktNameScopeGuthaben
GET /v1/keywordsStichwörter auflistenkeywords:read0
POST /v1/keywordsEin Stichwort beobachtenkeywords:write0
DELETE /v1/keywords/{keyword_id}Ein Stichwort entfernenkeywords:write0

Stream & Historie

Der WebSocket ist unter Streaming beschrieben; dies ist sein REST-Gegenstück zum Aufholen.

EndpunktNameScopeGuthaben
GET /v1/eventsEreignisverlaufreplay0

Nutzer

Profile, Folgt-Listen, Medien, Erwähnungen, Abonnements und Nutzersuche, jetzt von X gelesen. Jeder Aufruf kostet das angegebene Guthaben.

EndpunktNameScopeGuthaben
GET /v1/users/{screen_name}Nutzer per Nutzernamen abrufenreads1
GET /v1/users/by-id/{user_id}Nutzer per ID abrufenreads1
GET /v1/users/batchMehrere Nutzer per ID abrufenreads1 per id
GET /v1/users/{screen_name}/aboutKontodetails abrufenreads1
GET /v1/users/{screen_name}/tweetsBeiträge eines Nutzers abrufenreads2
GET /v1/users/{screen_name}/mediaMedien eines Nutzers abrufenreads2
GET /v1/users/{screen_name}/mentionsErwähnungen eines Nutzers abrufenreads2
GET /v1/users/{screen_name}/followingGefolgte Konten abrufenreads2
GET /v1/users/{screen_name}/followersFollower abrufenreads2
GET /v1/users/{screen_name}/verified_followersVerifizierte Follower abrufenreads2
GET /v1/users/{screen_name}/subscriptionsAbonnements abrufenreads2
GET /v1/users/searchNutzer suchenreads2
GET /v1/users/{screen_name}/relationship/{other_screen_name}Folgebeziehung prüfenreads1

Tweets

Beiträge per ID, mit ihren Antworten, Zitaten, Repostern, Thread und Artikel. Jeder Aufruf kostet das angegebene Guthaben.

EndpunktNameScopeGuthaben
GET /v1/tweets/{tweet_id}Einen Beitrag abrufenreads1
GET /v1/tweetsMehrere Beiträge per ID abrufenreads1
GET /v1/tweets/{tweet_id}/repliesAntworten abrufenreads2
GET /v1/tweets/{tweet_id}/quotesZitate abrufenreads2
GET /v1/tweets/{tweet_id}/retweetersReposter abrufenreads2
GET /v1/tweets/{tweet_id}/threadEinen Thread abrufenreads2
GET /v1/tweets/{tweet_id}/articleEinen Artikel abrufenreads1

Die X-Suche in ihrer eigenen Syntax, neueste oder Top-Ergebnisse, seitenweise.

EndpunktNameScopeGuthaben
GET /v1/searchBeiträge suchenreads2
GET /v1/search/trendsEinen Trend durchsuchenreads2

Listen

Timeline und Mitglieder jeder öffentlichen Liste.

EndpunktNameScopeGuthaben
GET /v1/lists/{list_id}/tweetsBeiträge einer Liste abrufenreads2
GET /v1/lists/{list_id}/membersMitglieder einer Liste abrufenreads2

Communities

Informationen, Mitglieder, Moderatoren und Beiträge einer X-Community.

EndpunktNameScopeGuthaben
GET /v1/communities/{community_id}Eine Community abrufenreads1
GET /v1/communities/{community_id}/membersMitglieder einer Community abrufenreads2
GET /v1/communities/{community_id}/moderatorsModeratoren einer Community abrufenreads2
GET /v1/communities/{community_id}/tweetsBeiträge einer Community abrufenreads2

Was gerade auf X im Trend liegt, nach Kategorie.

EndpunktNameScopeGuthaben
GET /v1/trendsTrends abrufenreads2

Konto

Was dieser Schlüssel darf, wie viel er verbraucht hat, wohin Webhooks gehen.

EndpunktNameScopeGuthaben
GET /v1/accountKonto abrufen—0
GET /v1/account/usageVerbrauch abrufen—0
GET /v1/account/webhookWebhook abrufenwebhook0
PUT /v1/account/webhookWebhook setzenwebhook0

Meta & Status

Öffentlich, fünf Minuten lang gecacht, kein Schlüssel nötig. Bauen Sie Ihre Validierung und Ihre Oberfläche darauf auf, statt diese Seite abzuschreiben.

EndpunktNameScopeGuthaben
GET /v1/meta/event-typesEreignistypen auflisten—0
GET /v1/meta/scopesScopes auflisten—0
GET /v1/meta/plansTarife auflisten—0
GET /v1/meta/versionsVersionen auflisten—0
GET /v1/healthHealth-Check—0
GET /v1/statusStatus—0

Eine maschinenlesbare Beschreibung von allem oben Genannten liegt unter /v1/openapi.json; /v1/docs leitet hierher weiter.