twitter_openapi_python_generated

Twitter OpenAPI(Swagger) specification

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 0.0.1
  • Package version: 0.0.34
  • Generator version: 7.22.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.10+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/fa0311/twitter_openapi_python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/fa0311/twitter_openapi_python.git)

Then import the package:

import twitter_openapi_python_generated

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import twitter_openapi_python_generated

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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.DefaultApi(api_client)
    path_query_id = 'mzoqrVGwk-YTSGME1dRfXQ' # str |  (default to 'mzoqrVGwk-YTSGME1dRfXQ')
    variables = '{"screen_name": "elonmusk"}' # str |  (default to '{"screen_name": "elonmusk"}')
    features = '{}' # str |  (default to '{}')

    try:
        api_response = api_instance.get_profile_spotlights_query(path_query_id, variables, features)
        print("The response of DefaultApi->get_profile_spotlights_query:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->get_profile_spotlights_query: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://x.com/i/api

Class Method HTTP request Description
DefaultApi get_profile_spotlights_query GET /graphql/{pathQueryId}/ProfileSpotlightsQuery
DefaultApi get_tweet_result_by_rest_id GET /graphql/{pathQueryId}/TweetResultByRestId
OtherApi other GET /other
PostApi post_create_bookmark POST /graphql/{pathQueryId}/CreateBookmark
PostApi post_create_retweet POST /graphql/{pathQueryId}/CreateRetweet
PostApi post_create_tweet POST /graphql/{pathQueryId}/CreateTweet
PostApi post_delete_bookmark POST /graphql/{pathQueryId}/DeleteBookmark
PostApi post_delete_retweet POST /graphql/{pathQueryId}/DeleteRetweet
PostApi post_delete_tweet POST /graphql/{pathQueryId}/DeleteTweet
PostApi post_favorite_tweet POST /graphql/{pathQueryId}/FavoriteTweet
PostApi post_unfavorite_tweet POST /graphql/{pathQueryId}/UnfavoriteTweet
TweetApi get_bookmarks GET /graphql/{pathQueryId}/Bookmarks
TweetApi get_community_about_timeline GET /graphql/{pathQueryId}/CommunityAboutTimeline
TweetApi get_community_media_timeline GET /graphql/{pathQueryId}/CommunityMediaTimeline
TweetApi get_community_tweets_timeline GET /graphql/{pathQueryId}/CommunityTweetsTimeline
TweetApi get_home_latest_timeline GET /graphql/{pathQueryId}/HomeLatestTimeline
TweetApi get_home_timeline GET /graphql/{pathQueryId}/HomeTimeline
TweetApi get_likes GET /graphql/{pathQueryId}/Likes
TweetApi get_list_latest_tweets_timeline GET /graphql/{pathQueryId}/ListLatestTweetsTimeline
TweetApi get_notifications_timeline GET /graphql/{pathQueryId}/NotificationsTimeline
TweetApi get_search_timeline GET /graphql/{pathQueryId}/SearchTimeline
TweetApi get_tweet_detail GET /graphql/{pathQueryId}/TweetDetail
TweetApi get_user_highlights_tweets GET /graphql/{pathQueryId}/UserHighlightsTweets
TweetApi get_user_media GET /graphql/{pathQueryId}/UserMedia
TweetApi get_user_tweets GET /graphql/{pathQueryId}/UserTweets
TweetApi get_user_tweets_and_replies GET /graphql/{pathQueryId}/UserTweetsAndReplies
UserApi get_user_by_rest_id GET /graphql/{pathQueryId}/UserByRestId
UserApi get_user_by_screen_name GET /graphql/{pathQueryId}/UserByScreenName
UserListApi get_blue_verified_followers GET /graphql/{pathQueryId}/BlueVerifiedFollowers
UserListApi get_favoriters GET /graphql/{pathQueryId}/Favoriters
UserListApi get_followers GET /graphql/{pathQueryId}/Followers
UserListApi get_followers_you_know GET /graphql/{pathQueryId}/FollowersYouKnow
UserListApi get_following GET /graphql/{pathQueryId}/Following
UserListApi get_retweeters GET /graphql/{pathQueryId}/Retweeters
UsersApi get_users_by_rest_ids GET /graphql/{pathQueryId}/UsersByRestIds
V11GetApi get_friends_following_list GET /1.1/friends/following/list.json
V11GetApi get_search_typeahead GET /1.1/search/typeahead.json
V11PostApi post_create_friendships POST /1.1/friendships/create.json
V11PostApi post_destroy_friendships POST /1.1/friendships/destroy.json
V20GetApi get_search_adaptive GET /2/search/adaptive.json

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

Accept

  • Type: API key
  • API key parameter name: Accept
  • Location: HTTP header

AcceptEncoding

  • Type: API key
  • API key parameter name: Accept-Encoding
  • Location: HTTP header

AcceptLanguage

  • Type: API key
  • API key parameter name: Accept-Language
  • Location: HTTP header

ActiveUser

  • Type: API key
  • API key parameter name: x-twitter-active-user
  • Location: HTTP header

AuthType

  • Type: API key
  • API key parameter name: x-twitter-auth-type
  • Location: HTTP header

BearerAuth

  • Type: Bearer authentication

ClientLanguage

  • Type: API key
  • API key parameter name: x-twitter-client-language
  • Location: HTTP header

ClientTransactionId

  • Type: API key
  • API key parameter name: x-client-transaction-id
  • Location: HTTP header

ClientUuid

  • Type: API key
  • API key parameter name: x-client-uuid
  • Location: HTTP header

CookieAuthToken

  • Type: API key
  • API key parameter name: auth_token
  • Location:

CookieCt0

  • Type: API key
  • API key parameter name: ct0
  • Location:

CookieGt0

  • Type: API key
  • API key parameter name: gt0
  • Location:

CsrfToken

  • Type: API key
  • API key parameter name: x-csrf-token
  • Location: HTTP header

GuestToken

  • Type: API key
  • API key parameter name: x-guest-token
  • Location: HTTP header

Priority

  • Type: API key
  • API key parameter name: Priority
  • Location: HTTP header

Referer

  • Type: API key
  • API key parameter name: Referer
  • Location: HTTP header

SecChUa

  • Type: API key
  • API key parameter name: Sec-Ch-Ua
  • Location: HTTP header

SecChUaMobile

  • Type: API key
  • API key parameter name: Sec-Ch-Ua-Mobile
  • Location: HTTP header

SecChUaPlatform

  • Type: API key
  • API key parameter name: Sec-Ch-Ua-Platform
  • Location: HTTP header

SecFetchDest

  • Type: API key
  • API key parameter name: Sec-Fetch-Dest
  • Location: HTTP header

SecFetchMode

  • Type: API key
  • API key parameter name: Sec-Fetch-Mode
  • Location: HTTP header

SecFetchSite

  • Type: API key
  • API key parameter name: Sec-Fetch-Site
  • Location: HTTP header

UserAgent

  • Type: API key
  • API key parameter name: user-agent
  • Location: HTTP header

Author

yuki@yuki0311.com

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for fa0311 from gravatar.com fa0311

Credits

Author: OpenAPI Generator community

License

LicenseRef-Custom OR AGPL-3.0-or-later

Requires

Python >=3.9

Tags

OpenAPI OpenAPI-Generator Twitter OpenAPI

Report project as malware

Metadata

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for fa0311 from gravatar.com fa0311

Credits

Author: OpenAPI Generator community

License

LicenseRef-Custom OR AGPL-3.0-or-later

Requires

Python >=3.9

Tags

OpenAPI OpenAPI-Generator Twitter OpenAPI

Report project as malware

Release files for twitter-openapi-python-generated 0.0.34

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for twitter-openapi-python-generated 0.0.34
File Size Uploaded
twitter_openapi_python_generated-0.0.34.tar.gz 309.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for twitter-openapi-python-generated 0.0.34
File Interpreter ABI Platform
twitter_openapi_python_generated-0.0.34-py3-none-any.whl 580.1 kB Python 3 none any Details

Total release size: 889.5 kB

Release files / twitter_openapi_python_generated-0.0.34.tar.gz

Download URL twitter_openapi_python_generated-0.0.34.tar.gz
Size 309.4 kB
Tags Source
SHA-256 checksum
How to use checksums 		d2c5d282df1606211b274812a54edaeccc8cf54ab541879fef1b1ff7587c832a
BLAKE2b-256 checksum
How to use checksums 		5f6b4fcf1d01488b5a4db10af0bf6da8ca78dbd7e5328438cf511c80cf113479
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via twine/6.2.0 CPython/3.14.5

Release files / twitter_openapi_python_generated-0.0.34-py3-none-any.whl

Download URL twitter_openapi_python_generated-0.0.34-py3-none-any.whl
Size 580.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums 		24fe5968b7e1c850869b2c48b36cc98198f0e80eaf14d42701f544ca2b3e424b
BLAKE2b-256 checksum
How to use checksums 		6e5aae888b62549c5a0ba1670052e69c160e1afcf6105f8ba15e8ce162e5dacb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via twine/6.2.0 CPython/3.14.5
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page