twitterapi-io
Use the installed twitterapi-io CLI for read-only twitterapi.io access.
This skill exists to make common twitterapi.io reads simple and low-noise instead of rebuilding custom API calls each time.
Quick rules
- Use this skill only for reads.
- Do not improvise posting/like/reply/delete flows.
- Prefer compact JSON output by default.
- Use
--rawonly when you actually need full API objects. - Prefer the official docs links in
references/links.mdwhen validating endpoint behavior.
Installation preference
Prefer an installed CLI over hardcoded script paths.
Preferred install:
pipx install git+https://github.com/ropl-btc/twitterapi-io-cli.git
Fallback inside a repo checkout:
pip install .
After install, use:
twitterapi-io
Commands
Show built-in help
twitterapi-io help
Authenticate once
twitterapi-io auth --api-key YOUR_KEY
You can also use env:
export TWITTERAPI_IO_KEY='YOUR_KEY'
Fetch one tweet
twitterapi-io tweet --url 'https://x.com/jack/status/20'
or:
twitterapi-io tweet --id 20
Fetch one user
twitterapi-io user --username OpenAI
Fetch recent tweets for a user
twitterapi-io user-tweets --username OpenAI --limit 10
Include replies:
twitterapi-io user-tweets --username OpenAI --limit 10 --include-replies
Fetch replies to a tweet
twitterapi-io replies --url 'https://x.com/jack/status/20' --limit 20
Optional unix-time filters:
twitterapi-io replies --id 20 --since-time 1741219200 --until-time 1741305600 --limit 20
Fetch quote tweets
twitterapi-io quotes --id 20 --limit 20
Fetch thread context
twitterapi-io thread-context --id 20 --limit 40
Fetch mentions for a user
twitterapi-io mentions --username OpenAI --limit 20
Advanced search
twitterapi-io search --query 'AI agents -filter:replies' --from-user OpenAI --within-time 24h --max-tweets 50
Use Top results when needed:
twitterapi-io search --query 'AI agents' --queryType Top --max-pages 2
Use explicit unix-time operators when needed:
twitterapi-io search --query '$BTC' --since-time 1741219200 --until-time 1741305600 --max-tweets 50
Workflow
- Read
references/links.mdif you need the underlying official twitterapi.io docs links. - Ensure the
twitterapi-ioCLI is installed. - Ensure the API key exists via
author env. - Use
tweet,user,user-tweets,replies,quotes,thread-context,mentions, orsearchas needed. - Keep reads narrow and intentional.
Expected outputs
The CLI returns JSON. Parse it instead of scraping human text.
Default output is compact and low-noise.
Use --raw when full endpoint payloads are actually needed.
Files
- Package repo:
https://github.com/ropl-btc/twitterapi-io-cli - Compatibility wrapper:
scripts/twitterapi_io.py - Official docs links:
references/links.md - Config storage:
~/.config/twitterapi-io/config.json
When to stop and ask
Stop and ask before:
- adding write/posting capabilities
- adding login-cookie flows
- adding broad/high-cost scraping defaults
- changing how API key storage works