# HTML DOM to JSON API **Convert raw HTML into clean, structured JSON instantly.** This API parses any HTML string and returns a normalized JSON representation of the DOM tree—no URL fetching, no JavaScript rendering, just pure HTML-to-JSON conversion. --- ## 🎯 What This API Does Send HTML → Get JSON structure back. **Perfect for:** - 🤖 AI/LLM preprocessing pipelines - 🔄 No-code automation (Make.com, Zapier, n8n, Pipedream) - 📊 Data extraction and normalization - 🔍 HTML structure analysis - 🛠️ Building custom scraping tools - 🧹 DOM cleanup and sanitization **Key Features:** - ✅ Returns clean, predictable JSON structure - ✅ Automatically removes scripts, styles, and comments - ✅ Handles complex nested HTML - ✅ Fast processing (typically 3-10ms) - ✅ Supports HTML up to 10MB --- ## 🚀 Quick Start ### Request ```http POST https://html-dom-to-json.p.rapidapi.com/ Content-Type: application/json X-RapidAPI-Key: YOUR_KEY ``` ```json { "html": "

Hello World

" } ``` ### Response ```json { "success": true, "data": { "tree": [ { "tag": "div", "attributes": { "class": "container" }, "text": "Hello", "children": [ { "tag": "span", "attributes": {}, "text": "World", "children": [] } ] } ], "metadata": { "nodeCount": 2, "processingTimeMs": 3, "timestamp": "2025-01-15T10:30:00.000Z" } } } ``` --- ## 📖 API Reference ### Endpoint ``` POST / ``` ### Request Headers **Content-Type** (Required): Must be `application/json` **X-RapidAPI-Key** (Required): Your RapidAPI key (auto-injected when using RapidAPI) ### Request Body **html** (Required, String): The HTML content to parse. Maximum size: 10MB. **Example:** ```json { "html": "

Title

Content here.

" } ``` ### Response Structure **Success Response (200):** The API returns a JSON object with the following structure: **success** (Boolean): Indicates whether parsing was successful **data** (Object): Contains the parsed data - **tree** (Array): Array of root-level DOM nodes - **metadata** (Object): Processing information - **nodeCount** (Integer): Total number of nodes parsed - **processingTimeMs** (Integer): Processing time in milliseconds - **timestamp** (String): ISO 8601 timestamp of parsing **DOM Node Structure:** Each node in the tree contains: **tag** (String): HTML element name (e.g., "div", "span", "a") **attributes** (Object): All HTML attributes as key-value pairs **text** (String): Direct text content within this element **children** (Array): Nested child nodes (recursive structure) **Example Node:** ```json { "tag": "div", "attributes": { "class": "container", "id": "main" }, "text": "Direct text", "children": [...] } ``` --- ## ⚠️ Error Responses All errors return JSON with this structure: ```json { "success": false, "error": { "type": "ERROR_TYPE", "message": "Human-readable error message", "details": "Additional context (when available)" } } ``` ### Common Error Types **400 - INVALID_CONTENT_TYPE** Content-Type header must be application/json. **400 - INVALID_JSON** Request body contains invalid JSON syntax. **400 - MISSING_FIELD** The "html" field is missing from the request body. **400 - INVALID_TYPE** The "html" field must be a string, not another data type. **400 - EMPTY_FIELD** The "html" field cannot be an empty string. **401 - AUTHENTICATION_REQUIRED** Missing or invalid API key. Requests must include valid RapidAPI authentication. **413 - PAYLOAD_TOO_LARGE** HTML content exceeds the 10MB size limit. **429 - RATE_LIMIT_EXCEEDED** You have exceeded your plan's rate limit. Wait before making additional requests or upgrade your plan. **500 - INTERNAL_ERROR** An unexpected server error occurred. If this persists, contact support. ### Error Examples **Missing HTML Field:** ```json { "success": false, "error": { "type": "MISSING_FIELD", "message": "Missing required field: html", "expected": { "html": "<string> - The HTML content to parse" } } } ``` **Empty HTML:** ```json { "success": false, "error": { "type": "EMPTY_FIELD", "message": "Field \"html\" cannot be empty" } } ``` **Invalid JSON:** ```json { "success": false, "error": { "type": "INVALID_JSON", "message": "Request body contains invalid JSON", "details": "Unexpected token < in JSON at position 0" } } ``` **Payload Too Large:** ```json { "success": false, "error": { "type": "PAYLOAD_TOO_LARGE", "message": "HTML content exceeds maximum size of 10MB", "size": 15728640, "maxSize": 10485760 } } ``` **Rate Limit Exceeded:** ```json { "message": "You have exceeded the rate limit per minute for your plan, BASIC, by the API provider" } ``` --- ## 🔌 Integration Examples ### cURL ```bash curl -X POST 'https://html-dom-to-json.p.rapidapi.com/' \ -H 'Content-Type: application/json' \ -H 'X-RapidAPI-Key: YOUR_KEY' \ -d '{"html":"

Hello World

"}' ``` ### JavaScript (Node.js) ```javascript const axios = require('axios'); async function parseHTML(html) { const response = await axios.post( 'https://html-dom-to-json.p.rapidapi.com/', { html }, { headers: { 'Content-Type': 'application/json', 'X-RapidAPI-Key': process.env.RAPIDAPI_KEY } } ); return response.data.data.tree; } // Usage const dom = await parseHTML('

Hello World

'); console.log(dom); ``` ### JavaScript (Fetch API) ```javascript async function parseHTML(html) { const response = await fetch('https://html-dom-to-json.p.rapidapi.com/', { method: 'POST', headers: { 'Content-Type': 'application/json', 'X-RapidAPI-Key': 'YOUR_KEY' }, body: JSON.stringify({ html }) }); const data = await response.json(); return data.data.tree; } ``` ### Python ```python import requests import os def parse_html(html): response = requests.post( 'https://html-dom-to-json.p.rapidapi.com/', json={'html': html}, headers={ 'Content-Type': 'application/json', 'X-RapidAPI-Key': os.environ['RAPIDAPI_KEY'] } ) response.raise_for_status() return response.json()['data']['tree'] # Usage dom = parse_html('

Hello World

') print(dom) ``` ### PHP ```php <?php $html = '<div>Hello <span>World</span></div>'; $ch = curl_init('https://html-dom-to-json.p.rapidapi.com/'); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_POST, true); curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(['html' => $html])); curl_setopt($ch, CURLOPT_HTTPHEADER, [ 'Content-Type: application/json', 'X-RapidAPI-Key: YOUR_KEY' ]); $response = curl_exec($ch); curl_close($ch); $data = json_decode($response, true); $tree = $data['data']['tree']; ?> ``` ### Make.com 1. Add **HTTP > Make a Request** module 2. Configure: - **Method:** POST - **URL:** `https://html-dom-to-json.p.rapidapi.com/` - **Headers:** - `Content-Type`: `application/json` - `X-RapidAPI-Key`: `{{your_key}}` - **Body:** ```json { "html": "{{your_html_variable}}" } ``` 3. Parse response: Access `data.tree` for the DOM structure ### Zapier 1. Add **Webhooks by Zapier** action 2. Choose **POST** 3. Configure: - **URL:** `https://html-dom-to-json.p.rapidapi.com/` - **Payload Type:** JSON - **Data:** - `html`: `<your HTML field>` - **Headers:** - `Content-Type`: `application/json` - `X-RapidAPI-Key`: `<your key>` 4. Test and use `data__tree` in subsequent steps ### n8n 1. Add **HTTP Request** node 2. Configure: - **Method:** POST - **URL:** `https://html-dom-to-json.p.rapidapi.com/` - **Authentication:** Generic Credential Type - **Headers:** - `Content-Type`: `application/json` - `X-RapidAPI-Key`: `{{$credentials.rapidApiKey}}` - **Body (JSON):** ```json { "html": "{{ $json.yourHTML }}" } ``` 3. Access response via `{{ $json.data.tree }}` ### Pipedream ```javascript export default defineComponent({ async run({ steps, $ }) { const response = await require("@pipedreamhq/platform").axios($, { method: "POST", url: "https://html-dom-to-json.p.rapidapi.com/", headers: { "Content-Type": "application/json", "X-RapidAPI-Key": process.env.RAPIDAPI_KEY }, data: { html: steps.trigger.event.html } }); return response.data.tree; } }); ``` --- ## 📋 What Gets Filtered Out To keep output clean and safe, these are automatically removed: - `<script>` tags and all content - `<style>` tags and all content - HTML comments (``) - CDATA sections - Processing instructions --- ## 💡 Common Use Cases ### 1. AI/LLM Preprocessing Clean HTML before feeding to language models: ```javascript const cleanDOM = await parseHTML(rawHTML); const textContent = extractText(cleanDOM); // Feed to GPT, Claude, etc. ``` ### 2. Data Extraction Navigate JSON structure to extract specific elements: ```javascript const articles = dom.tree .filter(node => node.tag === 'article') .map(article => ({ title: findByTag(article, 'h1').text, content: findByTag(article, 'p').text, author: findByTag(article, 'a').text })); ``` ### 3. HTML Validation Analyze structure for QA or debugging: ```javascript const headingCount = countByTag(dom.tree, 'h1'); const brokenLinks = findAllByTag(dom.tree, 'a') .filter(link => !link.attributes.href); ``` ### 4. Content Migration Convert legacy HTML to structured data: ```javascript const products = dom.tree .filter(node => node.attributes.class === 'product') .map(convertToProductObject); ``` --- ## 🔒 Authentication All requests require authentication through RapidAPI. When using this API through the RapidAPI platform, the `X-RapidAPI-Key` header is automatically included in every request. For testing in tools like Postman or cURL, obtain your API key from your RapidAPI dashboard. --- ## ⚡ Performance & Limits **Maximum HTML Size:** 10MB per request **Typical Processing Time:** 3-10ms for most HTML **Rate Limits:** Based on your RapidAPI subscription plan (see Pricing & Plans below) **Concurrent Requests:** Unlimited (scales automatically) **Output Size:** Varies based on HTML complexity --- ## 💰 Pricing & Plans ### Basic Plan (Free) **Monthly Price:** Free **Requests per Month:** 100 **Rate Limit:** 10 requests per minute **Features:** - Real-time HTML parsing - JSON DOM tree output - Automatic script/style removal - Performance metrics included (nodeCount, processingTimeMs, timestamp) - Maximum 10MB HTML per request - Community support (best effort response) - 99% uptime target ### Pro Plan **Monthly Price:** $9.99 **Requests per Month:** 10,000 **Rate Limit:** 100 requests per minute **Features:** - All Basic features, plus: - Priority support (24-hour response time) - 99.5% uptime target - Lower overage rates ($1.50 per 1,000 additional requests) ### Ultra Plan **Monthly Price:** $29.99 **Requests per Month:** 40,000 **Rate Limit:** 200 requests per minute **Features:** - All Pro features, plus: - Priority support (12-hour response time) - 99.9% uptime target - Even lower overage rates ($1.10 per 1,000 additional requests) - Early access to new features ### Mega Plan **Monthly Price:** $89.99 **Requests per Month:** 160,000 **Rate Limit:** 500 requests per minute **Features:** - All Ultra features, plus: - Priority support (4-hour response time) - Dedicated account manager - Lowest overage rates ($0.40 per 1,000 additional requests) ### Plan Comparison Summary **What's included in all plans:** - Real-time HTML parsing to JSON - Automatic removal of scripts, styles, and comments - Performance metrics (nodeCount, processingTimeMs, timestamp) - Maximum 10MB HTML per request - CORS support for browser requests **What improves with higher tiers:** - More monthly requests (100 → 10K → 40K → 160K) - Higher rate limits (10/min → 100/min → 200/min → 500/min) - Better support response times (best effort → 24h → 12h → 4h) - Better uptime targets (99% → 99.5% → 99.9%) - Lower overage rates ($2.00 → $1.50 → $1.10 → $0.40 per 1,000) **Exclusive to higher tiers:** - Ultra & Mega: Early access to new features - Mega only: Dedicated account manager --- ## 🏥 Health Check ### GET / or GET /health Returns API status and version information. **Request:** ```bash curl https://html-dom-to-json.p.rapidapi.com/health ``` **Response:** ```json { "status": "ok", "service": "HTML DOM to JSON API", "version": "1.0.0", "timestamp": "2025-01-15T10:30:00.000Z" } ``` --- ## ❓ FAQ **Q: Can this API fetch web pages?** A: No, you must provide the HTML content. Use a separate HTTP client or scraper to fetch pages first, then pass the HTML to this API. **Q: Does it execute JavaScript?** A: No, this is a pure HTML parser. JavaScript is not executed. You receive the raw DOM structure as it exists in the HTML string. **Q: What about malformed HTML?** A: The parser is forgiving and will do its best to create a valid DOM structure from malformed HTML, similar to how browsers handle it. **Q: Can I extract specific elements?** A: The API returns the full DOM tree. You'll need to traverse it in your code to extract specific elements. See the "Common Use Cases" section for examples. **Q: What HTML versions are supported?** A: All versions of HTML including HTML5. The parser handles both modern and legacy HTML syntax. **Q: Are HTML entities decoded?** A: Yes, HTML entities (like ` `, `&`, `<`) are automatically decoded in the output. **Q: Can I parse HTML fragments?** A: Yes, you can parse complete documents or fragments. The API doesn't require a full HTML document structure. **Q: Is my HTML data stored?** A: No, HTML content is processed in-memory and discarded immediately after the response is returned. We do not log or store your HTML data. **Q: What happens if I exceed my rate limit?** A: The API will return a 429 error. You'll need to wait before making more requests or upgrade to a higher plan with increased rate limits. **Q: What are overages and how are they billed?** A: If you exceed your monthly request quota, additional requests are billed at your plan's overage rate. Overages are charged at the end of your billing cycle. --- ## 📝 Changelog ### v1.0.0 (January 2025) - Initial release - HTML to JSON DOM parsing - Support for 10MB HTML documents - Processing metadata included - Automatic script/style/comment filtering - CORS support for browser requests - Comprehensive error handling --- ## 📞 Support Need help? Have questions? - **RapidAPI Users:** Use the "Contact API Provider" button - **Documentation:** Review examples and use cases above - **Issues:** Error messages are designed to be self-explanatory For feature requests or bug reports, please reach out through RapidAPI's contact system. --- ## 🏷️ Keywords html-parser, dom-parser, html-to-json, json-api, web-scraping, automation, ai-preprocessing, make.com, zapier, n8n, pipedream, data-extraction, html-processing, dom-tree, serverless, no-code, low-code, llm-preprocessing, content-extraction