Scrapeless API
latest
  • latest
  • v1
Dashboard
Dashboard
latest
  • latest
  • v1
  1. Crawl
  • User
    • Get User Info
      GET
  • Scraping Browser
    • CDP API
    • Browser extensions
      • Upload extension
      • Upgrade extension
      • Delete extension
      • Extension info
      • Extension list
    • Browser profiles
      • Profile list
      • Profile info
      • Delete profile
      • Upgrade profile
      • Create profile
    • Connect
      WSS
    • Running sessions
      GET
    • Live URL
      GET
  • Scraping API
    • shopee
      • Actor List
      • Shopee Product
      • Shopee Search
      • Shopee Rcmd
    • br sites
      • Solucoes cnpjreva
      • Solucoes certidaointernet
      • Servicos receita
      • Consopt
    • amazon
      • API Parameters
      • product
      • seller
      • keywords
    • google search
      • API Parameters
      • Google Search:Advanced search parameters(tbs)
      • Google Search
      • Google Images
      • Google Local
      • Google Shopping
      • Google Videos
    • google trends
      • API Parameters
      • AutoComplete
      • Interest Over Time
      • Compared Breakdown By Region
      • Interest By Subregion
      • Related Queries
      • Related Topics
      • Trending Now
    • google flights
      • API Parameters
      • Round trip
      • One way
      • Multi-city
    • google flights chart
      • API Parameters
      • chart
    • google scholar
      • API Parameters(Google Scholar)
      • API Parameters(Google Scholar Author)
      • API Parameters(Google Scholar Cite)
      • API Parameters(Google Scholar Profiles)
      • Google Scholar
      • Google Scholar Author
      • Google Scholar Cite
      • Google Scholar Profiles
    • Scraper Request
      POST
    • Scraper GetResult
      GET
  • Universal Scraping API
    • JS Render Docs
    • JS Render
      POST
    • Web Unlocker
      POST
  • Crawler
    • Scrape
      • Scrape a single URL
      • Scrape multiple URLs
      • Cancel a batch scrape job
      • Get the status of a scrape
      • Get the status of a batch scrape job
      • Get the errors of a batch scrape job
    • Crawl
      • Crawl multiple URLs based on options
        POST
      • Cancel a crawl job
        DELETE
      • Get the status of a crawl job
        GET
      • Get the errors of a crawl job
        GET
  • Public
    • actor status
    • actor status
  1. Crawl

Get the status of a crawl job

GET
/api/v1/crawler/crawl/{id}
Last modified:2025-06-04 10:04:20

Request

Authorization
Add parameter in header
x-api-token
Example:
x-api-token: ********************
Path Params
id
string 
required

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.scrapeless.com/api/v1/crawler/crawl/' \
--header 'x-api-token;'

Responses

🟢200OK
application/json
Successful response
Body
status
string 
optional
The current status of the crawl. Can be scraping, completed, or failed.
total
integer 
optional
The total number of pages that were attempted to be crawled.
completed
integer 
optional
The number of pages that have been successfully crawled.
data
array [object {6}] 
optional
The data of the crawl.
markdown
string 
optional
html
string  | null 
optional
HTML version of the content on page if includeHtml is true
rawHtml
string  | null 
optional
Raw HTML content of the page if includeRawHtml is true
links
array[string]
optional
List of links on the page if includeLinks is true
screenshot
string  | null 
optional
Screenshot of the page if includeScreenshot is true
metadata
object 
optional
Example
{
    "status": "string",
    "total": 0,
    "completed": 0,
    "data": [
        {
            "markdown": "string",
            "html": "string",
            "rawHtml": "string",
            "links": [
                "string"
            ],
            "screenshot": "string",
            "metadata": {
                "title": "string",
                "description": "string",
                "language": "string",
                "sourceURL": "http://example.com",
                "<any other metadata> ": "string",
                "statusCode": 0,
                "error": "string"
            }
        }
    ]
}
🟠402402
🟠429429
🔴500Server Error
Modified at 2025-06-04 10:04:20
Previous
Cancel a crawl job
Next
Get the errors of a crawl job
Built with