{"openapi":"3.1.0","info":{"title":"xSignalFeed API","description":"Real-time X (formerly Twitter) monitoring: WebSocket stream of posts, replies, quotes, profile and follow changes for monitored accounts, plus REST reads. Independent third-party service, not affiliated with X Corp.","version":"1.0"},"servers":[{"url":"https://api.xsignalfeed.com","description":"production"}],"paths":{"/v1/health":{"get":{"summary":"Health","operationId":"health_v1_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/account":{"get":{"summary":"Account Info","description":"What this key may do and how much of it is used.","operationId":"account_info_v1_account_get","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/monitor/targets":{"get":{"summary":"List Targets","description":"The accounts this key monitors, alphabetically, a page at a time.","operationId":"list_targets_v1_monitor_targets_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":200,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Add Target","description":"Start monitoring an account. 201 when subscribed on the spot, 200 when already subscribed, 202 when we first\nhave to resolve it on X, 404 user_not_found / user_suspended / user_protected when X told us in the last ten\nminutes that it cannot be monitored. `event_types` narrows what is delivered for it (omit or [] for every type).","operationId":"add_target_v1_monitor_targets_post","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TargetIn"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/monitor/targets/{target}":{"get":{"summary":"Get Target","description":"One subscription, or the state of a pending resolution (queued / failed). `target`: the account's user id, its\nhandle, or a handle it had before.","operationId":"get_target_v1_monitor_targets__target__get","parameters":[{"name":"target","in":"path","required":true,"schema":{"type":"string","title":"Target"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"summary":"Patch Target","description":"Choose which event types are delivered for this account: a list, or null / [] for every type. Takes effect on\ndelivery only, so widening it again loses nothing that happens from then on. If-Match is honoured.","operationId":"patch_target_v1_monitor_targets__target__patch","parameters":[{"name":"target","in":"path","required":true,"schema":{"type":"string","title":"Target"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TargetPatch"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"summary":"Del Target","description":"Stop monitoring it (or withdraw a pending resolution). Never an error: removing what you do not have is a no-op.","operationId":"del_target_v1_monitor_targets__target__delete","parameters":[{"name":"target","in":"path","required":true,"schema":{"type":"string","title":"Target"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/monitor/targets:batch":{"post":{"summary":"Batch Targets","description":"Up to 100 add / remove operations in one call. Always 200: each item carries its own status.","operationId":"batch_targets_v1_monitor_targets_batch_post","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/account/webhook":{"put":{"summary":"Set Webhook","description":"Set (or clear with null) the webhook URL for this key. The secret is returned once, when it is created or\nrotated; sending the same URL again keeps the existing secret unless rotate_secret is true.","operationId":"set_webhook_v1_account_webhook_put","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"summary":"Get Webhook","operationId":"get_webhook_v1_account_webhook_get","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/keywords":{"get":{"summary":"List Keywords","description":"The keywords this key watches.","operationId":"list_keywords_v1_keywords_get","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Add Keyword","description":"Watch a query. 201 when the keyword is new, 200 when this key joins one that already exists.","operationId":"add_keyword_v1_keywords_post","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeywordIn"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/keywords/{keyword_id}":{"delete":{"summary":"Remove Keyword","description":"Stop receiving that keyword.","operationId":"remove_keyword_v1_keywords__keyword_id__delete","parameters":[{"name":"keyword_id","in":"path","required":true,"schema":{"type":"integer","title":"Keyword Id"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/events":{"get":{"summary":"Recent Events","description":"Recent events for this key's targets and keywords, newest first, filtered exactly like the stream. Page with cursor.","operationId":"recent_events_v1_events_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/meta/event-types":{"get":{"summary":"Meta Event Types","description":"Every event type, its category, and whether a second `update` frame follows the first. No key needed.","operationId":"meta_event_types_v1_meta_event_types_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/meta/scopes":{"get":{"summary":"Meta Scopes","description":"Customer scopes only, with names in English and Chinese.","operationId":"meta_scopes_v1_meta_scopes_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/meta/plans":{"get":{"summary":"Meta Plans","description":"Plan capability matrix. Prices are not published here.","operationId":"meta_plans_v1_meta_plans_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/meta/versions":{"get":{"summary":"Meta Versions","operationId":"meta_versions_v1_meta_versions_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/users/batch":{"get":{"summary":"Users Batch","operationId":"users_batch_v1_users_batch_get","parameters":[{"name":"ids","in":"query","required":false,"schema":{"type":"string","description":"comma-separated numeric account ids, up to 50","default":"","title":"Ids"},"description":"comma-separated numeric account ids, up to 50"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/users/search":{"get":{"summary":"Users Search","operationId":"users_search_v1_users_search_get","parameters":[{"name":"q","in":"query","required":false,"schema":{"type":"string","description":"name, handle or bio words","default":"","title":"Q"},"description":"name, handle or bio words"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Count"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"next_cursor from a previous page","title":"Cursor"},"description":"next_cursor from a previous page"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/users/by-id/{user_id}":{"get":{"summary":"User By Id","operationId":"user_by_id_v1_users_by_id__user_id__get","parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d{1,20}$","description":"numeric account id","title":"User Id"},"description":"numeric account id"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/users/{screen_name}/about":{"get":{"summary":"User About","operationId":"user_about_v1_users__screen_name__about_get","parameters":[{"name":"screen_name","in":"path","required":true,"schema":{"type":"string","title":"Screen Name"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/users/{screen_name}/subscriptions":{"get":{"summary":"User Subscriptions","operationId":"user_subscriptions_v1_users__screen_name__subscriptions_get","parameters":[{"name":"screen_name","in":"path","required":true,"schema":{"type":"string","title":"Screen Name"}},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Count"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"next_cursor from a previous page","title":"Cursor"},"description":"next_cursor from a previous page"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/users/{screen_name}/media":{"get":{"summary":"User Media","operationId":"user_media_v1_users__screen_name__media_get","parameters":[{"name":"screen_name","in":"path","required":true,"schema":{"type":"string","title":"Screen Name"}},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Count"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"next_cursor from a previous page","title":"Cursor"},"description":"next_cursor from a previous page"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/users/{screen_name}/mentions":{"get":{"summary":"User Mentions","operationId":"user_mentions_v1_users__screen_name__mentions_get","parameters":[{"name":"screen_name","in":"path","required":true,"schema":{"type":"string","title":"Screen Name"}},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Count"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"next_cursor from a previous page","title":"Cursor"},"description":"next_cursor from a previous page"},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"unix seconds; only posts at or after this time","title":"Since"},"description":"unix seconds; only posts at or after this time"},{"name":"until","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"unix seconds; only posts before this time","title":"Until"},"description":"unix seconds; only posts before this time"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/users/{screen_name}/relationship/{other_screen_name}":{"get":{"summary":"User Relationship","operationId":"user_relationship_v1_users__screen_name__relationship__other_screen_name__get","parameters":[{"name":"screen_name","in":"path","required":true,"schema":{"type":"string","title":"Screen Name"}},{"name":"other_screen_name","in":"path","required":true,"schema":{"type":"string","title":"Other Screen Name"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/users/{screen_name}":{"get":{"summary":"User Profile","operationId":"user_profile_v1_users__screen_name__get","parameters":[{"name":"screen_name","in":"path","required":true,"schema":{"type":"string","title":"Screen Name"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/users/{screen_name}/tweets":{"get":{"summary":"User Tweets","operationId":"user_tweets_v1_users__screen_name__tweets_get","parameters":[{"name":"screen_name","in":"path","required":true,"schema":{"type":"string","title":"Screen Name"}},{"name":"replies","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Replies"}},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":40,"title":"Count"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"next_cursor from a previous page","title":"Cursor"},"description":"next_cursor from a previous page"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/users/{screen_name}/following":{"get":{"summary":"Following","operationId":"following_v1_users__screen_name__following_get","parameters":[{"name":"screen_name","in":"path","required":true,"schema":{"type":"string","title":"Screen Name"}},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Count"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/users/{screen_name}/followers":{"get":{"summary":"Followers","operationId":"followers_v1_users__screen_name__followers_get","parameters":[{"name":"screen_name","in":"path","required":true,"schema":{"type":"string","title":"Screen Name"}},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Count"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/users/{screen_name}/verified_followers":{"get":{"summary":"Verified Followers","operationId":"verified_followers_v1_users__screen_name__verified_followers_get","parameters":[{"name":"screen_name","in":"path","required":true,"schema":{"type":"string","title":"Screen Name"}},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Count"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/tweets/{tweet_id}":{"get":{"summary":"Tweet","operationId":"tweet_v1_tweets__tweet_id__get","parameters":[{"name":"tweet_id","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d{1,20}$","description":"numeric post id","title":"Tweet Id"},"description":"numeric post id"},{"name":"replies_limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":0,"default":20,"title":"Replies Limit"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/account/usage":{"get":{"summary":"Usage","operationId":"usage_v1_account_usage_get","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/tweets":{"get":{"summary":"Tweets By Ids","operationId":"tweets_by_ids_v1_tweets_get","parameters":[{"name":"ids","in":"query","required":false,"schema":{"type":"string","description":"comma-separated post ids, at most 20","default":"","title":"Ids"},"description":"comma-separated post ids, at most 20"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/tweets/{tweet_id}/replies":{"get":{"summary":"Tweet Replies","operationId":"tweet_replies_v1_tweets__tweet_id__replies_get","parameters":[{"name":"tweet_id","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d{1,20}$","description":"numeric post id","title":"Tweet Id"},"description":"numeric post id"},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"next_cursor from a previous page","title":"Cursor"},"description":"next_cursor from a previous page"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/tweets/{tweet_id}/quotes":{"get":{"summary":"Tweet Quotes","operationId":"tweet_quotes_v1_tweets__tweet_id__quotes_get","parameters":[{"name":"tweet_id","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d{1,20}$","description":"numeric post id","title":"Tweet Id"},"description":"numeric post id"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Count"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"next_cursor from a previous page","title":"Cursor"},"description":"next_cursor from a previous page"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/tweets/{tweet_id}/retweeters":{"get":{"summary":"Tweet Retweeters","operationId":"tweet_retweeters_v1_tweets__tweet_id__retweeters_get","parameters":[{"name":"tweet_id","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d{1,20}$","description":"numeric post id","title":"Tweet Id"},"description":"numeric post id"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Count"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"next_cursor from a previous page","title":"Cursor"},"description":"next_cursor from a previous page"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/tweets/{tweet_id}/thread":{"get":{"summary":"Tweet Thread","operationId":"tweet_thread_v1_tweets__tweet_id__thread_get","parameters":[{"name":"tweet_id","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d{1,20}$","description":"numeric post id","title":"Tweet Id"},"description":"numeric post id"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/tweets/{tweet_id}/article":{"get":{"summary":"Tweet Article","operationId":"tweet_article_v1_tweets__tweet_id__article_get","parameters":[{"name":"tweet_id","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d{1,20}$","description":"numeric post id","title":"Tweet Id"},"description":"numeric post id"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/search":{"get":{"summary":"Search","operationId":"search_v1_search_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","description":"X search query; the full operator grammar is accepted","title":"Q"},"description":"X search query; the full operator grammar is accepted"},{"name":"product","in":"query","required":false,"schema":{"type":"string","description":"latest | top | media","default":"latest","title":"Product"},"description":"latest | top | media"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Count"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"next_cursor from a previous page","title":"Cursor"},"description":"next_cursor from a previous page"},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"unix seconds; only posts at or after this time","title":"Since"},"description":"unix seconds; only posts at or after this time"},{"name":"until","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"unix seconds; only posts before this time","title":"Until"},"description":"unix seconds; only posts before this time"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/search/trends":{"get":{"summary":"Search Trends","operationId":"search_trends_v1_search_trends_get","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","description":"the trend's name or query, as shown in a trends list","title":"Q"},"description":"the trend's name or query, as shown in a trends list"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Count"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"next_cursor from a previous page","title":"Cursor"},"description":"next_cursor from a previous page"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/lists/{list_id}/tweets":{"get":{"summary":"List Tweets","operationId":"list_tweets_v1_lists__list_id__tweets_get","parameters":[{"name":"list_id","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d{1,20}$","description":"numeric List id","title":"List Id"},"description":"numeric List id"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":40,"title":"Count"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"next_cursor from a previous page","title":"Cursor"},"description":"next_cursor from a previous page"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/lists/{list_id}/members":{"get":{"summary":"List Members","operationId":"list_members_v1_lists__list_id__members_get","parameters":[{"name":"list_id","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d{1,20}$","description":"numeric List id","title":"List Id"},"description":"numeric List id"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Count"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"next_cursor from a previous page","title":"Cursor"},"description":"next_cursor from a previous page"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/communities/{community_id}":{"get":{"summary":"Community","operationId":"community_v1_communities__community_id__get","parameters":[{"name":"community_id","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d{1,20}$","description":"numeric Community id","title":"Community Id"},"description":"numeric Community id"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/communities/{community_id}/members":{"get":{"summary":"Community Members","operationId":"community_members_v1_communities__community_id__members_get","parameters":[{"name":"community_id","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d{1,20}$","description":"numeric Community id","title":"Community Id"},"description":"numeric Community id"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Count"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"next_cursor from a previous page","title":"Cursor"},"description":"next_cursor from a previous page"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/communities/{community_id}/moderators":{"get":{"summary":"Community Moderators","operationId":"community_moderators_v1_communities__community_id__moderators_get","parameters":[{"name":"community_id","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d{1,20}$","description":"numeric Community id","title":"Community Id"},"description":"numeric Community id"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Count"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"next_cursor from a previous page","title":"Cursor"},"description":"next_cursor from a previous page"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/communities/{community_id}/tweets":{"get":{"summary":"Community Tweets","operationId":"community_tweets_v1_communities__community_id__tweets_get","parameters":[{"name":"community_id","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d{1,20}$","description":"numeric Community id","title":"Community Id"},"description":"numeric Community id"},{"name":"count","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":40,"title":"Count"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"next_cursor from a previous page","title":"Cursor"},"description":"next_cursor from a previous page"},{"name":"ranking","in":"query","required":false,"schema":{"type":"string","pattern":"^(Relevance|Recency)$","description":"Relevance (top) or Recency (latest)","default":"Relevance","title":"Ranking"},"description":"Relevance (top) or Recency (latest)"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/trends":{"get":{"summary":"Trends","operationId":"trends_v1_trends_get","parameters":[{"name":"category","in":"query","required":false,"schema":{"type":"string","description":"trending | news | sport | entertainment","default":"trending","title":"Category"},"description":"trending | news | sport | entertainment"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":30,"title":"Limit"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/status":{"get":{"summary":"Status Json","description":"Public service status: component heartbeats only (no customer data, no performance figures). Cached 30 s.","operationId":"status_json_v1_status_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}}},"components":{"schemas":{"BatchIn":{"properties":{"items":{"items":{"$ref":"#/components/schemas/BatchItem"},"type":"array","title":"Items"}},"type":"object","required":["items"],"title":"BatchIn"},"BatchItem":{"properties":{"op":{"type":"string","title":"Op"},"screen_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Screen Name"},"user_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"User Id"},"event_types":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Event Types"}},"type":"object","required":["op"],"title":"BatchItem"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"KeywordIn":{"properties":{"query":{"type":"string","title":"Query"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"}},"type":"object","required":["query"],"title":"KeywordIn"},"TargetIn":{"properties":{"screen_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Screen Name"},"user_id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"User Id"},"event_types":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Event Types"}},"type":"object","title":"TargetIn"},"TargetPatch":{"properties":{"event_types":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Event Types"}},"type":"object","title":"TargetPatch"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"WebhookIn":{"properties":{"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"},"rotate_secret":{"type":"boolean","title":"Rotate Secret","default":false}},"type":"object","title":"WebhookIn"}}},"tags":[{"name":"Monitoring","description":"Choose which X accounts this key follows, and optionally which event types you want from each. Every key is served alike."},{"name":"Keywords","description":"Watch X search for phrases; matches arrive as search.match events."},{"name":"Stream","description":"The WebSocket that delivers events, and the replay of what you missed."},{"name":"Users","description":"Profiles, follow lists, media, mentions, subscriptions and user search, read on demand."},{"name":"Tweets","description":"Posts by id, with replies, quotes, reposters, thread and article."},{"name":"Search","description":"X search in its own syntax, latest or top."},{"name":"Lists","description":"Timeline and membership of public lists."},{"name":"Communities","description":"Info, members, moderators and posts of communities."},{"name":"Trends","description":"What is trending, by category."},{"name":"Account","description":"What this key may do, how much it has used, where webhooks go."},{"name":"Meta","description":"Public, unauthenticated descriptions of event types, scopes, plans and versions."}]}