Skip to main content
POST
/
api
/
scrapers
/
leads-generator
/
twitter
/
create-and-run
Create and run a leads generator scraper for X (Twitter) platform
curl --request POST \
  --url https://app.mrscraper.com/api/scrapers/leads-generator/twitter/create-and-run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Twitter - MrScraper",
  "keywords": "MrScraper",
  "sentiment_type": "positive",
  "expected_data": 100
}
'
{
  "message": "Scraping queued successfully",
  "scraper": {
    "id": 101,
    "name": "Twitter - MrScraper",
    "url": [
      "Default"
    ],
    "urls": [
      "Default"
    ],
    "scheduled": false,
    "schedule": null,
    "created_at": "2024-09-20T06:45:47.000000Z",
    "updated_at": "2024-09-20T06:45:47.000000Z"
  },
  "results": [
    {
      "scraping_run_id": 1115,
      "user_id": 26,
      "scraper_name": "Twitter - MrScraper",
      "scrapped_url": "Default",
      "scraped_url": "Default",
      "scraper_id": 101,
      "status": "running",
      "created_at": "2024-09-20T06:45:47.000000Z",
      "updated_at": "2024-09-20T06:45:47.000000Z",
      "id": 1917
    }
  ]
}

Authorizations

​
Authorization
string
header
required

You can retrieve your token by visiting the API Tokens section inside your profile page or see /documentation/api-token for the details.

Body

application/json
​
name
string
required

The name of the scraping task.

Example:

"Twitter - MrScraper"

​
keywords
string
required

Keywords to search.

Example:

"MrScraper"

​
sentiment_type
enum<string>
required

Sentiment type for the data.

Available options:
all,
positive,
neutral,
negative
Example:

"positive"

​
expected_data
integer
required

The number of expected data.

Example:

100

Response

200 - application/json

A successful response indicating the scraping task was queued successfully.

​
message
string
Example:

"Scraping queued successfully"

​
scraper
object
​
results
object[]