X Twitter Scraper Terraform Provider

https://github.com/xquik-dev/terraform-provider-x-twitter-scraper
Admin
The X Twitter Scraper Terraform provider provides convenient access to the X Twitter Scraper REST...
Tokens:10,875
Snippets:84
Trust Score:5.5
License:Apache-2.0
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install the Xquik provider

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/docs/CONTEXT7.md

Define the required provider in your Terraform configuration.

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

--------------------------------

### Bootstrap and build the repository

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/CONTRIBUTING.md

Initializes the environment by downloading pinned modules and building the project.

```sh
./scripts/bootstrap
./scripts/build
```

--------------------------------

### Initialize Terraform

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/README.md

Run this command to download the provider after configuration.

```sh
terraform init
```

--------------------------------

### Verify OpenSSF compliance locally

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/OPENSSF.md

Execute these commands to run the project's bootstrap, linting, testing, license verification, and vulnerability scanning tools.

```sh
./scripts/bootstrap
./scripts/lint
./scripts/test
uvx --from reuse==5.1.1 reuse lint
go run golang.org/x/vuln/cmd/govulncheck@v1.6.0 ./...
```

--------------------------------

### Run Local Development Scripts

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/README.md

Execute bootstrap, linting, and testing scripts for local development.

```sh
./scripts/bootstrap
./scripts/lint
./scripts/test
```

--------------------------------

### Monitor an X account

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/docs/guides/quickstart.md

Create a monitor resource to track specific event types for a given username.

```hcl
resource "x-twitter-scraper_monitor" "product_updates" {
  username    = "xquik"
  event_types = ["tweet.new"]
}
```

--------------------------------

### Set Authentication Environment Variable

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/README.md

Configure the API key for authentication via environment variables.

```sh
export X_TWITTER_SCRAPER_API_KEY="your-api-key"
```

--------------------------------

### Configure X Twitter Scraper Provider

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/docs/index.md

Initialize the provider block. It is recommended to use environment variables for sensitive credentials.

```terraform
# SPDX-FileCopyrightText: 2026 Xquik contributors
#
# SPDX-License-Identifier: Apache-2.0

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

--------------------------------

### Monitor accounts and deliver events

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/docs/CONTEXT7.md

Define monitor and webhook resources to track account activity.

```hcl
resource "x-twitter-scraper_monitor" "product_updates" {
  username    = "xquik"
  event_types = ["tweet.new"]
}

resource "x-twitter-scraper_webhook" "events" {
  url         = "https://example.com/xquik/webhook"
  event_types = ["tweet.new"]
}
```

--------------------------------

### Run acceptance tests

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/CONTRIBUTING.md

Executes tests that may create remote resources; requires an isolated account.

```sh
TF_ACC=1 ./scripts/test
```

--------------------------------

### Register a signed webhook

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/docs/guides/quickstart.md

Configure a webhook to receive event notifications at a specified URL.

```hcl
resource "x-twitter-scraper_webhook" "events" {
  url         = "https://example.com/xquik/webhook"
  event_types = ["tweet.new"]
}
```

--------------------------------

### Configure the provider

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/docs/CONTEXT7.md

Initialize the provider block in your Terraform configuration.

```hcl
provider "x-twitter-scraper" {}
```

--------------------------------

### x-twitter-scraper_monitor Resource Schema

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/docs/resources/monitor.md

Defines the configuration schema for the x-twitter-scraper_monitor resource, including required and optional parameters.

```APIDOC
## Resource: x-twitter-scraper_monitor

### Description
Configures X account monitoring with 1-second check intervals.

### Required Parameters
- **event_types** (List of String) - Array of event types to subscribe to.
- **username** (String) - X username (without @).

### Optional Parameters
- **is_active** (Boolean) - Determines if the monitor is currently active.

### Read-Only Attributes
- **created_at** (String) - Timestamp of resource creation.
- **id** (String) - Unique identifier for the resource.
- **next_billing_at** (String) - Next hourly credit charge time.
- **paused_at** (String) - Timestamp when the monitor was automatically paused.
- **paused_reason** (String) - Reason for automatic pause (e.g., "x_user_not_found").
- **x_user_id** (String) - The internal X user ID.
```

--------------------------------

### Configure the Xquik Terraform Provider

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/README.md

Define the provider source and version in your Terraform configuration.

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

provider "x-twitter-scraper" {}
```

--------------------------------

### x-twitter-scraper_x_media Resource

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/docs/resources/x_media.md

