Skip to main content

Documentation Index

Fetch the complete documentation index at: https://usenaive.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

E-commerce Data provides access to product information from Google Shopping and Amazon. Get product listings, detailed product info, seller data, pricing comparisons, and product reviews — all via async task-based endpoints. Results are available in both structured JSON and raw HTML formats.

CLI First

# Google Shopping product search (async task)
naive ecommerce google products --keyword "wireless headphones" --location-code 2840 --language-code en

# Amazon product search
naive ecommerce amazon products --keyword "wireless headphones"

Endpoints

PlatformEndpointDescriptionSpeedCost
Google ShoppingproductsSearch product listings by keywordStandard2 credits
Google Shoppingproduct-infoDetailed product informationStandard2 credits
Google ShoppingsellersSeller list for a productStandard2 credits
Google Shoppingsellers/ad-url/:aclkGet ad click URL for a sellerGETFree
Google ShoppingreviewsProduct reviews with ratingsStandard2 credits
Google ShoppinglocationsAvailable location codesGETFree
Google ShoppinglanguagesAvailable language codesGETFree
AmazonproductsSearch product listings by keywordStandard2 credits
AmazonasinGet product info by ASINStandard2 credits
AmazonsellersSeller list for a productStandard2 credits
AmazonlocationsAvailable location codesGETFree
AmazonlanguagesAvailable language codesGETFree
Generalid-listList task IDs across all sub-APIsPOSTFree
All Standard endpoints use the async task workflow. Google Shopping Sellers Ad URL is a direct GET.

Async Workflow

  1. Submit via POST /v1/ecommerce/{platform}/{endpoint}/task
  2. Check via GET /v1/ecommerce/{platform}/{endpoint}/tasks-ready
  3. Retrieve via GET /v1/ecommerce/{platform}/{endpoint}/task/:id
  4. HTML format via GET /v1/ecommerce/{platform}/{endpoint}/task/:id/html

Google Shopping

Search products, get detailed info, compare sellers, and collect reviews.
# Submit a Google Shopping product search (async)
curl -X POST https://api.usenaive.ai/v1/ecommerce/google/products/task \
  -H "Authorization: Bearer nv_sk_your_key" \
  -H "Content-Type: application/json" \
  -d '{ "keyword": "wireless headphones", "location_code": 2840, "language_code": "en" }'

# Retrieve results once ready
curl https://api.usenaive.ai/v1/ecommerce/google/products/task/abc123 \
  -H "Authorization: Bearer nv_sk_your_key"
Response:
{
  "results": [
    {
      "title": "Sony WH-1000XM5 Wireless Headphones",
      "price": 278.00,
      "currency": "USD",
      "seller": "Amazon.com",
      "rating": 4.7,
      "review_count": 18432,
      "product_id": "12942301985732419751",
      "url": "https://www.google.com/shopping/product/12942301985732419751",
      "image_url": "https://encrypted-tbn0.gstatic.com/shopping?q=tbn:..."
    },
    {
      "title": "Apple AirPods Max",
      "price": 449.00,
      "currency": "USD",
      "seller": "Apple",
      "rating": 4.5,
      "review_count": 8291,
      "product_id": "10234567890123456789",
      "url": "https://www.google.com/shopping/product/10234567890123456789",
      "image_url": "https://encrypted-tbn0.gstatic.com/shopping?q=tbn:..."
    }
  ],
  "credits_used": 2
}

Endpoints

EndpointDescriptionRoutes
productsSearch product listings by keywordtask, task/:id, task/:id/html, tasks-ready
product-infoDetailed product informationtask, task/:id, task/:id/html, tasks-ready
sellersSeller list for a producttask, task/:id, task/:id/html, tasks-ready
sellers/ad-url/:aclkGet ad click URL for a sellerGET (direct)
reviewsProduct reviews with ratingstask, task/:id, task/:id/html, tasks-ready

Parameters

ParamTypeRequiredDefaultDescription
keywordstringYesProduct search keyword
location_codenumberNoLocation code
language_codestringNoLanguage code (e.g. “en”)
depthnumberNo100Number of results to retrieve
product_idstringVariesProduct identifier (for product-info, sellers, reviews)

Sellers Ad URL

