<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> </head> <body>

OmniShop Data API- Documentation

Extract structured product data from any e-commerce page HTML — instantly, with AI enhancement.

📖 Overview

OmniShop Data API transforms raw HTML from product pages into clean, standardized JSON. Built-in rule sets for Amazon, Walmart, and eBay ensure high accuracy, while AI enhancement fills missing fields and translates text into 13 languages.

Why developers love it:

🧠 AI-enhanced extraction – fills gaps and translates content automatically
🛒 Multi-platform support – Amazon, Walmart, eBay, and any other site via generic fallback
🔍 Auto-detection – no need to specify the platform; the API can work with raw HTML alone
📝 Unified output – consistent JSON schema regardless of the source
⚡ Fast & efficient – responses in seconds, with 24‑hour intelligent caching
🔒 Secure by design – your HTML is never stored permanently; sensitive data is automatically redacted

💰 Plans & Name Mapping

Due to platform constraints, the plan names shown in the Hub are BASIC, PRO, and ULTRA. Here's what they mean for you:

Hub Plan	Actual Plan	Monthly Requests	Price (USD)	Overage fee
BASIC	Free	50	$0.00	–
PRO	Basic	5,000	$19.99	$0.002/req
ULTRA	Pro	50,000	$69.99	$0.002/req

All plans include access to every endpoint and output language. AI enhancement is available on PRO and ULTRA plans (and via daily trial on the free Demo endpoint).

🔐 Authentication

Every request requires your RapidAPI credentials (found in your RapidAPI Dashboard after subscribing):

X-RapidAPI-Key – your unique API key
X-RapidAPI-Host – the API hostname (provided automatically)

The backend Authorization header is injected automatically by RapidAPI – you never need to manage it yourself.

🚀 Quick Start

Subscribe to a plan (start with BASIC – it's free).
Copy your X-RapidAPI-Key from the RapidAPI Dashboard.
Get the HTML of a product page (see the HTML Guide below).
Run the example below to extract product data.

Base URL: Use the gateway URL shown in your RapidAPI app settings (typically https://omnishop-data.p.rapidapi.com).

📡 Endpoints

1. `POST /parse` – Parse product page

Extracts structured product data from the HTML of any e-commerce product page.

Request Body (JSON)

Parameter	Type	Required	Default	Description
`html`	string	Yes	–	Full HTML content (min 50 characters)
`platform`	string	No	auto-detected	Target platform (`amazon`, `walmart`, `ebay`)
`output_language`	string	No	`"en"`	Target language for AI translation
`use_ai`	boolean	No	`false`	Enable AI-powered field completion and translation
`force_refresh`	boolean	No	`false`	Bypass cache and force fresh extraction
`cache_ttl`	integer	No	`21600`	Cache time-to-live in seconds (60–86400)

Example Request (curl)

curl -X POST "https://omnishop-data.p.rapidapi.com/parse" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: omnishop-data.p.rapidapi.com" \
  -H "Content-Type: application/json" \
  -d '{
    "html": "<html>...full page source...</html>",
    "platform": "amazon",
    "output_language": "en",
    "use_ai": true,
    "force_refresh": false,
    "cache_ttl": 21600
  }'

Example Response (success)

{
  "status": "OK",
  "request_id": "a1b2c3d4-...",
  "data": {
    "title": "Example Product Title",
    "price": "$19.99",
    "original_price": "$29.99",
    "currency": "USD",
    "availability": "In Stock",
    "rating": 4.5,
    "num_ratings": 1234,
    "images": ["https://example.com/image.jpg"],
    "description": "This is a great product...",
    "features": ["Feature 1", "Feature 2"],
    "variants": [{"name": "Color: Red", "price": "$19.99"}],
    "store": "Amazon",
    "domain": "amazon.com"
  },
  "quality_score": 9,
  "review_recommended": false,
  "message": "AI enhanced (plan: PRO). ",
  "extraction_method": "ai_enhanced",
  "ai_fillable_fields": [],
  "ai_translatable_fields": [],
  "data_confidence": null
}

2. `POST /demo` – Free demo

Same as /parse but limited to 10 requests per day per IP. No subscription needed. AI enhancement can be tested via enable_ai_trial (global daily limit of 50).

Additional Parameter

Parameter	Type	Required	Default	Description
`enable_ai_trial`	boolean	No	`false`	Enable free AI trial (global daily limit 50)

Example Request

curl -X POST "https://omnishop-data.p.rapidapi.com/demo" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: omnishop-data.p.rapidapi.com" \
  -H "Content-Type: application/json" \
  -d '{
    "html": "<html>...full page source...</html>",
    "platform": "amazon",
    "output_language": "en",
    "enable_ai_trial": true
  }'

3. `GET /platforms` – List supported platforms

Returns the list of built-in platform rules.

{
  "platforms": ["amazon", "walmart", "ebay"],
  "rules_available": true
}

4. `GET /health` – Health check

Verifies API operational status and AI metrics.

{
  "status": "ok",
  "version": "17.0.0",
  "platforms_loaded": 3,
  "ai_status": {
    "success_last_min": 0,
    "failure_last_min": 0
  }
}

🌐 Supported Output Languages (AI Translation)

Code	Language
en	English
zh	Simplified Chinese
ja	Japanese
ko	Korean
de	German
fr	French
es	Spanish
it	Italian
pt	Portuguese
nl	Dutch
sv	Swedish
ru	Russian
ar	Arabic

Translation requires AI enhancement (use_ai=true) and a paid plan.

📊 Quality Score & Review Recommendation

Every response includes a quality_score (1–10) and a review_recommended flag. Scores reflect data completeness and extraction method. When review_recommended is true, consider manually reviewing the output.

🧠 Intelligent Caching

Results are cached for the duration specified in cache_ttl (default 6 hours). To force a fresh extraction, pass "force_refresh": true.

⚠️ Error Handling

HTTP Status	Meaning
200	Success
400	Invalid input (check required fields)
401	Missing or invalid RapidAPI credentials
413	Request body too large (max 2 MB)
422	Could not parse the provided HTML
429	Rate limit exceeded
500/502/504	Server or AI model error – retry later

📎 Additional Notes

Your HTML is not stored – processed in-memory and cached only for the specified TTL.
Sensitive patterns (API keys, passwords, tokens) are automatically redacted in the output.
Platform rules can be extended via our open-source rules repository.

📖 How to Get Product Page HTML

Open the product page in your browser (e.g., Amazon, Walmart, eBay).
View the page source:
- Chrome / Edge: Right-click → "View page source" or press <kbd>Ctrl+U</kbd>.
- Firefox: Right-click → "View Page Source".
- Safari: Enable Develop menu (Preferences → Advanced), then right-click → "Show Page Source".
Copy the HTML: Select all (<kbd>Ctrl+A</kbd>) and copy (<kbd>Ctrl+C</kbd>).
Send to the API in the html field – do not modify the original structure.

📧 Contact & Resources

API Issues / Feature Requests: GitHub Repository
Platform Rules Contribution: omnishop-rules
Provider: Contact via RapidAPI Hub messaging