Get the status of a scrape

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

Responses

🟢200OK

application/json

Successful response

Body

success

boolean

optional

status

string

optional

The current status of the crawl. Can be scraping, completed, or failed.

data

object

optional

The data of the scrape.

markdown

string

optional

html

string | null

optional

HTML version of the content on page if html is in formats

rawHtml

string | null

optional

Raw HTML content of the page if rawHtml is in formats

screenshot

string | null

optional

Screenshot of the page if screenshot is in formats

links

array[string]

optional

List of links on the page if links is in formats

metadata

object

optional

error

string

optional

Error message

Example

{
    "success": false,
    "status": "completed",
    "data": {
        "markdown": "qui",
        "html": "sunt",
        "rawHtml": null,
        "screenshot": null,
        "links": [
            "https://sticky-pantyhose.org/"
        ],
        "metadata": {
            "title": "questionably buck over esteemed whether into",
            "description": "Toties amicitia thesis. Adsidue tam viduo armarium condico tui verbera solitudo. Arcesso cariosus aggredior teneo supplanto contabesco voluntarius decretum cupressus. Speciosus cado advoco adinventitias labore dolores casso creta ver consequuntur. At claustrum verumtamen varietas viscus illo surculus ustilo. Aqua ratione quis cras.",
            "language": null,
            "sourceURL": "https://turbulent-offset.biz/",
            "<any other metadata> ": "in",
            "statusCode": 68,
            "error": null
        }
    },
    "error": "sint ut nisi"
}

🟠402402

🟠429429

🔴500Server Error