This resource manages the lifecycle of an X media upload operation. It requires an account and an idempotency key to ensure request integrity.

```APIDOC
## x-twitter-scraper_x_media (Resource)

### Description
Runs one upload_media request and stores its canonical write-action record.

### Required Parameters
- **account** (String) - X account for the request.
- **idempotency_key** (String, Sensitive) - Visible ASCII key for this exact write. Reuse only to replay the identical request.

### Optional Parameters
- **payload_json** (String, Sensitive) - JSON object for this operation.
- **target_id** (String) - Tweet, user, or community ID for an operation that requires a target.

### Read-Only Attributes
- **id** (String) - Canonical write-action ID.
- **action** (String) - The action performed.
- **status** (String) - Current status of the request.
- **success** (Boolean) - Indicates if the operation was successful.
- **error** (String) - Error message if the operation failed.
- **billing_status** (String) - Status of billing for this operation.
```

--------------------------------

### x-twitter-scraper_x_tweet Resource

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/docs/resources/x_tweet.md

This resource manages the execution of a create_tweet request. It requires an account and an idempotency key, and provides read-only status and billing information upon completion.

```APIDOC
## x-twitter-scraper_x_tweet

### Description
Runs one create_tweet request and stores its canonical write-action record.

### Required Parameters
- **account** (String) - X account for the request.
- **idempotency_key** (String) - Visible ASCII key for this exact write. Reuse only to replay the identical request.

### Optional Parameters
- **payload_json** (String) - JSON object for this operation.
- **target_id** (String) - Tweet, user, or community ID for an operation that requires a target.

### Read-Only Attributes
- **action** (String)
- **billing_charged** (Boolean)
- **billing_charged_credits** (String)
- **billing_planned_credits** (String)
- **billing_status** (String)
- **charged** (Boolean)
- **charged_credits** (String)
- **error** (String)
- **id** (String) - Canonical write-action ID.
- **message** (String)
- **next_action_after_ms** (Number)
- **next_action_requires_new_idempotency_key** (Boolean)
- **next_action_type** (String)
- **next_action_url** (String)
- **object** (String)
- **poll_after_ms** (Number)
- **request_hash** (String)
- **request_id** (String)
- **request_payload_json** (String)
- **response_account_id** (String)
- **response_account_username** (String)
- **response_target_id** (String)
- **response_target_type** (String)
- **result_id** (String)
- **result_state** (String)
- **result_type** (String)
- **retryable** (Boolean)
- **safe_to_retry** (Boolean)
- **send_dispatched** (Boolean)
- **status** (String)
- **status_url** (String)
- **success** (Boolean)
- **target_id_response** (String)
- **terminal** (Boolean)
- **write_action_id** (String)
```

--------------------------------

### x-twitter-scraper_draft Resource

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/docs/resources/draft.md

The x-twitter-scraper_draft resource enables the creation and management of AI-generated tweet drafts. It requires a text input and supports optional goal and topic parameters.

```APIDOC
## Resource: x-twitter-scraper_draft

### Description
Manages AI-generated tweet drafts within the X Twitter Scraper platform.

### Schema

#### Required
- **text** (String) - The base text or prompt for the tweet draft.

#### Optional
- **goal** (String) - The objective of the tweet. Available values: "engagement", "followers", "authority", "conversation".
- **topic** (String) - The subject matter for the AI to focus on.

#### Read-Only
- **created_at** (String) - Timestamp of when the draft was created.
- **id** (String) - The unique identifier for the draft resource.
- **updated_at** (String) - Timestamp of the last update to the draft.
```

--------------------------------

### x-twitter-scraper_x_user_follow

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/docs/resources/x_user_follow.md

The x_user_follow resource executes a follow operation on X and returns the status and billing details of the action.

