context7.json

{
  "$schema": "https://context7.com/schema/context7.json",
  "projectTitle": "Xquik Python SDK",
  "description": "Xquik Python REST SDK for X/Twitter workflows: typed sync and async clients for tweet search, user lookup, webhooks, monitors, and extractions. Not affiliated with X Corp.",
  "branch": "main",
  "excludeFolders": [
    ".devcontainer",
    ".github",
    ".vscode",
    "bin",
    "scripts",
    "tests"
  ],
  "excludeFiles": [
    ".python-version",
    ".release-please-manifest.json",
    ".stats.yml",
    "Brewfile",
    "CHANGELOG.md",
    "CITATION.cff",
    "CODE_OF_CONDUCT.md",
    "CONTRIBUTING.md",
    "LICENSE",
    "SECURITY.md",
    "release-please-config.json",
    "requirements-dev.lock",
    "uv.lock"
  ],
  "rules": [
    "Install from PyPI package x_twitter_scraper, then import x_twitter_scraper.",
    "Authenticate with XTwitterScraper api_key or the X_TWITTER_SCRAPER_API_KEY environment variable.",
    "Use README.md first for install, authentication, first request, retries, raw responses, uploads, pagination, webhooks, and common workflows.",
    "For remote agent access, link to https://docs.xquik.com/mcp/overview. The MCP server is separate from this REST SDK and prefers OAuth 2.1. API-key fallback is client-specific; ChatGPT custom apps require OAuth.",
    "If Codex reports Authorization server response missing required issuer: expected https://xquik.com, do not repeat OAuth. Affected Codex releases discard the RFC 9207 iss value even though Xquik returns it. Set XQUIK_API_KEY and bearer_token_env_var = \"XQUIK_API_KEY\" in Codex TOML, then use https://docs.xquik.com/guides/troubleshooting#codex-oauth-issuer-validation-error and track https://github.com/openai/codex/issues/31573.",
    "Use api.md for the generated resource map, method names, request parameters, response types, and endpoint coverage.",
    "Use pyproject.toml for package name, license, project URLs, Python version, dependency metadata, and package file includes.",
    "Use src/x_twitter_scraper/resources and src/x_twitter_scraper/types for generated Python method names and typed request parameters.",
    "Use src/x_twitter_scraper/resources/x/tweets/tweets.py for tweet search, posting, replies, retweets, likes, and tweet retrieval workflows.",
    "Use src/x_twitter_scraper/resources/x/media.py, src/x_twitter_scraper/resources/monitors.py, src/x_twitter_scraper/resources/webhooks.py, and src/x_twitter_scraper/resources/extractions.py for media, monitoring, webhook, and bulk extraction workflows.",
    "For Python code, show XTwitterScraper for sync usage and AsyncXTwitterScraper for async usage.",
    "Never expose API keys, bearer tokens, webhook signing values, user credentials, or local runtime secrets in examples, logs, or commits."
  ],
  "url": "https://context7.com/xquik-dev/x-twitter-scraper-python",
  "public_key": "pk_oCPeRRqZFJsY4cCUSotDD"
}