{
  "openapi": "3.0.1",
  "info": {
    "title": "X Engagement Scraper | $0.15/1K | Pay-Per-Result",
    "description": "Scrape X (Twitter) replies, quotes, retweeters, likers, and threads for $0.15 per 1,000 delivered rows on every Apify plan. Process post URLs or IDs in bulk. Filters and deduplication run before billing. Apify bills platform usage separately. No X login. Built by Xquik. Not affiliated with X Corp.",
    "version": "1.0",
    "x-build-id": "eZ924OJkTI0a7kbX6"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/xquik~x-engagement-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-xquik-x-engagement-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/xquik~x-engagement-scraper/runs": {
      "post": {
        "operationId": "runs-sync-xquik-x-engagement-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/xquik~x-engagement-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-xquik-x-engagement-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "startUrls": {
            "title": "X Post URLs",
            "type": "array",
            "description": "Public x.com or twitter.com status URLs. Strings and {\"url\":\"...\"} objects are accepted.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "tweetIds": {
            "title": "Tweet IDs",
            "type": "array",
            "description": "Numeric Tweet IDs.",
            "items": {
              "type": "string"
            }
          },
          "engagementTypes": {
            "title": "Engagement Types",
            "type": "array",
            "description": "Choose engagement resources. Replies, Quotes, Retweeters, and Likers run by default.",
            "items": {
              "type": "string",
              "enum": [
                "tweet",
                "replies",
                "completeReplies",
                "quotes",
                "retweeters",
                "favoriters",
                "thread"
              ],
              "enumTitles": [
                "Source Post",
                "Replies",
                "Complete Direct + Nested Replies",
                "Quotes",
                "Retweeters",
                "Likers",
                "Thread Context"
              ]
            },
            "default": [
              "replies",
              "quotes",
              "retweeters",
              "favoriters"
            ]
          },
          "sort": {
            "title": "Complete Reply Order",
            "enum": [
              "relevance",
              "latest",
              "oldest",
              "likes"
            ],
            "type": "string",
            "description": "Order complete reply rows. Other engagement types keep source order.",
            "default": "relevance"
          },
          "scope": {
            "title": "Complete Reply Scope",
            "enum": [
              "all",
              "direct",
              "nested"
            ],
            "type": "string",
            "description": "Choose direct, nested, or all complete reply rows.",
            "default": "all"
          },
          "includeOriginalPost": {
            "title": "Include Source Post",
            "type": "boolean",
            "description": "Add the source post to complete reply results.",
            "default": false
          },
          "maxDepth": {
            "title": "Maximum Reply Depth",
            "minimum": 1,
            "type": "integer",
            "description": "Limit nested reply depth in complete reply results."
          },
          "sinceTime": {
            "title": "Replies Since",
            "type": "integer",
            "description": "Keep replies at or after this Unix timestamp in seconds."
          },
          "untilTime": {
            "title": "Replies Until",
            "type": "integer",
            "description": "Keep replies at or before this Unix timestamp in seconds."
          },
          "language": {
            "title": "Language",
            "type": "string",
            "description": "Keep post rows with this language code."
          },
          "mediaType": {
            "title": "Media Type",
            "enum": [
              "images",
              "videos",
              "gifs",
              "media",
              "links",
              "none"
            ],
            "type": "string",
            "description": "Keep post rows with the selected media type."
          },
          "minViews": {
            "title": "Minimum Views",
            "minimum": 0,
            "type": "integer",
            "description": "Keep post rows with at least this many views."
          },
          "minLikes": {
            "title": "Minimum Likes",
            "minimum": 0,
            "type": "integer",
            "description": "Keep post rows with at least this many likes."
          },
          "minReplies": {
            "title": "Minimum Replies",
            "minimum": 0,
            "type": "integer",
            "description": "Keep post rows with at least this many replies."
          },
          "minRetweets": {
            "title": "Minimum Reposts",
            "minimum": 0,
            "type": "integer",
            "description": "Keep post rows with at least this many reposts."
          },
          "minQuotes": {
            "title": "Minimum Quotes",
            "minimum": 0,
            "type": "integer",
            "description": "Keep post rows with at least this many quotes."
          },
          "minBookmarks": {
            "title": "Minimum Bookmarks",
            "minimum": 0,
            "type": "integer",
            "description": "Keep post rows with at least this many bookmarks."
          },
          "verifiedOnly": {
            "title": "Verified Authors or Profiles Only",
            "type": "boolean",
            "description": "Keep post authors or engagement profiles with verification.",
            "default": false
          },
          "maxItems": {
            "title": "Maximum Delivered Rows",
            "minimum": 1,
            "type": "integer",
            "description": "Global cap across every post and selected engagement type.",
            "default": 10000
          },
          "maxItemsPerTarget": {
            "title": "Rows per Engagement Resource",
            "minimum": 1,
            "maximum": 1000000,
            "type": "integer",
            "description": "Optional cap for each post and engagement type."
          },
          "dedupeAcrossTargets": {
            "title": "Deduplicate Across Posts",
            "type": "boolean",
            "description": "When off, the same account or post can appear once for each source post and engagement type.",
            "default": false
          },
          "maxConcurrency": {
            "title": "Maximum Concurrency",
            "minimum": 1,
            "maximum": 128,
            "type": "integer",
            "description": "Parallel independent engagement reads. Leave the default for maximum safe throughput.",
            "default": 100
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}