```APIDOC
## x-twitter-scraper_x_user_follow

### Description
Runs one follow request and stores its canonical write-action record.

### Required Parameters
- **account** (String) - X account for the request.
- **idempotency_key** (String) - Visible ASCII key for this exact write.

### Optional Parameters
- **payload_json** (String) - JSON object for this operation.
- **target_id** (String) - User ID to follow.

### Read-Only Attributes
- **action** (String)
- **billing_charged** (Boolean)
- **billing_charged_credits** (String)
- **billing_planned_credits** (String)
- **billing_status** (String)
- **charged** (Boolean)
- **charged_credits** (String)
- **error** (String)
- **id** (String)
- **message** (String)
- **next_action_after_ms** (Number)
- **next_action_requires_new_idempotency_key** (Boolean)
- **next_action_type** (String)
- **next_action_url** (String)
- **object** (String)
- **poll_after_ms** (Number)
- **request_hash** (String)
- **request_id** (String)
- **request_payload_json** (String)
- **response_account_id** (String)
- **response_account_username** (String)
- **response_target_id** (String)
- **response_target_type** (String)
- **result_id** (String)
- **result_state** (String)
- **result_type** (String)
- **retryable** (Boolean)
- **safe_to_retry** (Boolean)
- **send_dispatched** (Boolean)
- **status** (String)
- **status_url** (String)
- **success** (Boolean)
- **target_id_response** (String)
- **terminal** (Boolean)
- **write_action_id** (String)
```

--------------------------------

### x-twitter-scraper_x_community Resource

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/docs/resources/x_community.md

The x-twitter-scraper_x_community resource is used to perform a community creation operation on X. It requires an account and an idempotency key to ensure the request is processed correctly.

```APIDOC
## x-twitter-scraper_x_community

### Description
Runs one create_community request and stores its canonical write-action record.

### Required Parameters
- **account** (String) - X account for the request.
- **idempotency_key** (String) - Visible ASCII key for this exact write. Reuse only to replay the identical request.

### Optional Parameters
- **payload_json** (String) - JSON object for this operation.
- **target_id** (String) - Tweet, user, or community ID for an operation that requires a target.

### Read-Only Attributes
- **action** (String)
- **billing_charged** (Boolean)
- **billing_charged_credits** (String)
- **billing_planned_credits** (String)
- **billing_status** (String)
- **charged** (Boolean)
- **charged_credits** (String)
- **error** (String)
- **id** (String) - Canonical write-action ID.
- **message** (String)
- **next_action_after_ms** (Number)
- **next_action_requires_new_idempotency_key** (Boolean)
- **next_action_type** (String)
- **next_action_url** (String)
- **object** (String)
- **poll_after_ms** (Number)
- **request_hash** (String)
- **request_id** (String)
- **request_payload_json** (String)
- **response_account_id** (String)
- **response_account_username** (String)
- **response_target_id** (String)
- **response_target_type** (String)
- **result_id** (String)
- **result_state** (String)
- **result_type** (String)
- **retryable** (Boolean)
- **safe_to_retry** (Boolean)
- **send_dispatched** (Boolean)
- **status** (String)
- **status_url** (String)
- **success** (Boolean)
- **target_id_response** (String)
- **terminal** (Boolean)
- **write_action_id** (String)
```

--------------------------------

### Publish a Tweet Resource

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/README.md

Create a tweet using a stable idempotency key to ensure reliable execution.

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

--------------------------------

### x-twitter-scraper_monitor_keyword Resource

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/docs/resources/monitor_keyword.md

Configuration schema for the monitor_keyword resource.

```APIDOC
## Resource: x-twitter-scraper_monitor_keyword

### Description
Manages X account monitoring with 1-second checks.

### Schema

#### Required
- **event_types** (List of String) - Required - Array of event types to subscribe to.
- **query** (String) - Required - X search query to monitor. Whitespace is normalized.

#### Optional
- **is_active** (Boolean) - Optional - Status of the monitor.

#### Read-Only
- **created_at** (String) - The timestamp when the resource was created.
- **id** (String) - The unique identifier of this resource.
- **next_billing_at** (String) - Next hourly credit charge time for this keyword query monitor.
```

--------------------------------

### x-twitter-scraper_x_tweet_like (Resource)

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/docs/resources/x_tweet_like.md

The x_tweet_like resource is used to execute a like request and store the canonical write-action record.

