Référence de l'API

URL de base https://api.xsignalfeed.com. Toutes les réponses sont du JSON dans l'enveloppe décrite sous Erreurs quand elles échouent, et portent les en-têtes listés sous Limites de débit quand elles réussissent. Les champs marqués * sont obligatoires.

Surveillance

Choisissez les comptes que suit cette clé. Pour chacun, vous recevez tous les types d'événement autorisés par votre clé, ou seulement ceux que vous choisissez.

Point de terminaisonNomPortéeCrédits
GET /v1/monitor/targetsLister les comptes surveilléstargets:read0
POST /v1/monitor/targetsSurveiller un comptetargets:write0
GET /v1/monitor/targets/{target}Obtenir un compte surveillétargets:read0
PATCH /v1/monitor/targets/{target}Choisir les types d'événement d'un comptetargets:write0
DELETE /v1/monitor/targets/{target}Cesser de surveiller un comptetargets:write0
POST /v1/monitor/targets:batchOpérations de surveillance par lotstargets:write0

Mots-clés

Surveillez la recherche X pour des expressions. La requête accepte la syntaxe propre à X : expressions exactes entre guillemets, OR, -exclusions, #hashtags, $cashtags, from:, to:, lang:, filter:media, -filter:replies, -filter:retweets. Nous surveillons l'onglet « Récent », les résultats sont donc chronologiques, et n'importe quelle langue ou écriture fonctionne.

Point de terminaisonNomPortéeCrédits
GET /v1/keywordsLister les mots-cléskeywords:read0
POST /v1/keywordsSurveiller un mot-clékeywords:write0
DELETE /v1/keywords/{keyword_id}Retirer un mot-clékeywords:write0

Flux & historique

Le WebSocket est décrit sous Flux en continu ; voici son pendant REST pour rattraper le retard.

Point de terminaisonNomPortéeCrédits
GET /v1/eventsHistorique des événementsreplay0

Utilisateurs

Profils, listes d'abonnés et d'abonnements, médias, mentions, abonnements à des créateurs et recherche d'utilisateurs, lus sur X à l'instant. Chaque appel coûte les crédits indiqués.

Point de terminaisonNomPortéeCrédits
GET /v1/users/{screen_name}Obtenir un utilisateur par nom d'utilisateurreads1
GET /v1/users/by-id/{user_id}Obtenir un utilisateur par idreads1
GET /v1/users/batchObtenir des utilisateurs par idsreads1 per id
GET /v1/users/{screen_name}/aboutObtenir les détails d'un comptereads1
GET /v1/users/{screen_name}/tweetsObtenir les publications d'un utilisateurreads2
GET /v1/users/{screen_name}/mediaObtenir les médias d'un utilisateurreads2
GET /v1/users/{screen_name}/mentionsObtenir les mentions d'un utilisateurreads2
GET /v1/users/{screen_name}/followingObtenir les abonnementsreads2
GET /v1/users/{screen_name}/followersObtenir les abonnésreads2
GET /v1/users/{screen_name}/verified_followersObtenir les abonnés certifiésreads2
GET /v1/users/{screen_name}/subscriptionsObtenir les abonnements à des créateursreads2
GET /v1/users/searchRechercher des utilisateursreads2
GET /v1/users/{screen_name}/relationship/{other_screen_name}Vérifier une relation d'abonnementreads1

Publications

Publications par identifiant, avec leurs réponses, citations, auteurs de republication, fil et article. Chaque appel coûte les crédits indiqués.

Point de terminaisonNomPortéeCrédits
GET /v1/tweets/{tweet_id}Obtenir une publicationreads1
GET /v1/tweetsObtenir des publications par idsreads1
GET /v1/tweets/{tweet_id}/repliesObtenir les réponsesreads2
GET /v1/tweets/{tweet_id}/quotesObtenir les citationsreads2
GET /v1/tweets/{tweet_id}/retweetersObtenir les auteurs de republicationreads2
GET /v1/tweets/{tweet_id}/threadObtenir un filreads2
GET /v1/tweets/{tweet_id}/articleObtenir un articlereads1

La recherche X dans sa propre syntaxe, résultats les plus récents ou les plus pertinents, paginés.

Point de terminaisonNomPortéeCrédits
GET /v1/searchRechercher des publicationsreads2
GET /v1/search/trendsRechercher une tendancereads2

Listes

Fil et membres de n'importe quelle liste publique.

Point de terminaisonNomPortéeCrédits
GET /v1/lists/{list_id}/tweetsObtenir les publications d'une listereads2
GET /v1/lists/{list_id}/membersObtenir les membres d'une listereads2

Communautés

Informations, membres, modérateurs et publications d'une communauté X.

Point de terminaisonNomPortéeCrédits
GET /v1/communities/{community_id}Obtenir une communautéreads1
GET /v1/communities/{community_id}/membersObtenir les membres d'une communautéreads2
GET /v1/communities/{community_id}/moderatorsObtenir les modérateurs d'une communautéreads2
GET /v1/communities/{community_id}/tweetsObtenir les publications d'une communautéreads2

Ce qui est en tendance sur X en ce moment, par catégorie.

Point de terminaisonNomPortéeCrédits
GET /v1/trendsObtenir les tendancesreads2

Compte

Ce que cette clé peut faire, combien elle a consommé, où vont les webhooks.

Point de terminaisonNomPortéeCrédits
GET /v1/accountObtenir le compte—0
GET /v1/account/usageObtenir la consommation—0
GET /v1/account/webhookObtenir le webhookwebhook0
PUT /v1/account/webhookDéfinir le webhookwebhook0

Meta & statut

Public, mis en cache cinq minutes, aucune clé requise. Construisez votre validation et votre interface à partir de ces réponses plutôt qu'en copiant cette page.

Point de terminaisonNomPortéeCrédits
GET /v1/meta/event-typesLister les types d'événements—0
GET /v1/meta/scopesLister les portées—0
GET /v1/meta/plansLister les offres—0
GET /v1/meta/versionsLister les versions—0
GET /v1/healthSanté—0
GET /v1/statusStatut—0

Une description lisible par machine de tout ce qui précède se trouve sur /v1/openapi.json ; /v1/docs redirige ici.