Referência da API

URL base https://api.xsignalfeed.com. Todas as respostas são JSON no envelope descrito em Erros quando falham, e carregam os cabeçalhos listados em Limites de requisições quando têm sucesso. Campos marcados com * são obrigatórios.

Monitoramento

Escolha quais contas esta chave acompanha. De cada uma você recebe todos os tipos de evento que sua chave permite, ou só os que escolher.

EndpointNomeEscopoCréditos
GET /v1/monitor/targetsListar contas monitoradastargets:read0
POST /v1/monitor/targetsMonitorar uma contatargets:write0
GET /v1/monitor/targets/{target}Obter uma conta monitoradatargets:read0
PATCH /v1/monitor/targets/{target}Escolher tipos de evento de uma contatargets:write0
DELETE /v1/monitor/targets/{target}Parar de monitorar uma contatargets:write0
POST /v1/monitor/targets:batchOperações de monitoramento em lotetargets:write0

Palavras-chave

Observe a busca do X por frases. A busca aceita a sintaxe do próprio X: frases exatas entre aspas, OR, -exclusions, #hashtags, $cashtags, from:, to:, lang:, filter:media, -filter:replies, -filter:retweets. Observamos a aba "Mais recentes", então os resultados são cronológicos, e qualquer idioma ou alfabeto funciona.

EndpointNomeEscopoCréditos
GET /v1/keywordsListar palavras-chavekeywords:read0
POST /v1/keywordsObservar uma palavra-chavekeywords:write0
DELETE /v1/keywords/{keyword_id}Remover uma palavra-chavekeywords:write0

Stream & histórico

O WebSocket está descrito em Streaming; este é seu complemento REST para recuperar o atraso.

EndpointNomeEscopoCréditos
GET /v1/eventsHistórico de eventosreplay0

Usuários

Perfis, listas de seguidos e seguidores, mídia, menções, assinaturas e busca de usuários, lidos do X agora. Cada chamada custa os créditos indicados.

EndpointNomeEscopoCréditos
GET /v1/users/{screen_name}Obter usuário por nome de usuárioreads1
GET /v1/users/by-id/{user_id}Obter usuário por idreads1
GET /v1/users/batchObter usuários por idsreads1 per id
GET /v1/users/{screen_name}/aboutObter detalhes da contareads1
GET /v1/users/{screen_name}/tweetsObter publicações do usuárioreads2
GET /v1/users/{screen_name}/mediaObter mídia do usuárioreads2
GET /v1/users/{screen_name}/mentionsObter menções ao usuárioreads2
GET /v1/users/{screen_name}/followingObter seguidosreads2
GET /v1/users/{screen_name}/followersObter seguidoresreads2
GET /v1/users/{screen_name}/verified_followersObter seguidores verificadosreads2
GET /v1/users/{screen_name}/subscriptionsObter assinaturasreads2
GET /v1/users/searchBuscar usuáriosreads2
GET /v1/users/{screen_name}/relationship/{other_screen_name}Verificar relação entre contasreads1

Publicações

Publicações por id, com suas respostas, citações, quem republicou, thread e artigo. Cada chamada custa os créditos indicados.

EndpointNomeEscopoCréditos
GET /v1/tweets/{tweet_id}Obter uma publicaçãoreads1
GET /v1/tweetsObter publicações por idsreads1
GET /v1/tweets/{tweet_id}/repliesObter respostasreads2
GET /v1/tweets/{tweet_id}/quotesObter citaçõesreads2
GET /v1/tweets/{tweet_id}/retweetersObter quem republicoureads2
GET /v1/tweets/{tweet_id}/threadObter um threadreads2
GET /v1/tweets/{tweet_id}/articleObter um artigoreads1

A busca do X na sintaxe dele mesmo, resultados mais recentes ou em destaque, paginados.

EndpointNomeEscopoCréditos
GET /v1/searchBuscar publicaçõesreads2
GET /v1/search/trendsBuscar uma tendênciareads2

Listas

Linha do tempo e membros de qualquer lista pública.

EndpointNomeEscopoCréditos
GET /v1/lists/{list_id}/tweetsObter publicações da listareads2
GET /v1/lists/{list_id}/membersObter membros da listareads2

Comunidades

Informações, membros, moderadores e publicações de uma comunidade do X.

EndpointNomeEscopoCréditos
GET /v1/communities/{community_id}Obter uma comunidadereads1
GET /v1/communities/{community_id}/membersObter membros da comunidadereads2
GET /v1/communities/{community_id}/moderatorsObter moderadores da comunidadereads2
GET /v1/communities/{community_id}/tweetsObter publicações da comunidadereads2

O que está em alta no X agora, por categoria.

EndpointNomeEscopoCréditos
GET /v1/trendsObter tendênciasreads2

Conta

O que esta chave pode fazer, quanto já usou, para onde vão os webhooks.

EndpointNomeEscopoCréditos
GET /v1/accountObter conta—0
GET /v1/account/usageObter uso—0
GET /v1/account/webhookObter webhookwebhook0
PUT /v1/account/webhookDefinir webhookwebhook0

Meta & status

Público, em cache por cinco minutos, sem necessidade de chave. Construa sua validação e sua interface a partir destes em vez de copiar esta página.

EndpointNomeEscopoCréditos
GET /v1/meta/event-typesListar tipos de evento—0
GET /v1/meta/scopesListar escopos—0
GET /v1/meta/plansListar planos—0
GET /v1/meta/versionsListar versões—0
GET /v1/healthSaúde—0
GET /v1/statusStatus—0

Uma descrição legível por máquina de tudo isso está em /v1/openapi.json; /v1/docs redireciona para cá.