```APIDOC
## x-twitter-scraper_x_tweet_like (Resource)

### Description
Runs one like request and stores its canonical write-action record.

### Required Parameters
- **account** (String) - X account for the request.
- **idempotency_key** (String) - Visible ASCII key for this exact write. Reuse only to replay the identical request.

### Optional Parameters
- **payload_json** (String) - JSON object for this operation.
- **target_id** (String) - Tweet, user, or community ID for an operation that requires a target.

### Read-Only Attributes
- **action** (String)
- **billing_charged** (Boolean)
- **billing_charged_credits** (String)
- **billing_planned_credits** (String)
- **billing_status** (String)
- **charged** (Boolean)
- **charged_credits** (String)
- **error** (String)
- **id** (String) - Canonical write-action ID.
- **message** (String)
- **next_action_after_ms** (Number)
- **next_action_requires_new_idempotency_key** (Boolean)
- **next_action_type** (String)
- **next_action_url** (String)
- **object** (String)
- **poll_after_ms** (Number)
- **request_hash** (String)
- **request_id** (String)
- **request_payload_json** (String)
- **response_account_id** (String)
- **response_account_username** (String)
- **response_target_id** (String)
- **response_target_type** (String)
- **result_id** (String)
- **result_state** (String)
- **result_type** (String)
- **retryable** (Boolean)
- **safe_to_retry** (Boolean)
- **send_dispatched** (Boolean)
- **status** (String)
- **status_url** (String)
- **success** (Boolean)
- **target_id_response** (String)
- **terminal** (Boolean)
- **write_action_id** (String)
```

--------------------------------

### x-twitter-scraper_x_community_join

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/docs/resources/x_community_join.md

Resource definition for joining an X community.

```APIDOC
## x-twitter-scraper_x_community_join (Resource)

### Description
Runs one join_community request and stores its canonical write-action record.

### Required Parameters
- **account** (String) - X account for the request.
- **idempotency_key** (String) - Visible ASCII key for this exact write. Reuse only to replay the identical request.

### Optional Parameters
- **payload_json** (String) - JSON object for this operation.
- **target_id** (String) - Community ID for the join operation.

### Read-Only Attributes
- **action** (String)
- **billing_charged** (Boolean)
- **billing_charged_credits** (String)
- **billing_planned_credits** (String)
- **billing_status** (String)
- **charged** (Boolean)
- **charged_credits** (String)
- **error** (String)
- **id** (String) - Canonical write-action ID.
- **message** (String)
- **next_action_after_ms** (Number)
- **next_action_requires_new_idempotency_key** (Boolean)
- **next_action_type** (String)
- **next_action_url** (String)
- **object** (String)
- **poll_after_ms** (Number)
- **request_hash** (String)
- **request_id** (String)
- **request_payload_json** (String)
- **response_account_id** (String)
- **response_account_username** (String)
- **response_target_id** (String)
- **response_target_type** (String)
- **result_id** (String)
- **result_state** (String)
- **result_type** (String)
- **retryable** (Boolean)
- **safe_to_retry** (Boolean)
- **send_dispatched** (Boolean)
- **status** (String)
- **status_url** (String)
- **success** (Boolean)
- **target_id_response** (String)
- **terminal** (Boolean)
- **write_action_id** (String)
```

--------------------------------

### Run branch coverage check

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/CONTRIBUTING.md

Executes the branch coverage gate independently.

```sh
./scripts/branch-coverage
```

--------------------------------

### Regenerate documentation

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/CONTRIBUTING.md

Updates the Terraform Registry documentation after modifying provider schemas.

```sh
./scripts/generate-docs
```

--------------------------------

### x-twitter-scraper_monitor_keyword Data Source

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/docs/data-sources/monitor_keyword.md

The x-twitter-scraper_monitor_keyword data source retrieves configuration and status details for a specific keyword monitor.

```APIDOC
## Data Source: x-twitter-scraper_monitor_keyword

### Description
Retrieves the configuration and status of a keyword monitor used for X account monitoring.

### Schema
#### Read-Only Attributes
- **created_at** (String) - The timestamp when the monitor was created.
- **event_types** (List of String) - Array of event types to subscribe to.
- **id** (String) - The unique identifier of this resource.
- **is_active** (Boolean) - Indicates if the monitor is currently active.
- **next_billing_at** (String) - Next hourly credit charge time for this keyword query monitor.
- **query** (String) - The keyword query being monitored.
```

--------------------------------

### x-twitter-scraper_x_profile Resource

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/docs/resources/x_profile.md

The x_profile resource manages the execution of profile update requests on X. It tracks the status and billing information of the write operation.

```APIDOC
## x-twitter-scraper_x_profile

### Description
Runs one update_profile request and stores its canonical write-action record.

### Schema
#### Required
- **account** (String) - Required - X account for the request.
- **idempotency_key** (String) - Required - Visible ASCII key for this exact write. Reuse only to replay the identical request.

#### Optional
- **payload_json** (String) - Optional - JSON object for this operation.
- **target_id** (String) - Optional - Tweet, user, or community ID for an operation that requires a target.

### Read-Only Attributes
- **id** (String) - Canonical write-action ID.
- **status** (String) - Current status of the write action.
- **success** (Boolean) - Indicates if the operation was successful.
- **error** (String) - Error message if the operation failed.
- **billing_charged** (Boolean) - Indicates if billing was charged for this action.
```

--------------------------------

### x-twitter-scraper_compose Resource Schema

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/docs/resources/compose.md

Schema definition for the x-twitter-scraper_compose resource, detailing required and optional fields for tweet composition and analysis.

```APIDOC
## Schema

### Required

- `step` (String) Workflow step
Available values: "compose", "refine", "score".

### Optional

- `additional_context` (String) Extra context or URLs (refine)
- `call_to_action` (String) Desired call to action (refine)
- `draft` (String) Tweet draft text to evaluate (score)
- `goal` (String) Optimization goal
Available values: "engagement", "followers", "authority", "conversation".
- `has_link` (Boolean) Whether a link is attached (score)
- `has_media` (Boolean) Whether media is attached (score)
- `media_type` (String) Media type (refine)
Available values: "photo", "video", "none".
- `style_username` (String) Cached style username for voice matching (compose)
- `tone` (String) Desired tone (refine)
- `topic` (String) Tweet topic (compose, refine)
```

--------------------------------

### x-twitter-scraper_x_dm Resource

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/docs/resources/x_dm.md

The x-twitter-scraper_x_dm resource is used to send a direct message and track the resulting write-action record.

```APIDOC
## x-twitter-scraper_x_dm (Resource)

### Description
Runs one send_dm request and stores its canonical write-action record.

### Required Parameters
- **account** (String) - X account for the request.
- **idempotency_key** (String) - Sensitive. Visible ASCII key for this exact write. Reuse only to replay the identical request.

### Optional Parameters
- **payload_json** (String) - Sensitive. JSON object for this operation.
- **target_id** (String) - Tweet, user, or community ID for an operation that requires a target.

### Read-Only Attributes
- **action** (String)
- **billing_charged** (Boolean)
- **billing_charged_credits** (String)
- **billing_planned_credits** (String)
- **billing_status** (String)
- **charged** (Boolean)
- **charged_credits** (String)
- **error** (String)
- **id** (String) - Canonical write-action ID.
- **message** (String)
- **next_action_after_ms** (Number)
- **next_action_requires_new_idempotency_key** (Boolean)
- **next_action_type** (String)
- **next_action_url** (String)
- **object** (String)
- **poll_after_ms** (Number)
- **request_hash** (String)
- **request_id** (String)
- **request_payload_json** (String)
- **response_account_id** (String)
- **response_account_username** (String)
- **response_target_id** (String)
- **response_target_type** (String)
- **result_id** (String)
- **result_state** (String)
- **result_type** (String)
- **retryable** (Boolean)
- **safe_to_retry** (Boolean)
- **send_dispatched** (Boolean)
- **status** (String)
- **status_url** (String)
- **success** (Boolean)
- **target_id_response** (String)
- **terminal** (Boolean)
- **write_action_id** (String)
```

--------------------------------

### x-twitter-scraper_x_profile_avatar Resource

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/docs/resources/x_profile_avatar.md

The x_profile_avatar resource manages the update_avatar request lifecycle.

```APIDOC
## Resource: x-twitter-scraper_x_profile_avatar

### Description
Runs one update_avatar request and stores its canonical write-action record.

### Required Parameters
- **account** (String) - X account for the request.
- **idempotency_key** (String, Sensitive) - Visible ASCII key for this exact write. Reuse only to replay the identical request.

### Optional Parameters
- **payload_json** (String, Sensitive) - JSON object for this operation.
- **target_id** (String) - Tweet, user, or community ID for an operation that requires a target.

### Read-Only Attributes
- **action** (String)
- **billing_charged** (Boolean)
- **billing_charged_credits** (String)
- **billing_planned_credits** (String)
- **billing_status** (String)
- **charged** (Boolean)
- **charged_credits** (String)
- **error** (String)
- **id** (String) - Canonical write-action ID.
- **message** (String)
- **next_action_after_ms** (Number)
- **next_action_requires_new_idempotency_key** (Boolean)
- **next_action_type** (String)
- **next_action_url** (String)
- **object** (String)
- **poll_after_ms** (Number)
- **request_hash** (String)
- **request_id** (String)
- **request_payload_json** (String, Sensitive)
- **response_account_id** (String)
- **response_account_username** (String)
- **response_target_id** (String)
- **response_target_type** (String)
- **result_id** (String)
- **result_state** (String)
- **result_type** (String)
- **retryable** (Boolean)
- **safe_to_retry** (Boolean)
- **send_dispatched** (Boolean)
- **status** (String)
- **status_url** (String)
- **success** (Boolean)
- **target_id_response** (String)
- **terminal** (Boolean)
- **write_action_id** (String)
```

--------------------------------

### x-twitter-scraper_x_account Data Source

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/docs/data-sources/x_account.md

The x-twitter-scraper_x_account data source provides read-only access to the configuration and status of a connected X account.

```APIDOC
## Data Source: x-twitter-scraper_x_account

### Description
Retrieves information about a connected X account managed by the scraper.

### Read-Only Attributes
- **cookies_obtained_at** (String) - Timestamp when cookies were obtained.
- **created_at** (String) - Timestamp when the account record was created.
- **health** (String) - The current health status of the account. Available values: "healthy", "locked", "needsReauth", "recovering", "suspended", "temporaryIssue".
- **id** (String) - The unique ID of this resource.
- **status** (String) - The current status of the account.
- **updated_at** (String) - Timestamp when the account record was last updated.
- **x_user_id** (String) - The X platform user ID.
- **x_username** (String) - The X platform username.
```

--------------------------------

### x-twitter-scraper_x_tweet_retweet

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/docs/resources/x_tweet_retweet.md

Resource definition for executing a retweet request.

```APIDOC
## x-twitter-scraper_x_tweet_retweet (Resource)

### Description
Runs one retweet request and stores its canonical write-action record.

### Schema

#### Required
- `account` (String) - X account for the request.
- `idempotency_key` (String, Sensitive) - Visible ASCII key for this exact write. Reuse only to replay the identical request.

#### Optional
- `payload_json` (String, Sensitive) - JSON object for this operation.
- `target_id` (String) - Tweet, user, or community ID for an operation that requires a target.

#### Read-Only
- `action` (String)
- `billing_charged` (Boolean)
- `billing_charged_credits` (String)
- `billing_planned_credits` (String)
- `billing_status` (String)
- `charged` (Boolean)
- `charged_credits` (String)
- `error` (String)
- `id` (String) - Canonical write-action ID.
- `message` (String)
- `next_action_after_ms` (Number)
- `next_action_requires_new_idempotency_key` (Boolean)
- `next_action_type` (String)
- `next_action_url` (String)
- `object` (String)
- `poll_after_ms` (Number)
- `request_hash` (String)
- `request_id` (String)
- `request_payload_json` (String, Sensitive)
- `response_account_id` (String)
- `response_account_username` (String)
- `response_target_id` (String)
- `response_target_type` (String)
- `result_id` (String)
- `result_state` (String)
- `result_type` (String)
- `retryable` (Boolean)
- `safe_to_retry` (Boolean)
- `send_dispatched` (Boolean)
- `status` (String)
- `status_url` (String)
- `success` (Boolean)
- `target_id_response` (String)
- `terminal` (Boolean)
- `write_action_id` (String)
```

--------------------------------

### Commit with DCO sign-off

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/CONTRIBUTING.md

Signs a commit to comply with the Developer Certificate of Origin requirements.

```sh
git commit -s
```

--------------------------------

### x-twitter-scraper_x_tweet_unlike

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/docs/resources/x_tweet_unlike.md

The x-twitter-scraper_x_tweet_unlike resource executes an unlike request and records the result. It requires an account identifier and an idempotency key for request tracking.

```APIDOC
## x-twitter-scraper_x_tweet_unlike

### Description
Runs one unlike request and stores its canonical write-action record.

### Schema
#### Required
- **account** (String) - X account for the request.
- **idempotency_key** (String) - Visible ASCII key for this exact write. Reuse only to replay the identical request.

#### Optional
- **payload_json** (String) - JSON object for this operation.
- **target_id** (String) - Tweet, user, or community ID for an operation that requires a target.

#### Read-Only
- **action** (String)
- **billing_charged** (Boolean)
- **billing_charged_credits** (String)
- **billing_planned_credits** (String)
- **billing_status** (String)
- **charged** (Boolean)
- **charged_credits** (String)
- **error** (String)
- **id** (String) - Canonical write-action ID.
- **message** (String)
- **next_action_after_ms** (Number)
- **next_action_requires_new_idempotency_key** (Boolean)
- **next_action_type** (String)
- **next_action_url** (String)
- **object** (String)
- **poll_after_ms** (Number)
- **request_hash** (String)
- **request_id** (String)
- **request_payload_json** (String)
- **response_account_id** (String)
- **response_account_username** (String)
- **response_target_id** (String)
- **response_target_type** (String)
- **result_id** (String)
- **result_state** (String)
- **result_type** (String)
- **retryable** (Boolean)
- **safe_to_retry** (Boolean)
- **send_dispatched** (Boolean)
- **status** (String)
- **status_url** (String)
- **success** (Boolean)
- **target_id_response** (String)
- **terminal** (Boolean)
- **write_action_id** (String)
```

