Scrape

Get scrape job status

Poll a scrape started with async (or one that ran past the synchronous wait).

get/v1/web/scrape/{id}

Request

  • Base URL: https://api.hydrafetch.com
  • URL: https://api.hydrafetch.com/v1/web/scrape/{id}
  • Auth: API key in header X-API-Key

Path parameters

idstring required

The job id returned by the scrape call.

Response

status'waiting' | 'active' | 'completed' | 'failed' required

Job state.

errorstring

Present when the job failed.

Example response

{
  "status": "completed",
  "data": {
    "url": "https://example.com",
    "finalUrl": "https://example.com/",
    "status": 200,
    "metadata": {
      "structure": "markdown",
      "pageType": "article",
      "wordCount": 214
    },
    "usage": {
      "creditsUsed": 1,
      "creditsRemaining": 4999,
      "freshness": "fresh"
    },
    "quality": {
      "confidence": 0.94,
      "complete": true
    },
    "structured": {
      "entities": [
        {
          "type": "Product"
        }
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.