POST
/
api
/
scrapers
/
leads-generator
/
google
/
create-and-run
curl --request POST \
  --url https://app.mrscraper.com/api/scrapers/leads-generator/google/create-and-run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Google - MrScraper",
  "search_type": "url",
  "keywords": "MrScraper",
  "url": "https://mrscraper.com",
  "limit_pages": 1
}'
{
  "message": "Scraping queued successfully",
  "scraper": {
    "id": 101,
    "name": "Google - 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": "Google - 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 https://docs.mrscraper.com/documentation/api-token for the details.

Body

application/json
​
name
string
required

The name of the scraping task.

Example:

"Google - MrScraper"

​
search_type
enum<string>
required

The search type. It can be either 'url' or 'keywords'.

Available options:
url,
keywords
Example:

"url"

​
limit_pages
integer
required

Limit the number of pages to scrape.

Example:

1

​
keywords
string

Keywords to search. Required if the search type is 'keywords'.

Example:

"MrScraper"

​
url
string

URL to search. Required if search type is 'url'.

Example:

"https://mrscraper.com"

Response

200 - application/json
A successful response indicating the scraping task was queued successfully.
​
message
string
Example:

"Scraping queued successfully"

​
scraper
object
​
results
object[]