--------------------------------

### x-twitter-scraper_x_tweet_unretweet

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/docs/resources/x_tweet_unretweet.md

Resource definition for executing an unretweet request.

```APIDOC
## x-twitter-scraper_x_tweet_unretweet (Resource)

### Description
Runs one unretweet request and stores its canonical write-action record.

### Schema

#### Required
- **account** (String) - X account for the request.
- **idempotency_key** (String, Sensitive) - Visible ASCII key for this exact write. Reuse only to replay the identical request.

#### Optional
- **payload_json** (String, Sensitive) - JSON object for this operation.
- **target_id** (String) - Tweet, user, or community ID for an operation that requires a target.

#### Read-Only
- **action** (String)
- **billing_charged** (Boolean)
- **billing_charged_credits** (String)
- **billing_planned_credits** (String)
- **billing_status** (String)
- **charged** (Boolean)
- **charged_credits** (String)
- **error** (String)
- **id** (String) - Canonical write-action ID.
- **message** (String)
- **next_action_after_ms** (Number)
- **next_action_requires_new_idempotency_key** (Boolean)
- **next_action_type** (String)
- **next_action_url** (String)
- **object** (String)
- **poll_after_ms** (Number)
- **request_hash** (String)
- **request_id** (String)
- **request_payload_json** (String, Sensitive)
- **response_account_id** (String)
- **response_account_username** (String)
- **response_target_id** (String)
- **response_target_type** (String)
- **result_id** (String)
- **result_state** (String)
- **result_type** (String)
- **retryable** (Boolean)
- **safe_to_retry** (Boolean)
- **send_dispatched** (Boolean)
- **status** (String)
- **status_url** (String)
- **success** (Boolean)
- **target_id_response** (String)
- **terminal** (Boolean)
- **write_action_id** (String)
```

--------------------------------

### data_source: x-twitter-scraper_style

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/docs/data-sources/style.md

Retrieves tweet data and style information for a specified X account.

```APIDOC
## Data Source: x-twitter-scraper_style

### Description
Fetches AI-composed tweet data, writing styles, and radar information for a given X account.

### Schema
#### Read-Only Attributes
- **fetched_at** (String) - Timestamp of when the data was fetched.
- **id** (String) - The unique identifier of this resource.
- **is_own_account** (Boolean) - Indicates if the account belongs to the user.
- **tweet_count** (Number) - Total number of tweets retrieved.
- **x_username** (String) - The X username associated with the data.

#### Nested Schema for `tweets`
- **author_username** (String) - The username of the tweet author.
- **created_at** (String) - The timestamp when the tweet was created.
- **id** (String) - The unique identifier of the tweet.
- **text** (String) - The content of the tweet.
```

--------------------------------

### x-twitter-scraper_x_user_remove_follower

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/docs/resources/x_user_remove_follower.md

Resource definition for executing a remove_follower request.

```APIDOC
## x-twitter-scraper_x_user_remove_follower (Resource)

### Description
Runs one remove_follower request and stores its canonical write-action record.

### Schema
#### Required
- **account** (String) - X account for the request.
- **idempotency_key** (String, Sensitive) - Visible ASCII key for this exact write.

#### Optional
- **payload_json** (String, Sensitive) - JSON object for this operation.
- **target_id** (String) - Tweet, user, or community ID for an operation that requires a target.

#### Read-Only
- **action** (String)
- **billing_charged** (Boolean)
- **billing_charged_credits** (String)
- **billing_planned_credits** (String)
- **billing_status** (String)
- **charged** (Boolean)
- **charged_credits** (String)
- **error** (String)
- **id** (String) - Canonical write-action ID.
- **message** (String)
- **next_action_after_ms** (Number)
- **next_action_requires_new_idempotency_key** (Boolean)
- **next_action_type** (String)
- **next_action_url** (String)
- **object** (String)
- **poll_after_ms** (Number)
- **request_hash** (String)
- **request_id** (String)
- **request_payload_json** (String, Sensitive)
- **response_account_id** (String)
- **response_account_username** (String)
- **response_target_id** (String)
- **response_target_type** (String)
- **result_id** (String)
- **result_state** (String)
- **result_type** (String)
- **retryable** (Boolean)
- **safe_to_retry** (Boolean)
- **send_dispatched** (Boolean)
- **status** (String)
- **status_url** (String)
- **success** (Boolean)
- **target_id_response** (String)
- **terminal** (Boolean)
- **write_action_id** (String)
```

