1. DEMO
API Documents - GuGuData | Production-Ready APIs Built for Developers
  • GuGuData API documents
  • Metadata
    • DEMO
      • [DEMO] Global QS World University Rankings
      • [DEMO] Global University
      • [DEMO] Chinese Poem
      • [DEMO] Global QS World University Rankings
      • [DEMO] Stock US Symbols
      • [DEMO] Stock HK Symbols
    • Global QS World University Rankings
    • Global University
    • Chinese Poem
    • Global QS World University Rankings
    • Stock US Symbols
    • Stock HK Symbols
  • Website Tools
    • DEMO
      • [DEMO] Webpage Readable Content Extraction
        GET
      • [DEMO] Domain SSL Certificate Information Parsing
        GET
      • [DEMO] Domain DNS Information Query
        GET
      • [DEMO] Query Website Favicon and Title
        GET
      • [DEMO] Format International Phone
        GET
      • [DEMO] URL to static HTML
        GET
      • [DEMO] URL to Image
        GET
      • [DEMO] URL to Markdown
        GET
      • [DEMO] Get URL links
        GET
      • [DEMO] Website Snapshot
        GET
      • [DEMO] Domain Whois
        GET
      • [DEMO] IP Address
        GET
      • [DEMO] Article Extract
        GET
      • [DEMO] Geographic Coordinate System Converter
        GET
      • [DEMO] Extract Structured JSON from Webpage
        GET
      • [DEMO] Short Link API
        GET
    • Webpage Readable Content Extraction
      POST
    • Domain SSL Certificate Information Parsing
      GET
    • Domain DNS Information Query
      GET
    • Query Website Favicon and Title
      GET
    • Format International Phone
      GET
    • URL to static HTML
      POST
    • URL to Image
      GET
    • URL to Markdown
      POST
    • Get URL links
      GET
    • Website Snapshot
      POST
    • Domain Whois
      GET
    • IP Address
      GET
    • Article Extract
      POST
    • Geographic Coordinate System Converter
      GET
    • Extract Structured JSON from Webpage
      POST
    • Short Link API
      POST
  • Image Recognition
    • DEMO
      • [DEMO] HTML to PDF
      • [DEMO] Image OCR
      • [DEMO] PDF to Format
      • [DEMO] PDF Splitting
      • [DEMO] Markdown to PDF
      • [DEMO] PPT to Images
      • [DEMO] PDF to HTML
      • [DEMO] PDF Summary
      • [DEMO] Image Compress
      • [DEMO] Word to HTML
      • [DEMO] Convert HTML to Word
      • [DEMO] Convert PPT to PDF
    • HTML to PDF
    • Image OCR
    • PDF to Format
    • PDF Splitting
    • Markdown to PDF
    • PPT to Images
    • PDF to HTML
    • PDF Summary
    • Image Compress
    • Word to HTML
    • Convert HTML to Word
    • Convert PPT to PDF
  • QRcode and Barcode
    • DEMO
      • [DEMO] QR Code
      • [DEMO] Wifi QR Code
      • [DEMO] Bar Code
      • [DEMO] Decode QR Code from Image
    • QR Code
    • Wifi QR Code
    • Bar Code
    • Decode QR Code from Image
  • Text Tools
    • DEMO
      • [DEMO] Simplified and Traditional Chinese Converter
      • [DEMO] Text Similarity Calculator
      • [DEMO] Detect Text Language
      • [DEMO] ISBN Book Metadata Lookup
    • Simplified and Traditional Chinese Converter
    • Text Similarity Calculator
    • Detect Text Language
    • ISBN Book Metadata Lookup
  • healthcheck
    GET
  1. DEMO

[DEMO] Webpage Readable Content Extraction

GET
https://api.gugudata.io/v1/websitetools/readability/demo
Last modified:2026-05-14 10:39:32

Webpage Readable Content Extraction
Extract cleaned, reader-friendly article content from a webpage URL or a raw HTML payload.

Method: POST
Path: /v1/websitetools/readability
Demo: https://api.gugudata.io/v1/websitetools/readability/demo
OpenAPI: https://gugudata.io/assets/openapi/gugudata.openapi.3.1.json

Request Parameters:

  • appkey (string, required): Application key used for request authentication. Supply the value as a query parameter, form field, or multipart field according to the request content type.
  • html (string, optional): Raw HTML content. Supply either html or url.
  • url (string, optional): Target webpage URL. Supply either url or html.

Response Fields:

  • DataStatus.RequestParameter (string, required): Normalized request parameters echoed by the service. Sensitive credentials are omitted when available.
  • DataStatus.StatusCode (integer, required): Application-level status code returned by the current v1 contract.
  • DataStatus.StatusDescription (string, required): Application-level status message returned by the current v1 contract.
  • DataStatus.ResponseDateTime (string, required): Response timestamp returned by the current service contract.
  • DataStatus.DataTotalCount (integer, required): Total number of records that match the request.
  • Data.Title (string, required): Article title
  • Data.Byline (string, required): Article author
  • Data.Dir (string, required): Article text direction
  • Data.Lang (string, required): Article language
  • Data.Content (string, required): Article content
  • Data.TextContent (string, required): Article content (without HTML tags, divided by paragraphs)
  • Data.Length (integer, required): Article length
  • Data.Excerpt (string, required): Article excerpt
  • Data.SiteName (string, required): Website name
  • Data.PublishedTime (array, required): Article publication time

HTTP Status Codes:

  • 200: Request processed successfully. Some endpoints expose a separate application-level status field in the response body, such as dataStatus.statusCode.
  • 400: Invalid request parameters or request format. Check required fields, data types, and request body format.
  • 401: Missing or unknown application key. Provide a valid appkey with the request.
  • 403: The application key is recognized but access is not allowed. The key may be expired, inactive, or not permitted for the requested API.
  • 429: Request rate or trial usage limit exceeded. Reduce concurrency or retry after the limit window resets.
  • 500: Internal service error. Retry later or contact support if the error persists.
  • 503: Upstream service unavailable. Retry later; the requested upstream dependency is temporarily unavailable.

Business Status Codes:

  • 200 Normal return: No additional remark.
  • 400 Parameter error: No additional remark.
  • 429 Request frequency limited: Cannot exceed 100 requests per second
  • 403 Account in arrears: Please pay attention to the order expiration SMS reminders in time
  • 402 APPKEY error: Please check whether the APPKEY passed is obtained from the developer center
  • 500 API response error: No additional remark.

Key Features:

  • Intelligently extracts readable content from webpages.
  • Provides HTML code of the webpage's readable content.
  • Supports passing either webpage HTML or webpage URL parameters.
  • Supports extraction of various elements information including article title, author, text direction, language, content, content (without HTML tags, divided by paragraphs), article length, excerpt, website name, publication time.
  • Second-level parsing performance, supporting high concurrency.
  • Supports HTTPS (TLS v1.0 / v1.1 / v1.2 / v1.3) for all interfaces.
  • Fully compatible with Apple ATS.
  • Nationwide multi-node CDN deployment.
  • Rapid response of the interface, with multiple servers building API interface load balancing.

Details:
https://gugudata.io/details/readability

Request

None

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.gugudata.io/v1/websitetools/readability/demo'

Responses

🟢200成功
application/json
Bodyapplication/json

Example
{
  "DataStatus": {
    "RequestParameter": "string",
    "StatusCode": 0,
    "StatusDescription": "string",
    "ResponseDateTime": "string",
    "DataTotalCount": 0
  },
  "Data": {
    "Title": "string",
    "Byline": "string",
    "Dir": "string",
    "Lang": "string",
    "Content": "string",
    "TextContent": "string",
    "Length": 0,
    "Excerpt": "string",
    "SiteName": "string",
    "PublishedTime": [
      "string"
    ]
  }
}
Modified at 2026-05-14 10:39:32
Previous
DEMO
Next
[DEMO] Domain SSL Certificate Information Parsing
Built with