API-referentie

Basis-URL https://api.xsignalfeed.com. Alle antwoorden zijn JSON in de envelop die onder Fouten wordt beschreven wanneer ze mislukken, en dragen de headers uit Verzoeklimieten wanneer ze slagen. Velden gemarkeerd met * zijn verplicht.

Monitoring

Kies welke accounts deze sleutel volgt. Van elk krijgt u alle gebeurtenistypen die uw sleutel toestaat, of alleen de typen die u kiest.

EndpointNaamScopeCredits
GET /v1/monitor/targetsGevolgde accounts weergeventargets:read0
POST /v1/monitor/targetsEen account volgentargets:write0
GET /v1/monitor/targets/{target}Een gevolgd account ophalentargets:read0
PATCH /v1/monitor/targets/{target}Gebeurtenistypen van een account kiezentargets:write0
DELETE /v1/monitor/targets/{target}Een account niet meer volgentargets:write0
POST /v1/monitor/targets:batchVolgbewerkingen in batch uitvoerentargets:write0

Trefwoorden

Volg X-zoeken op zoektermen. De query accepteert de eigen syntaxis van X: exacte zinnen tussen aanhalingstekens, OR, -exclusions, #hashtags, $cashtags, from:, to:, lang:, filter:media, -filter:replies, -filter:retweets. We volgen het tabblad "Nieuwste", dus de resultaten zijn chronologisch, en elke taal of elk schrift werkt.

EndpointNaamScopeCredits
GET /v1/keywordsTrefwoorden weergevenkeywords:read0
POST /v1/keywordsEen trefwoord volgenkeywords:write0
DELETE /v1/keywords/{keyword_id}Een trefwoord verwijderenkeywords:write0

Stream & historie

De WebSocket wordt beschreven onder Streaming; dit is de REST-tegenhanger om een achterstand in te halen.

EndpointNaamScopeCredits
GET /v1/eventsGebeurtenisgeschiedenisreplay0

Gebruikers

Profielen, volglijsten, media, vermeldingen, abonnementen en gebruikerszoeken, nu gelezen van X. Elke aanroep kost de getoonde credits.

EndpointNaamScopeCredits
GET /v1/users/{screen_name}Gebruiker op gebruikersnaam ophalenreads1
GET /v1/users/by-id/{user_id}Gebruiker op id ophalenreads1
GET /v1/users/batchGebruikers op id's ophalenreads1 per id
GET /v1/users/{screen_name}/aboutAccountgegevens ophalenreads1
GET /v1/users/{screen_name}/tweetsBerichten van gebruiker ophalenreads2
GET /v1/users/{screen_name}/mediaMedia van gebruiker ophalenreads2
GET /v1/users/{screen_name}/mentionsVermeldingen van gebruiker ophalenreads2
GET /v1/users/{screen_name}/followingGevolgde accounts ophalenreads2
GET /v1/users/{screen_name}/followersVolgers ophalenreads2
GET /v1/users/{screen_name}/verified_followersGeverifieerde volgers ophalenreads2
GET /v1/users/{screen_name}/subscriptionsAbonnementen ophalenreads2
GET /v1/users/searchGebruikers zoekenreads2
GET /v1/users/{screen_name}/relationship/{other_screen_name}Volgrelatie controlerenreads1

Tweets

Berichten op id, met hun reacties, citaten, reposters, draad en artikel. Elke aanroep kost de getoonde credits.

EndpointNaamScopeCredits
GET /v1/tweets/{tweet_id}Een bericht ophalenreads1
GET /v1/tweetsBerichten op id's ophalenreads1
GET /v1/tweets/{tweet_id}/repliesReacties ophalenreads2
GET /v1/tweets/{tweet_id}/quotesCitaten ophalenreads2
GET /v1/tweets/{tweet_id}/retweetersReposters ophalenreads2
GET /v1/tweets/{tweet_id}/threadEen draad ophalenreads2
GET /v1/tweets/{tweet_id}/articleEen artikel ophalenreads1

X-zoeken in zijn eigen syntaxis, nieuwste of topresultaten, gepagineerd.

EndpointNaamScopeCredits
GET /v1/searchBerichten zoekenreads2
GET /v1/search/trendsEen trend doorzoekenreads2

Lijsten

Tijdlijn en leden van elke openbare lijst.

EndpointNaamScopeCredits
GET /v1/lists/{list_id}/tweetsBerichten van lijst ophalenreads2
GET /v1/lists/{list_id}/membersLeden van lijst ophalenreads2

Community's

Info, leden, moderators en berichten van een X-community.

EndpointNaamScopeCredits
GET /v1/communities/{community_id}Een community ophalenreads1
GET /v1/communities/{community_id}/membersLeden van community ophalenreads2
GET /v1/communities/{community_id}/moderatorsModerators van community ophalenreads2
GET /v1/communities/{community_id}/tweetsBerichten van community ophalenreads2

Wat er op dit moment trending is op X, per categorie.

EndpointNaamScopeCredits
GET /v1/trendsTrends ophalenreads2

Account

Wat deze sleutel mag doen, hoeveel hij heeft gebruikt, waar webhooks heen gaan.

EndpointNaamScopeCredits
GET /v1/accountAccount ophalen—0
GET /v1/account/usageVerbruik ophalen—0
GET /v1/account/webhookWebhook ophalenwebhook0
PUT /v1/account/webhookWebhook instellenwebhook0

Meta & status

Openbaar, vijf minuten gecachet, geen sleutel nodig. Bouw uw validatie en uw UI hierop in plaats van deze pagina over te nemen.

EndpointNaamScopeCredits
GET /v1/meta/event-typesGebeurtenistypen weergeven—0
GET /v1/meta/scopesScopes weergeven—0
GET /v1/meta/plansPlannen weergeven—0
GET /v1/meta/versionsVersies weergeven—0
GET /v1/healthGezondheid—0
GET /v1/statusStatus—0

Een machineleesbare beschrijving van al het bovenstaande staat op /v1/openapi.json; /v1/docs verwijst hierheen.