--------------------------------

### x-twitter-scraper_draw Data Source

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/docs/data-sources/draw.md

The x-twitter-scraper_draw data source provides read-only access to giveaway draw results and associated tweet metadata.

```APIDOC
## Data Source: x-twitter-scraper_draw

### Description
Retrieves information about a giveaway draw conducted on Twitter, including tweet engagement metrics and the list of winners.

### Schema

#### Read-Only Attributes
- **draw** (Object) - Full giveaway draw details.
  - **created_at** (String)
  - **drawn_at** (String)
  - **id** (String) - Draw public ID.
  - **status** (String)
  - **total_entries** (Number)
  - **tweet_author_username** (String)
  - **tweet_id** (String)
  - **tweet_like_count** (Number)
  - **tweet_quote_count** (Number)
  - **tweet_reply_count** (Number)
  - **tweet_retweet_count** (Number)
  - **tweet_text** (String)
  - **tweet_url** (String)
  - **valid_entries** (Number)
- **id** (String) - The ID of this resource.
- **winners** (List of Objects) - List of winners for the draw.
  - **author_username** (String)
  - **is_backup** (Boolean)
  - **position** (Number)
  - **tweet_id** (String)
```

--------------------------------

### x-twitter-scraper_draft Data Source

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/docs/data-sources/draft.md

Retrieves details for a specific tweet draft managed by the X Twitter Scraper provider.

```APIDOC
## Data Source: x-twitter-scraper_draft

### Description
Retrieves information about a tweet draft, including the text, topic, and goal associated with the draft.

### Schema
#### Read-Only Attributes
- **created_at** (String) - The timestamp when the draft was created.
- **goal** (String) - The objective of the tweet draft.
- **id** (String) - The unique identifier of the draft resource.
- **text** (String) - The content of the tweet draft.
- **topic** (String) - The topic associated with the draft.
- **updated_at** (String) - The timestamp when the draft was last updated.
```

--------------------------------

### x-twitter-scraper_x_tweet_delete

Source: https://github.com/xquik-dev/terraform-provider-x-twitter-scraper/blob/main/docs/resources/x_tweet_delete.md

Resource definition for executing a tweet deletion request.

```APIDOC
## x-twitter-scraper_x_tweet_delete

### Description
Runs one delete_tweet request and stores its canonical write-action record.

### Required Parameters
- **account** (String) - X account for the request.
- **idempotency_key** (String, Sensitive) - Visible ASCII key for this exact write. Reuse only to replay the identical request.

### Optional Parameters
- **payload_json** (String, Sensitive) - JSON object for this operation.
- **target_id** (String) - Tweet, user, or community ID for an operation that requires a target.

### Read-Only Attributes
- **action** (String)
- **billing_charged** (Boolean)
- **billing_charged_credits** (String)
- **billing_planned_credits** (String)
- **billing_status** (String)
- **charged** (Boolean)
- **charged_credits** (String)
- **error** (String)
- **id** (String) - Canonical write-action ID.
- **message** (String)
- **next_action_after_ms** (Number)
- **next_action_requires_new_idempotency_key** (Boolean)
- **next_action_type** (String)
- **next_action_url** (String)
- **object** (String)
- **poll_after_ms** (Number)
- **request_hash** (String)
- **request_id** (String)
- **request_payload_json** (String, Sensitive)
- **response_account_id** (String)
- **response_account_username** (String)
- **response_target_id** (String)
- **response_target_type** (String)
- **result_id** (String)
- **result_state** (String)
- **result_type** (String)
- **retryable** (Boolean)
- **safe_to_retry** (Boolean)
- **send_dispatched** (Boolean)
- **status** (String)
- **status_url** (String)
- **success** (Boolean)
- **target_id_response** (String)
- **terminal** (Boolean)
- **write_action_id** (String)
```
Tokens:
Raw