Resolve a Google Shopping ad click URL to the actual seller destination. This is a direct GET — no task workflow needed.
curl https://api.usenaive.ai/v1/ecommerce/google/sellers/ad-url/DChcSEwi_example_aclk \
  -H "Authorization: Bearer nv_sk_your_key"

When to use

  • Comparing product prices across Google Shopping sellers
  • Getting detailed product specifications and descriptions
  • Collecting product reviews for market research
  • Resolving ad click URLs to actual seller pages

Amazon

Search products, look up by ASIN, and analyze sellers.
# Submit an Amazon product search (async)
curl -X POST https://api.usenaive.ai/v1/ecommerce/amazon/products/task \
  -H "Authorization: Bearer nv_sk_your_key" \
  -H "Content-Type: application/json" \
  -d '{ "keyword": "bluetooth speaker", "location_code": 2840, "language_code": "en" }'

# Look up a specific ASIN
curl -X POST https://api.usenaive.ai/v1/ecommerce/amazon/asin/task \
  -H "Authorization: Bearer nv_sk_your_key" \
  -H "Content-Type: application/json" \
  -d '{ "asin": "B0CX23V2ZK" }'

Endpoints

EndpointDescriptionRoutes
productsSearch product listings by keywordtask, task/:id, task/:id/html, tasks-ready
asinGet product info by ASINtask, task/:id, task/:id/html, tasks-ready
sellersSeller list for a producttask, task/:id, task/:id/html, tasks-ready

Parameters

ParamTypeRequiredDefaultDescription
keywordstringYesProduct search keyword
location_codenumberNoLocation code
language_codestringNoLanguage code
depthnumberNo100Number of results
asinstringVariesAmazon ASIN (for asin, sellers endpoints)

When to use

  • Researching Amazon product listings and rankings
  • Monitoring competitor pricing and seller landscape
  • Looking up detailed product info by ASIN
  • Comparing sellers for a specific product

HTML Format

All Standard endpoints support an HTML format option. Append /html to the task-get URL to receive the raw rendered page HTML instead of structured JSON:
GET /v1/ecommerce/{platform}/{endpoint}/task/:id       → Structured JSON
GET /v1/ecommerce/{platform}/{endpoint}/task/:id/html   → Raw HTML
Use HTML format when you need the full page layout, or when structured parsing misses data you need.

Error Handling

ErrorCauseRecovery
insufficient_creditsNot enough creditsCheck balance with GET /v1/status
invalid_platformUnknown platform nameUse “google” or “amazon”
invalid_inputInvalid endpoint for platformCheck available endpoints for the platform
task_not_foundTask ID doesn’t exist or expiredResubmit the task
provider_errorData provider returned an errorRetry after a few seconds
Use tasks-ready polling to efficiently batch-retrieve results instead of checking individual task statuses. All task-get endpoints support both JSON and HTML format — append /html for the raw rendered page.

Typical Workflow

Agent receives task: "Compare headphone pricing across platforms"

    ├─ POST /v1/ecommerce/google/products/task          → Search Google Shopping
    │   { keyword: "wireless headphones" }
    │   → Task ID returned (202)

    ├─ POST /v1/ecommerce/amazon/products/task          → Search Amazon
    │   { keyword: "wireless headphones" }
    │   → Task ID returned (202)

    ├─ GET /v1/ecommerce/google/products/tasks-ready    → Poll for ready tasks
    │   → List of completed task IDs

    ├─ GET /v1/ecommerce/google/products/task/:id       → Get Google results
    │   → Product listings with prices, ratings, sellers

    ├─ GET /v1/ecommerce/amazon/products/task/:id       → Get Amazon results
    │   → Product listings with prices, ratings, sellers

    ├─ POST /v1/ecommerce/google/reviews/task           → Get product reviews
    │   { product_id: "12942301985732419751" }
    │   → Task ID returned

    └─ GET /v1/ecommerce/google/sellers/ad-url/:aclk   → Resolve ad URL
        → Actual seller destination URL

Credit Costs

OperationCredits
Task submission (task_post) — all endpoints2
Sellers ad URL GETFree
Meta endpoints (locations, languages)Free
Task retrieval (task/:id, task/:id/html, tasks-ready)Free
id-listFree