X Twitter Scraper Terraform Provider

The X Twitter Scraper Terraform provider provides convenient access to the X Twitter Scraper REST API from Terraform.

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

Terraform Registry publication is pending. Until the provider is listed there, build it locally and use a Terraform CLI development override.

Build the provider binary:

./scripts/build

Move the generated binary into a local plugin directory:

mkdir -p ~/.terraform.d/plugins/xquik-dev/x-twitter-scraper/0.2.0/darwin_arm64
mv terraform-provider-x-twitter-scraper ~/.terraform.d/plugins/xquik-dev/x-twitter-scraper/0.2.0/darwin_arm64/

Use the matching platform directory for your system, such as linux_amd64, linux_arm64, darwin_amd64, darwin_arm64, or windows_amd64.

Add this development override to ~/.terraformrc:

provider_installation {
  dev_overrides {
    "Xquik-dev/x-twitter-scraper" = "/Users/you/.terraform.d/plugins/xquik-dev/x-twitter-scraper/0.2.0/darwin_arm64"
  }

  direct {}
}

Then add the provider to your Terraform project:

terraform {
  required_providers {
    x-twitter-scraper = {
      source = "Xquik-dev/x-twitter-scraper"
    }
  }
}

provider "x-twitter-scraper" {
  api_key = "My API Key" # or set X_TWITTER_SCRAPER_API_KEY env variable
  bearer_token = "My Bearer Token" # or set X_TWITTER_SCRAPER_BEARER_TOKEN env variable
}

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 generated provider documentation in ./docs.

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.