/sharpapi/api/v1/utilities/scrape_url/Fetches and scrapes the URL provided in the `url` query parameter, then returns the original URL, the scrape timestamp, and a `scraped_data` object containing extracted page content and metadata.
Scrape a URL
**Method:** GET
**Apiosk URL:** https://gateway.apiosk.com/apyhub-sharpapi-web-scraping-api/sharpapi/api/v1/utilities/scrape_url/
**Request content type:** application/json
**Response content type:** application/json
What it does
Fetches and scrapes the URL provided in the url query parameter, then returns the original URL, the scrape timestamp, and a scraped_data object containing extracted page content and metadata.
Query Parameter(s)
| Attribute | Type | Mandatory | Description |
| --------- | ------ | --------- | ---------------------------- |
| url | String | Yes | The URL to scrape. Must be a valid URI. |
Response
Returns a JSON object with required top-level url and timestamp string fields, plus a required scraped_data object field. url echoes the scraped URL, timestamp is the UTC time the scrape was performed, and scraped_data contains the extracted page data.
| Attribute | Type | Mandatory | Description |
| --------- | ------ | --------- | ---------------------------- |
| url | String | Yes | The URL that was scraped, echoed back from the request. |
| timestamp | String | Yes | UTC timestamp of when the scrape was performed. |
| scraped_data | Object | Yes | Scraped page data, including content, metadata, and extracted links. |
Quickstart
Scrape a page by passing its URL as a query parameter.
bash
curl -X GET "https://gateway.apiosk.com/apyhub-sharpapi-web-scraping-api/sharpapi/api/v1/utilities/scrape_url/?url=https%3A%2F%2Fapyhub.com%2F" \
-H "PAYMENT-SIGNATURE: $PAYMENT_SIGNATURE"
What you'll get back
Returns a JSON object with url and timestamp string fields, plus a scraped_data object containing the extracted page data.
json
{
"url": "https://apyhub.com/",
"timestamp": "2025-01-15T08:56:04.946195Z",
"scraped_data": {}
}
Payment and authentication
Do not send an apy-token. Apiosk injects the APYHub credential server-side. The first unpaid request returns HTTP 402 Payment Required with a PAYMENT-REQUIRED header. Sign an accepted USDC payment and retry the same request with the proof in PAYMENT-SIGNATURE (or use an Apiosk/x402-aware agent client that performs this exchange automatically).
The $PAYMENT_SIGNATURE placeholder in the example is the signed proof obtained from that initial 402 response.
Source
Parameter definitions and limits were synchronized from [APYHub's official documentation](https://apyhub.com/sharpapi/service/scrape-url) on 2026-07-18.
Pay per request through Apiosk using x402. Do not send an apy-token; the gateway injects the selected APYHub key server-side.
{
"properties": {
"url": {
"example": "https://apyhub.com/",
"format": "uri",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
}{
"properties": {
"scraped_data": {
"properties": {
"content_html": {
"description": "The page's main content rendered as HTML.",
"type": "string"
},
"content_keywords_index": {
"description": "Extracted keyword/phrase index for the page content.",
"example": [
"streamline workflow",
"e-commerce",
"marketing"
],
"items": {
"type": "string"
},
"type": "array"
},
"content_lists": {
"description": "Lists (`<ul>`/`<ol>`) extracted from the page.",
"items": {
"properties": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "List type.",
"example": "ul",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"content_markdown": {
"description": "The page's main content rendered as Markdown.",
"type": "string"
},
"content_structured": {
"description": "Ordered list of structural content blocks (headings, paragraphs, etc.) extracted from the page.",
"items": {
"properties": {
"content": {
"description": "Text content of the block.",
"type": "string"
},
"tag": {
"description": "HTML tag name of the block.",
"example": "h1",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"detected_language": {
"description": "ISO 639-1 language code detected for the page.",
"example": "en",
"type": "string"
},
"headers": {
"description": "Document-level metadata pulled from the `<head>`.",
"properties": {
"canonical": {
"example": "https://apyhub.com/",
"format": "uri",
"nullable": true,
"type": "string"
},
"charset": {
"example": "utf-8",
"nullable": true,
"type": "string"
},
"contentType": {
"nullable": true,
"type": "string"
},
"csrfToken": {
"nullable": true,
"type": "string"
},
"viewport": {
"example": [
"width=device-width",
"initial-scale=1"
],
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"links": {
"description": "Links found on the page, split into internal and external.",
"properties": {
"external": {
"items": {
"format": "uri",
"type": "string"
},
"type": "array"
},
"internal": {
"items": {
"format": "uri",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"meta_tags": {
"description": "Standard `<meta>` tag values.",
"properties": {
"author": {
"nullable": true,
"type": "string"
},
"description": {
"example": "Leverage AI API to streamline workflow in E-Commerce, Marketing, Content Management, HR Tech, Travel, and more.",
"nullable": true,
"type": "string"
},
"image": {
"nullable": true,
"type": "string"
},
"keywords": {
"example": [
"ApyHub",
"AI",
"automation"
],
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"open_graph": {
"additionalProperties": {
"type": "string"
},
"description": "Open Graph (`og:*`) meta tag values, keyed by tag name.",
"example": {
"og:description": "Leverage AI API to streamline workflow in E-Commerce, Marketing, Content Management, HR Tech, Travel, and more.",
"og:image": "https://apyhub.com/build/assets/apyhub-website-preview-ARuIroBi.png",
"og:title": "AI-powered Workflow Automation API",
"og:type": "website",
"og:url": "https://apyhub.com"
},
"type": "object"
},
"title": {
"description": "The page's `<title>` content.",
"example": "AI-powered Workflow Automation API",
"type": "string"
},
"twitter_card": {
"additionalProperties": {
"type": "string"
},
"description": "Twitter/X Card (`twitter:*`) meta tag values, keyed by tag name.",
"example": {
"twitter:card": "summary",
"twitter:creator": "@a2zwebltd",
"twitter:site": "@apyhub"
},
"type": "object"
}
},
"type": "object"
},
"timestamp": {
"description": "UTC timestamp of when the scrape was performed.",
"example": "2025-01-15T08:56:04.946195Z",
"format": "date-time",
"type": "string"
},
"url": {
"description": "The URL that was scraped, echoed back from the request.",
"example": "https://apyhub.com/",
"format": "uri",
"type": "string"
}
},
"required": [
"url",
"timestamp",
"scraped_data"
],
"type": "object"
}{
"properties": {
"PAYMENT-SIGNATURE": {
"description": "Signed x402 v2 payment proof. Obtain the payment requirements from the initial HTTP 402 response.",
"type": "string"
}
},
"required": [],
"type": "object"
}{
"query": {
"url": "https://apyhub.com/"
}
}{
"scraped_data": {},
"timestamp": "2025-01-15T08:56:04.946195Z",
"url": "https://apyhub.com/"
}