Skip to main content

twitter_openapi_python

Twitter scraping with data validation by pydantic.

1691572735537

Setup

pip install twitter-openapi-python

Usage

import json
import datetime

from pathlib import Path
from tweepy_authlib import CookieSessionUserHandler
from twitter_openapi_python import TwitterOpenapiPython

# login by tweepy_authlib
if Path("cookie.json").exists():
    with open("cookie.json", "r") as f:
        cookies_dict = json.load(f)
        if isinstance(cookies_dict, list):
            cookies_dict = {k["name"]: k["value"] for k in cookies_dict}
else:
    auth_handler = CookieSessionUserHandler(
        screen_name=input("screen_name: "),
        password=input("password: "),
    )
    cookies_dict = auth_handler.get_cookies().get_dict()

# To extract cookies from Windows (Linux by default)
# If you use tweepy_authlib, you must be on Windows
client = TwitterOpenapiPython()
client.additional_api_headers = {
    "sec-ch-ua-platform": '"Windows"',
}
client.additional_browser_headers = {
    "sec-ch-ua-platform": '"Windows"',
}

# get client from cookies
𝕏 = client.get_client_from_cookies(cookies=cookies_dict)

# tweet "Hello World!!" with current time
time = datetime.datetime.now().strftime("%Y-%m-%dT%H:%M:%SZ")
𝕏.get_post_api().post_create_tweet(tweet_text=f"Hello World!!{time}")

# get user info
response = 𝕏.get_user_api().get_user_by_screen_name("elonmusk")

Login

from twitter_openapi_python import TwitterOpenapiPython

# guest client
𝕏 = TwitterOpenapiPython().get_guest_client()
tweet = 𝕏.get_default_api().get_tweet_result_by_rest_id("1349129669258448897")
assert tweet.data is not None
assert tweet.data.tweet.legacy is not None
print(tweet.data.tweet.legacy.full_text)

Multiple OS

The Token can only be used on the same OS that issued the Token In other words, if the sec-ch-ua-platform does not match, the Token cannot be used. This library uses the Linux Chrome header by default. To use Token issued by Windows, do the following.

client = TwitterOpenapiPython()
client.additional_api_headers = {
  "sec-ch-ua-platform": '"Windows"',
};

Endpoint

The generated client accepts any host that keeps X's path shape (/graphql/{queryId}/{operationName}, /1.1/..., /2/... under https://x.com/i/api). Build the ApiClient yourself and hand it to get_twitter_openapi_python_client; the login helpers are not involved, so cookies and headers are then up to you (or to whatever answers at that host). For example, twitter_api_safe_relay answers at http://localhost:3000/i/api with a logged-in browser session.

import twitter_openapi_python_generated as twitter
from twitter_openapi_python import TwitterOpenapiPython

api_client = twitter.ApiClient(twitter.Configuration(host="http://localhost:3000/i/api"))
client = TwitterOpenapiPython().get_twitter_openapi_python_client(api_client)
response = client.get_user_api().get_user_by_screen_name(screen_name="elonmusk")

Development

cd twitter_openapi_python
uv sync
uv run pytest test/api
uv build
uv publish

License

This project is dual licensed. You can choose one of the following licenses:

Metadata

Release files for twitter-openapi-python 0.1.4

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 0.1.4
File Size Uploaded Provenance Actions
twitter_openapi_python-0.1.4.tar.gz 32.7 kB With provenance Details for twitter_openapi_python-0.1.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for twitter-openapi-python 0.1.4
File Interpreter ABI Platform Actions
twitter_openapi_python-0.1.4-py3-none-any.whl Python 3 none any Details for twitter_openapi_python-0.1.4-py3-none-any.whl

Total release size: 74.4 kB

Release files / twitter_openapi_python-0.1.4.tar.gz

Download URL twitter_openapi_python-0.1.4.tar.gz
Size 32.7 kB
Tags Source
SHA-256 checksum
How to use checksums
616ad9bf559e2088f2b9a173a191f56020649e9ce303ca745823255107b3688f
BLAKE2b-256 checksum
How to use checksums
0d3b23e52839f0ca1a227b23ed9a790adc0f15fd91ad0b1d39c36d32e39cbff7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 30, 2026.

Transparency log

Release files / twitter_openapi_python-0.1.4-py3-none-any.whl

Download URL twitter_openapi_python-0.1.4-py3-none-any.whl
Size 41.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5d6bf6fd3716f8dbcd3537fc7044e5ea03f2540ef5d8fbbd94aaff207f17d6cf
BLAKE2b-256 checksum
How to use checksums
c92940a68ac763945e73503c5f7d198fc2b9994d01c6b2b6a32ca02c3333cb82
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 30, 2026.

Transparency log

Security for twitter-openapi-python 0.1.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for twitter_openapi_python-0.1.4.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 30, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.4 This release

2 release files Full provenance

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