Get crawl status
curl --request GET \
--url https://api.hydrafetch.com/v1/web/crawl/{id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hydrafetch.com/v1/web/crawl/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.hydrafetch.com/v1/web/crawl/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hydrafetch.com/v1/web/crawl/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hydrafetch.com/v1/web/crawl/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hydrafetch.com/v1/web/crawl/{id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hydrafetch.com/v1/web/crawl/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "019f3c09-6fae-740f-9257-10c2b6af7f43",
"kind": "crawl",
"status": "running",
"seedUrl": "https://example.com",
"total": 100,
"completed": 42,
"failed": 1,
"creditsUsed": 42,
"pages": [
{
"url": "https://example.com/blog/post",
"status": "completed",
"depth": 1,
"discoveredVia": "sitemap",
"error": "<string>",
"errorCode": "TOO_MANY_REQUESTS",
"retryable": false,
"data": {
"url": "https://example.com",
"finalUrl": "https://example.com/",
"redirected": false,
"status": 200,
"cached": false,
"metadata": {
"title": "Example Domain",
"structure": "markdown",
"pageType": "article",
"wordCount": 214,
"description": "A short summary of the page, as published by the page itself.",
"language": "en",
"author": "Jane Doe",
"siteName": "Example Blog",
"publishedTime": "2026-01-05",
"modifiedTime": "2026-02-11",
"image": "https://example.com/cover.png"
},
"warning": "<string>",
"usage": {
"creditsUsed": 1,
"creditsRemaining": 4999,
"freshness": "fresh"
},
"quality": {
"confidence": 0.94,
"complete": true,
"blocked": false
},
"markdown": "<string>",
"html": "<string>",
"rawHtml": "<string>",
"links": {
"internal": [
"<string>"
],
"external": [
"<string>"
]
},
"structured": {
"entities": [
{
"type": "Product",
"source": "json-ld",
"properties": {}
}
],
"jsonLd": [
{}
],
"microdata": [
{}
],
"opengraph": [
{}
],
"appState": [
"<string>"
]
},
"summary": "<string>",
"json": {},
"brand": {
"domain": "stripe.com",
"name": "Stripe",
"description": "Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.",
"tagline": "Financial infrastructure to grow your revenue.",
"assets": [
{
"kind": "symbol",
"variant": "light",
"url": "https://media.hydrafetch.com/brand/a0/a07c2695173dde0a1ffa.svg",
"format": "svg",
"resolution": {
"width": 180,
"height": 180,
"aspectRatio": 1
},
"colors": [
{
"hex": "#533afd",
"weight": 0.42,
"name": "Indigo",
"role": "primary"
}
],
"blurhash": "LmGk_aoh4sWHohWEWDt506WD?Sod"
}
],
"colors": [
{
"hex": "#533afd",
"weight": 0.42,
"name": "Indigo",
"role": "primary"
}
],
"fonts": [
{
"family": "Sohne",
"weight": 1,
"role": "body"
}
],
"socials": [
{
"platform": "x",
"url": "https://x.com/stripe",
"handle": "stripe"
}
],
"links": {
"pricing": "https://stripe.com/pricing",
"blog": "https://stripe.com/blog",
"careers": "https://stripe.com/jobs",
"contact": "https://stripe.com/contact",
"privacy": "https://stripe.com/privacy",
"terms": "https://stripe.com/legal",
"docs": "https://docs.stripe.com"
},
"sources": {},
"resolvedAt": "2026-08-22T10:14:03.000Z",
"queriedDomain": "stripe.co.uk",
"aliases": [
"<string>"
],
"naics": {
"code": "5223",
"title": "Activities Related to Credit Intermediation",
"level": "industry_group",
"sector": {
"code": "52",
"title": "Finance and Insurance"
},
"confidence": 0.8
},
"email": "[email protected]",
"legalName": "Stripe, Inc.",
"metaDescription": "Stripe powers online and in-person payment processing for businesses of all sizes.",
"phone": "+1 888 926 2289",
"address": {
"street": "354 Oyster Point Blvd",
"city": "South San Francisco",
"region": "CA",
"postalCode": "94080",
"country": "US"
},
"foundedYear": 2010
}
},
"requestedUrl": "https://example.com/blog/post/"
}
]
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "url must be a valid URL"
},
"meta": {
"requestId": "019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Missing X-API-Key header. Agents: https://hydrafetch.com/auth.md"
},
"meta": {
"requestId": "019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_CREDITS",
"message": "Insufficient credits"
},
"meta": {
"requestId": "019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"
}
}{
"success": false,
"error": {
"code": "WORKSPACE_BANNED",
"message": "This workspace has been suspended and cannot make API requests."
},
"meta": {
"requestId": "019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"
}
}{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Job not found"
},
"meta": {
"requestId": "019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"
}
}{
"success": false,
"error": {
"code": "UPSTREAM_UNREACHABLE",
"message": "The origin did not respond to any attempt we made."
},
"meta": {
"requestId": "019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"
}
}{
"success": false,
"error": {
"code": "TOO_MANY_REQUESTS",
"message": "Rate limit exceeded for this workspace and plan."
},
"meta": {
"requestId": "019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"
}
}{
"success": false,
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error"
},
"meta": {
"requestId": "019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"
}
}{
"success": false,
"error": {
"code": "SERVICE_UNAVAILABLE",
"message": "The summary and json formats are not available."
},
"meta": {
"requestId": "019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"
}
}Get crawl status
Poll a crawl for its progress and per-page results.
GET
/
v1
/
web
/
crawl
/
{id}
Get crawl status
curl --request GET \
--url https://api.hydrafetch.com/v1/web/crawl/{id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hydrafetch.com/v1/web/crawl/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.hydrafetch.com/v1/web/crawl/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hydrafetch.com/v1/web/crawl/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hydrafetch.com/v1/web/crawl/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hydrafetch.com/v1/web/crawl/{id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hydrafetch.com/v1/web/crawl/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "019f3c09-6fae-740f-9257-10c2b6af7f43",
"kind": "crawl",
"status": "running",
"seedUrl": "https://example.com",
"total": 100,
"completed": 42,
"failed": 1,
"creditsUsed": 42,
"pages": [
{
"url": "https://example.com/blog/post",
"status": "completed",
"depth": 1,
"discoveredVia": "sitemap",
"error": "<string>",
"errorCode": "TOO_MANY_REQUESTS",
"retryable": false,
"data": {
"url": "https://example.com",
"finalUrl": "https://example.com/",
"redirected": false,
"status": 200,
"cached": false,
"metadata": {
"title": "Example Domain",
"structure": "markdown",
"pageType": "article",
"wordCount": 214,
"description": "A short summary of the page, as published by the page itself.",
"language": "en",
"author": "Jane Doe",
"siteName": "Example Blog",
"publishedTime": "2026-01-05",
"modifiedTime": "2026-02-11",
"image": "https://example.com/cover.png"
},
"warning": "<string>",
"usage": {
"creditsUsed": 1,
"creditsRemaining": 4999,
"freshness": "fresh"
},
"quality": {
"confidence": 0.94,
"complete": true,
"blocked": false
},
"markdown": "<string>",
"html": "<string>",
"rawHtml": "<string>",
"links": {
"internal": [
"<string>"
],
"external": [
"<string>"
]
},
"structured": {
"entities": [
{
"type": "Product",
"source": "json-ld",
"properties": {}
}
],
"jsonLd": [
{}
],
"microdata": [
{}
],
"opengraph": [
{}
],
"appState": [
"<string>"
]
},
"summary": "<string>",
"json": {},
"brand": {
"domain": "stripe.com",
"name": "Stripe",
"description": "Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.",
"tagline": "Financial infrastructure to grow your revenue.",
"assets": [
{
"kind": "symbol",
"variant": "light",
"url": "https://media.hydrafetch.com/brand/a0/a07c2695173dde0a1ffa.svg",
"format": "svg",
"resolution": {
"width": 180,
"height": 180,
"aspectRatio": 1
},
"colors": [
{
"hex": "#533afd",
"weight": 0.42,
"name": "Indigo",
"role": "primary"
}
],
"blurhash": "LmGk_aoh4sWHohWEWDt506WD?Sod"
}
],
"colors": [
{
"hex": "#533afd",
"weight": 0.42,
"name": "Indigo",
"role": "primary"
}
],
"fonts": [
{
"family": "Sohne",
"weight": 1,
"role": "body"
}
],
"socials": [
{
"platform": "x",
"url": "https://x.com/stripe",
"handle": "stripe"
}
],
"links": {
"pricing": "https://stripe.com/pricing",
"blog": "https://stripe.com/blog",
"careers": "https://stripe.com/jobs",
"contact": "https://stripe.com/contact",
"privacy": "https://stripe.com/privacy",
"terms": "https://stripe.com/legal",
"docs": "https://docs.stripe.com"
},
"sources": {},
"resolvedAt": "2026-08-22T10:14:03.000Z",
"queriedDomain": "stripe.co.uk",
"aliases": [
"<string>"
],
"naics": {
"code": "5223",
"title": "Activities Related to Credit Intermediation",
"level": "industry_group",
"sector": {
"code": "52",
"title": "Finance and Insurance"
},
"confidence": 0.8
},
"email": "[email protected]",
"legalName": "Stripe, Inc.",
"metaDescription": "Stripe powers online and in-person payment processing for businesses of all sizes.",
"phone": "+1 888 926 2289",
"address": {
"street": "354 Oyster Point Blvd",
"city": "South San Francisco",
"region": "CA",
"postalCode": "94080",
"country": "US"
},
"foundedYear": 2010
}
},
"requestedUrl": "https://example.com/blog/post/"
}
]
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "url must be a valid URL"
},
"meta": {
"requestId": "019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Missing X-API-Key header. Agents: https://hydrafetch.com/auth.md"
},
"meta": {
"requestId": "019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_CREDITS",
"message": "Insufficient credits"
},
"meta": {
"requestId": "019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"
}
}{
"success": false,
"error": {
"code": "WORKSPACE_BANNED",
"message": "This workspace has been suspended and cannot make API requests."
},
"meta": {
"requestId": "019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"
}
}{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Job not found"
},
"meta": {
"requestId": "019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"
}
}{
"success": false,
"error": {
"code": "UPSTREAM_UNREACHABLE",
"message": "The origin did not respond to any attempt we made."
},
"meta": {
"requestId": "019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"
}
}{
"success": false,
"error": {
"code": "TOO_MANY_REQUESTS",
"message": "Rate limit exceeded for this workspace and plan."
},
"meta": {
"requestId": "019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"
}
}{
"success": false,
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error"
},
"meta": {
"requestId": "019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"
}
}{
"success": false,
"error": {
"code": "SERVICE_UNAVAILABLE",
"message": "The summary and json formats are not available."
},
"meta": {
"requestId": "019e8a3c-9f0b-7c12-88ab-1d2e3f4a5b6c"
}
}Was this page helpful?