Referensi API

URL dasar https://api.xsignalfeed.com. Semua respons berupa JSON dalam amplop yang dijelaskan di bagian Kesalahan saat gagal, dan membawa header yang tercantum di bagian Batas laju saat berhasil. Bidang bertanda * wajib diisi.

Pemantauan

Pilih akun yang diikuti kunci ini. Untuk masing-masing, Anda mendapat semua tipe peristiwa yang diizinkan kunci Anda, atau hanya tipe yang Anda pilih.

EndpointNamaCakupanKredit
GET /v1/monitor/targetsDaftar akun yang dipantautargets:read0
POST /v1/monitor/targetsPantau sebuah akuntargets:write0
GET /v1/monitor/targets/{target}Ambil akun yang dipantautargets:read0
PATCH /v1/monitor/targets/{target}Pilih tipe peristiwa sebuah akuntargets:write0
DELETE /v1/monitor/targets/{target}Berhenti memantau akuntargets:write0
POST /v1/monitor/targets:batchOperasi pemantauan batchtargets:write0

Kata kunci

Awasi pencarian X untuk frasa tertentu. Kueri menerima sintaks milik X sendiri: frasa persis dalam tanda kutip, OR, -exclusions, #hashtags, $cashtags, from:, to:, lang:, filter:media, -filter:replies, -filter:retweets. Kami mengawasi tab "Terbaru", sehingga hasilnya kronologis, dan bahasa atau aksara apa pun bisa dipakai.

EndpointNamaCakupanKredit
GET /v1/keywordsDaftar kata kuncikeywords:read0
POST /v1/keywordsAwasi kata kuncikeywords:write0
DELETE /v1/keywords/{keyword_id}Hapus kata kuncikeywords:write0

Stream & riwayat

WebSocket dijelaskan di bagian Streaming; ini adalah pendamping REST-nya untuk mengejar ketinggalan.

EndpointNamaCakupanKredit
GET /v1/eventsRiwayat peristiwareplay0

Pengguna

Profil, daftar pengikutan, media, sebutan, langganan dan pencarian pengguna, dibaca dari X saat ini juga. Setiap panggilan memakai kredit yang tercantum.

EndpointNamaCakupanKredit
GET /v1/users/{screen_name}Ambil pengguna berdasarkan nama penggunareads1
GET /v1/users/by-id/{user_id}Ambil pengguna berdasarkan idreads1
GET /v1/users/batchAmbil beberapa pengguna berdasarkan idreads1 per id
GET /v1/users/{screen_name}/aboutAmbil detail akunreads1
GET /v1/users/{screen_name}/tweetsAmbil unggahan penggunareads2
GET /v1/users/{screen_name}/mediaAmbil media penggunareads2
GET /v1/users/{screen_name}/mentionsAmbil sebutan penggunareads2
GET /v1/users/{screen_name}/followingAmbil yang diikutireads2
GET /v1/users/{screen_name}/followersAmbil pengikutreads2
GET /v1/users/{screen_name}/verified_followersAmbil pengikut terverifikasireads2
GET /v1/users/{screen_name}/subscriptionsAmbil langgananreads2
GET /v1/users/searchCari penggunareads2
GET /v1/users/{screen_name}/relationship/{other_screen_name}Periksa hubungan pengikutanreads1

Tweet

Unggahan berdasarkan id, beserta balasan, kutipan, pengunggah ulang, utas dan artikelnya. Setiap panggilan memakai kredit yang tercantum.

EndpointNamaCakupanKredit
GET /v1/tweets/{tweet_id}Ambil sebuah unggahanreads1
GET /v1/tweetsAmbil beberapa unggahan berdasarkan idreads1
GET /v1/tweets/{tweet_id}/repliesAmbil balasanreads2
GET /v1/tweets/{tweet_id}/quotesAmbil kutipanreads2
GET /v1/tweets/{tweet_id}/retweetersAmbil pengunggah ulangreads2
GET /v1/tweets/{tweet_id}/threadAmbil sebuah utasreads2
GET /v1/tweets/{tweet_id}/articleAmbil sebuah artikelreads1

Pencarian X dalam sintaksnya sendiri, hasil terbaru atau teratas, berhalaman.

EndpointNamaCakupanKredit
GET /v1/searchCari unggahanreads2
GET /v1/search/trendsCari sebuah trenreads2

Daftar

Linimasa dan keanggotaan daftar publik mana pun.

EndpointNamaCakupanKredit
GET /v1/lists/{list_id}/tweetsAmbil unggahan daftarreads2
GET /v1/lists/{list_id}/membersAmbil anggota daftarreads2

Komunitas

Info, anggota, moderator dan unggahan dari sebuah komunitas X.

EndpointNamaCakupanKredit
GET /v1/communities/{community_id}Ambil sebuah komunitasreads1
GET /v1/communities/{community_id}/membersAmbil anggota komunitasreads2
GET /v1/communities/{community_id}/moderatorsAmbil moderator komunitasreads2
GET /v1/communities/{community_id}/tweetsAmbil unggahan komunitasreads2

Apa yang sedang tren di X saat ini, per kategori.

EndpointNamaCakupanKredit
GET /v1/trendsAmbil trenreads2

Akun

Apa yang boleh dilakukan kunci ini, seberapa banyak yang sudah dipakai, ke mana webhook dikirim.

EndpointNamaCakupanKredit
GET /v1/accountAmbil akun—0
GET /v1/account/usageAmbil penggunaan—0
GET /v1/account/webhookAmbil webhookwebhook0
PUT /v1/account/webhookSetel webhookwebhook0

Meta & status

Publik, di-cache selama lima menit, tanpa kunci. Bangun validasi dan UI Anda dari sini alih-alih menyalin halaman ini.

EndpointNamaCakupanKredit
GET /v1/meta/event-typesDaftar tipe peristiwa—0
GET /v1/meta/scopesDaftar cakupan—0
GET /v1/meta/plansDaftar paket—0
GET /v1/meta/versionsDaftar versi—0
GET /v1/healthKesehatan—0
GET /v1/statusStatus—0

Deskripsi yang dapat dibaca mesin untuk semua hal di atas ada di /v1/openapi.json; /v1/docs mengalihkan ke sini.