terraform-provider-x-twitter-scraper

command module
v0.3.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 24, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

README

Xquik Terraform Provider for X (Twitter) Automation

CI CodeQL OpenSSF Best Practices

Manage Xquik monitors, signed webhooks, content workflows, and X write actions through Terraform.

This provider turns supported Xquik API objects into reviewable infrastructure. Use it only for objects Terraform should own across runs.

Quickstart | Provider Docs | Examples | REST API | OpenAPI | Security

What Does This Provider Manage?

Use resources for desired state and durable write records.

Workflow Resources
Compose and refine posts compose, draft, style
Monitor accounts and keywords monitor, monitor_keyword
Deliver signed events webhook
Publish and delete posts x_tweet, x_tweet_delete
Like, unlike, repost, and undo reposts x_tweet_like, x_tweet_unlike, x_tweet_retweet, x_tweet_unretweet
Follow, unfollow, and remove followers x_user_follow, x_user_unfollow, x_user_remove_follower
Send direct messages and upload media x_dm, x_media
Update profiles, avatars, and banners x_profile, x_profile_avatar, x_profile_banner
Create, delete, join, and leave communities x_community, x_community_delete, x_community_join, x_community_leave
Request support and guest checkout support_ticket, guest_wallet

Every X write resource stores the canonical write-action response.

It never retries an uncertain dispatch with a different idempotency key.

What Can Terraform Read?

The provider exposes these data sources:

  • Account usage and limits: account
  • Drafts and writing styles: draft, style
  • Account and keyword monitors: monitor, monitor_keyword
  • Events and giveaway draws: event, draw
  • Tweet, user, and account lookups: x_tweet, x_user, x_account
  • Durable write status: x_write_action
  • Support requests: support_ticket

See the generated documentation for every field.

Is This a Tweet Search or Timeline Scraper?

No. Terraform manages durable infrastructure and write records.

Use the Xquik REST API for read jobs.

Those APIs cover tweet search, timeline extraction, and follower exports.

They fit questions such as:

  • How can I search tweets without the official Twitter API?
  • Which X API alternative returns structured tweet data?
  • How do I extract an X or Twitter timeline?
  • How do I export X followers or followings?

Use an Xquik SDK when application code needs a search tweets API.

Use this provider when Terraform should manage the surrounding automation.

Install

This provider requires Terraform CLI 1.0 or newer.

terraform {
  required_providers {
    x-twitter-scraper = {
      source  = "Xquik-dev/x-twitter-scraper"
      version = "~> 0.3.1"
    }
  }
}

provider "x-twitter-scraper" {}

Then run:

terraform init

Authenticate

Prefer environment variables:

export X_TWITTER_SCRAPER_API_KEY="your-api-key"

Bearer authentication uses X_TWITTER_SCRAPER_BEARER_TOKEN.

Never commit credentials or Terraform state.

Publish a Tweet Safely

Use one stable idempotency key per intended write.

resource "x-twitter-scraper_x_tweet" "announcement" {
  account         = "@example"
  idempotency_key = "terraform-announcement-v1"
  payload_json = jsonencode({
    text = "Published through the Xquik Terraform provider."
  })
}

Changing the request replaces the resource and requires a new key.

Reliability and Security

CI enforces formatting, module integrity, race detection, and Windows compilation.

It enforces 90% statement coverage and 80% branch coverage.

It also scans reachable vulnerabilities.

Release builds use pinned actions, signed checksums, and GitHub attestations.

See OpenSSF evidence for the current criteria assessment.

Treat plans and state as sensitive because API responses can contain private data.

Report vulnerabilities through GitHub private reporting.

Development

./scripts/bootstrap
./scripts/lint
./scripts/test

See CONTRIBUTING.md before changing generated code.

Xquik is an independent third-party service. Not affiliated with X Corp. "Twitter" and "X" are trademarks of X Corp.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL