twitteropenapipython_generated.V11GetApi
March 11, 2025 ยท View on GitHub
All URIs are relative to https://x.com/i/api
| Method | HTTP request | Description |
|---|---|---|
| get_friends_following_list | GET /1.1/friends/following/list.json | |
| get_search_typeahead | GET /1.1/search/typeahead.json |
get_friends_following_list
get_friends_following_list(include_profile_interstitial_type, include_blocking, include_blocked_by, include_followed_by, include_want_retweets, include_mute_edge, include_can_dm, include_can_media_tag, include_ext_has_nft_avatar, include_ext_is_blue_verified, include_ext_verified_type, include_ext_profile_image_shape, skip_status, cursor, user_id, count, with_total_count)
get friends following list
Example
- Api Key Authentication (Accept):
- Api Key Authentication (ClientLanguage):
- Api Key Authentication (Priority):
- Api Key Authentication (Referer):
- Api Key Authentication (SecFetchDest):
- Api Key Authentication (SecChUaPlatform):
- Api Key Authentication (SecFetchMode):
- Api Key Authentication (CsrfToken):
- Api Key Authentication (ClientUuid):
- Bearer Authentication (BearerAuth):
- Api Key Authentication (GuestToken):
- Api Key Authentication (SecChUa):
- Api Key Authentication (CookieGt0):
- Api Key Authentication (ClientTransactionId):
- Api Key Authentication (ActiveUser):
- Api Key Authentication (CookieCt0):
- Api Key Authentication (UserAgent):
- Api Key Authentication (AcceptLanguage):
- Api Key Authentication (SecFetchSite):
- Api Key Authentication (AuthType):
- Api Key Authentication (CookieAuthToken):
- Api Key Authentication (SecChUaMobile):
- Api Key Authentication (AcceptEncoding):
import twitter_openapi_python_generated
from twitter_openapi_python_generated.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://x.com/i/api
# See configuration.py for a list of all supported configuration parameters.
configuration = twitter_openapi_python_generated.Configuration(
host = "https://x.com/i/api"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: Accept
configuration.api_key['Accept'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Accept'] = 'Bearer'
# Configure API key authorization: ClientLanguage
configuration.api_key['ClientLanguage'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ClientLanguage'] = 'Bearer'
# Configure API key authorization: Priority
configuration.api_key['Priority'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Priority'] = 'Bearer'
# Configure API key authorization: Referer
configuration.api_key['Referer'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Referer'] = 'Bearer'
# Configure API key authorization: SecFetchDest
configuration.api_key['SecFetchDest'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SecFetchDest'] = 'Bearer'
# Configure API key authorization: SecChUaPlatform
configuration.api_key['SecChUaPlatform'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SecChUaPlatform'] = 'Bearer'
# Configure API key authorization: SecFetchMode
configuration.api_key['SecFetchMode'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SecFetchMode'] = 'Bearer'
# Configure API key authorization: CsrfToken
configuration.api_key['CsrfToken'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CsrfToken'] = 'Bearer'
# Configure API key authorization: ClientUuid
configuration.api_key['ClientUuid'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ClientUuid'] = 'Bearer'
# Configure Bearer authorization: BearerAuth
configuration = twitter_openapi_python_generated.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Configure API key authorization: GuestToken
configuration.api_key['GuestToken'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['GuestToken'] = 'Bearer'
# Configure API key authorization: SecChUa
configuration.api_key['SecChUa'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SecChUa'] = 'Bearer'
# Configure API key authorization: CookieGt0
configuration.api_key['CookieGt0'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CookieGt0'] = 'Bearer'
# Configure API key authorization: ClientTransactionId
configuration.api_key['ClientTransactionId'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ClientTransactionId'] = 'Bearer'
# Configure API key authorization: ActiveUser
configuration.api_key['ActiveUser'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ActiveUser'] = 'Bearer'
# Configure API key authorization: CookieCt0
configuration.api_key['CookieCt0'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CookieCt0'] = 'Bearer'
# Configure API key authorization: UserAgent
configuration.api_key['UserAgent'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['UserAgent'] = 'Bearer'
# Configure API key authorization: AcceptLanguage
configuration.api_key['AcceptLanguage'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AcceptLanguage'] = 'Bearer'
# Configure API key authorization: SecFetchSite
configuration.api_key['SecFetchSite'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SecFetchSite'] = 'Bearer'
# Configure API key authorization: AuthType
configuration.api_key['AuthType'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AuthType'] = 'Bearer'
# Configure API key authorization: CookieAuthToken
configuration.api_key['CookieAuthToken'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CookieAuthToken'] = 'Bearer'
# Configure API key authorization: SecChUaMobile
configuration.api_key['SecChUaMobile'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SecChUaMobile'] = 'Bearer'
# Configure API key authorization: AcceptEncoding
configuration.api_key['AcceptEncoding'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AcceptEncoding'] = 'Bearer'
# Enter a context with an instance of the API client
with twitter_openapi_python_generated.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = twitter_openapi_python_generated.V11GetApi(api_client)
include_profile_interstitial_type = 1 # int | (default to 1)
include_blocking = 1 # int | (default to 1)
include_blocked_by = 1 # int | (default to 1)
include_followed_by = 1 # int | (default to 1)
include_want_retweets = 1 # int | (default to 1)
include_mute_edge = 1 # int | (default to 1)
include_can_dm = 1 # int | (default to 1)
include_can_media_tag = 1 # int | (default to 1)
include_ext_has_nft_avatar = 1 # int | (default to 1)
include_ext_is_blue_verified = 1 # int | (default to 1)
include_ext_verified_type = 1 # int | (default to 1)
include_ext_profile_image_shape = 1 # int | (default to 1)
skip_status = 1 # int | (default to 1)
cursor = -1 # int | (default to -1)
user_id = '44196397' # str | (default to '44196397')
count = 3 # int | (default to 3)
with_total_count = True # bool | (default to True)
try:
api_instance.get_friends_following_list(include_profile_interstitial_type, include_blocking, include_blocked_by, include_followed_by, include_want_retweets, include_mute_edge, include_can_dm, include_can_media_tag, include_ext_has_nft_avatar, include_ext_is_blue_verified, include_ext_verified_type, include_ext_profile_image_shape, skip_status, cursor, user_id, count, with_total_count)
except Exception as e:
print("Exception when calling V11GetApi->get_friends_following_list: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| include_profile_interstitial_type | int | [default to 1] | |
| include_blocking | int | [default to 1] | |
| include_blocked_by | int | [default to 1] | |
| include_followed_by | int | [default to 1] | |
| include_want_retweets | int | [default to 1] | |
| include_mute_edge | int | [default to 1] | |
| include_can_dm | int | [default to 1] | |
| include_can_media_tag | int | [default to 1] | |
| include_ext_has_nft_avatar | int | [default to 1] | |
| include_ext_is_blue_verified | int | [default to 1] | |
| include_ext_verified_type | int | [default to 1] | |
| include_ext_profile_image_shape | int | [default to 1] | |
| skip_status | int | [default to 1] | |
| cursor | int | [default to -1] | |
| user_id | str | [default to '44196397'] | |
| count | int | [default to 3] | |
| with_total_count | bool | [default to True] |
Return type
void (empty response body)
Authorization
Accept, ClientLanguage, Priority, Referer, SecFetchDest, SecChUaPlatform, SecFetchMode, CsrfToken, ClientUuid, BearerAuth, GuestToken, SecChUa, CookieGt0, ClientTransactionId, ActiveUser, CookieCt0, UserAgent, AcceptLanguage, SecFetchSite, AuthType, CookieAuthToken, SecChUaMobile, AcceptEncoding
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful operation | * x-connection-hash - * x-rate-limit-limit - * x-rate-limit-remaining - * x-rate-limit-reset - * x-response-time - * x-tfe-preserve-body - * x-transaction-id - * x-twitter-response-tags - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
get_search_typeahead
get_search_typeahead(include_ext_is_blue_verified, include_ext_verified_type, include_ext_profile_image_shape, q, src, result_type)
get search typeahead
Example
- Api Key Authentication (Accept):
- Api Key Authentication (ClientLanguage):
- Api Key Authentication (Priority):
- Api Key Authentication (Referer):
- Api Key Authentication (SecFetchDest):
- Api Key Authentication (SecChUaPlatform):
- Api Key Authentication (SecFetchMode):
- Api Key Authentication (CsrfToken):
- Api Key Authentication (ClientUuid):
- Bearer Authentication (BearerAuth):
- Api Key Authentication (GuestToken):
- Api Key Authentication (SecChUa):
- Api Key Authentication (CookieGt0):
- Api Key Authentication (ClientTransactionId):
- Api Key Authentication (ActiveUser):
- Api Key Authentication (CookieCt0):
- Api Key Authentication (UserAgent):
- Api Key Authentication (AcceptLanguage):
- Api Key Authentication (SecFetchSite):
- Api Key Authentication (AuthType):
- Api Key Authentication (CookieAuthToken):
- Api Key Authentication (SecChUaMobile):
- Api Key Authentication (AcceptEncoding):
import twitter_openapi_python_generated
from twitter_openapi_python_generated.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://x.com/i/api
# See configuration.py for a list of all supported configuration parameters.
configuration = twitter_openapi_python_generated.Configuration(
host = "https://x.com/i/api"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: Accept
configuration.api_key['Accept'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Accept'] = 'Bearer'
# Configure API key authorization: ClientLanguage
configuration.api_key['ClientLanguage'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ClientLanguage'] = 'Bearer'
# Configure API key authorization: Priority
configuration.api_key['Priority'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Priority'] = 'Bearer'
# Configure API key authorization: Referer
configuration.api_key['Referer'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Referer'] = 'Bearer'
# Configure API key authorization: SecFetchDest
configuration.api_key['SecFetchDest'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SecFetchDest'] = 'Bearer'
# Configure API key authorization: SecChUaPlatform
configuration.api_key['SecChUaPlatform'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SecChUaPlatform'] = 'Bearer'
# Configure API key authorization: SecFetchMode
configuration.api_key['SecFetchMode'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SecFetchMode'] = 'Bearer'
# Configure API key authorization: CsrfToken
configuration.api_key['CsrfToken'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CsrfToken'] = 'Bearer'
# Configure API key authorization: ClientUuid
configuration.api_key['ClientUuid'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ClientUuid'] = 'Bearer'
# Configure Bearer authorization: BearerAuth
configuration = twitter_openapi_python_generated.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Configure API key authorization: GuestToken
configuration.api_key['GuestToken'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['GuestToken'] = 'Bearer'
# Configure API key authorization: SecChUa
configuration.api_key['SecChUa'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SecChUa'] = 'Bearer'
# Configure API key authorization: CookieGt0
configuration.api_key['CookieGt0'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CookieGt0'] = 'Bearer'
# Configure API key authorization: ClientTransactionId
configuration.api_key['ClientTransactionId'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ClientTransactionId'] = 'Bearer'
# Configure API key authorization: ActiveUser
configuration.api_key['ActiveUser'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ActiveUser'] = 'Bearer'
# Configure API key authorization: CookieCt0
configuration.api_key['CookieCt0'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CookieCt0'] = 'Bearer'
# Configure API key authorization: UserAgent
configuration.api_key['UserAgent'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['UserAgent'] = 'Bearer'
# Configure API key authorization: AcceptLanguage
configuration.api_key['AcceptLanguage'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AcceptLanguage'] = 'Bearer'
# Configure API key authorization: SecFetchSite
configuration.api_key['SecFetchSite'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SecFetchSite'] = 'Bearer'
# Configure API key authorization: AuthType
configuration.api_key['AuthType'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AuthType'] = 'Bearer'
# Configure API key authorization: CookieAuthToken
configuration.api_key['CookieAuthToken'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CookieAuthToken'] = 'Bearer'
# Configure API key authorization: SecChUaMobile
configuration.api_key['SecChUaMobile'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SecChUaMobile'] = 'Bearer'
# Configure API key authorization: AcceptEncoding
configuration.api_key['AcceptEncoding'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AcceptEncoding'] = 'Bearer'
# Enter a context with an instance of the API client
with twitter_openapi_python_generated.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = twitter_openapi_python_generated.V11GetApi(api_client)
include_ext_is_blue_verified = 1 # int | (default to 1)
include_ext_verified_type = 1 # int | (default to 1)
include_ext_profile_image_shape = 1 # int | (default to 1)
q = 'test' # str | (default to 'test')
src = 'search_box' # str | (default to 'search_box')
result_type = 'events,users,topics' # str | (default to 'events,users,topics')
try:
api_instance.get_search_typeahead(include_ext_is_blue_verified, include_ext_verified_type, include_ext_profile_image_shape, q, src, result_type)
except Exception as e:
print("Exception when calling V11GetApi->get_search_typeahead: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| include_ext_is_blue_verified | int | [default to 1] | |
| include_ext_verified_type | int | [default to 1] | |
| include_ext_profile_image_shape | int | [default to 1] | |
| q | str | [default to 'test'] | |
| src | str | [default to 'search_box'] | |
| result_type | str | [default to 'events,users,topics'] |
Return type
void (empty response body)
Authorization
Accept, ClientLanguage, Priority, Referer, SecFetchDest, SecChUaPlatform, SecFetchMode, CsrfToken, ClientUuid, BearerAuth, GuestToken, SecChUa, CookieGt0, ClientTransactionId, ActiveUser, CookieCt0, UserAgent, AcceptLanguage, SecFetchSite, AuthType, CookieAuthToken, SecChUaMobile, AcceptEncoding
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful operation | * x-connection-hash - * x-rate-limit-limit - * x-rate-limit-remaining - * x-rate-limit-reset - * x-response-time - * x-tfe-preserve-body - * x-transaction-id - * x-twitter-response-tags - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]