Scrapfly · Schema

ScrapeResponse

AIData ExtractionScreenshotsWeb ScrapingProxiesBrowser Automation

Properties

Name Type Description
result object
context object
View JSON Schema on GitHub

JSON Schema

scrapfly-scraperesponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ScrapeResponse",
  "title": "ScrapeResponse",
  "type": "object",
  "properties": {
    "result": {
      "type": "object",
      "properties": {
        "content": {
          "type": "string",
          "description": "Scraped page content (HTML, markdown, text, etc.)"
        },
        "content_type": {
          "type": "string",
          "description": "Content MIME type"
        },
        "url": {
          "type": "string",
          "description": "Final URL after redirects"
        },
        "status_code": {
          "type": "integer",
          "description": "HTTP status code of the scraped page"
        },
        "cookies": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "value": {
                "type": "string"
              }
            }
          }
        },
        "request_headers": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "response_headers": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "screenshots": {
          "type": "object",
          "description": "Screenshot data keyed by selector name"
        },
        "dns": {
          "type": "object",
          "description": "DNS information if dns=true"
        },
        "ssl": {
          "type": "object",
          "description": "SSL/TLS certificate information if ssl=true"
        },
        "extracted_data": {
          "type": "object",
          "description": "Structured data extracted via template or LLM"
        }
      }
    },
    "context": {
      "type": "object",
      "properties": {
        "api_cost": {
          "type": "integer",
          "description": "Credits charged for this request"
        },
        "remaining_credits": {
          "type": "integer",
          "description": "Remaining API credits"
        },
        "attempts": {
          "type": "integer",
          "description": "Number of retry attempts"
        }
      }
    }
  }
}