terraform-provider-x-twitter-scraper

README

X (Twitter) Scraper Terraform Provider: Monitors, Webhooks, Tweet Actions & Automation

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

Xquik Terraform Provider for the X (Twitter) Scraper API manages Twitter automation and X data workflows as infrastructure: monitors, HMAC webhooks, API keys, compose and draft resources, tweet actions, user data, giveaway draws, follower exports, and extraction jobs.

Use it when Terraform should own Xquik API resources for social media automation, account monitoring, webhook delivery, tweet search workflows, profile tweet collection, follower export jobs, and repeatable posting infrastructure. Start with the Terraform quickstart, Context7 guide, generated provider docs, examples, or the REST API docs.

Terraform Quickstart | Context7 Guide | Provider Docs | Examples | REST API Docs | OpenAPI Spec | Webhooks

It is generated with Stainless.

Requirements

This provider requires Terraform CLI 1.0 or later. You can install it for your system on HashiCorp's website.

Usage

Add the provider to your Terraform project:

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

provider "x-twitter-scraper" {
  # Prefer X_TWITTER_SCRAPER_API_KEY or X_TWITTER_SCRAPER_BEARER_TOKEN.
}

Initialize your project by running terraform init in the directory.

Additional examples can be found in the ./examples folder within this repository, and you can refer to the full documentation on the Terraform Registry.

Provider Options

When you initialize the provider, the following options are supported. It is recommended to use environment variables for sensitive values like access tokens. If an environment variable is provided, then the option does not need to be set in the terraform source.

Property	Environment variable	Required	Default value
bearer_token	X_TWITTER_SCRAPER_BEARER_TOKEN	false	None
api_key	X_TWITTER_SCRAPER_API_KEY	false	None

Semantic versioning

This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

1. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals.)
2. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.

Contributing

See the contributing documentation.