Introduction

Getting Started

Welcome to ScrapeRing. This guide covers everything you need to start extracting data.

Requirements

Base URL

All API requests use the following base URL:

https://app.scrapering.com/api/parsing/v1

Your first request

A request takes two steps: you create a task, then get its result by the task id. You don't need your own server for this.

Step 1. Create a task

Pass your API key in the Authorization header and the page URL in the request body:

curl -X POST 'https://app.scrapering.com/api/parsing/v1/url' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -d '{"url": "https://scrapering.com"}'

The response contains the task id — save it, you'll need it in the next step:

{
  "id": "5cfce409-1a30-4181-88eb-75b995499cd0",
  "status": "queued",
  "scope": "url",
  "costCredits": 1,
  "createdAt": "2026-01-01T00:00:00.000Z"
}

Step 2. Get the result

Request the result by the task id:

curl https://app.scrapering.com/api/parsing/v1/result/url/YOUR_REQUEST_ID \
  --header 'Authorization: Bearer YOUR_API_KEY'

The task is processed asynchronously. While it is in progress, the response looks like this — repeat the request a few seconds later:

{
  "status": "parsing",
  "requestId": "5cfce409-1a30-4181-88eb-75b995499cd0"
}

When the result is ready, status changes to ready and the scraped page is in data:

{
  "status": "ready",
  "requestId": "5cfce409-1a30-4181-88eb-75b995499cd0",
  "data": {
    "url": "https://scrapering.com",
    "success": true,
    "content": "<html lang=\"en\">...</html>",
    "cookies": [],
    "time": "3.24"
  },
  "respondedAt": "2026-01-01T00:00:03.240Z"
}

All task statuses and error codes are described in API Status Codes.

Receive the result on your server (optional)

Instead of requesting the result, you can add callbackUrl to the request body. When the task is finished, we send a POST request with the result to this URL. See Webhook for details.

Next steps