Skip to main content

API Documentation

Complete RESTful API reference for extracting real-time e-commerce data from 50+ global platforms with advanced anti-detection technology.

🚀 API Overview​

The E-Commerce Data Parsing API provides programmatic access to competitive intelligence and market data from major global e-commerce platforms. Our APIs are designed for enterprise-level data extraction with advanced anti-detection capabilities, real-time processing, and comprehensive platform coverage.

Key Features​

  • 🌍 Global Coverage - 50+ platforms across Americas, Europe, Asia, and emerging markets
  • ⚡ Real-time Processing - Live data extraction with under 2-second response times
  • 🛡️ Anti-detection Technology - Advanced bypass techniques for protected platforms
  • 🔌 RESTful Design - Standard HTTP endpoints with JSON responses
  • 📚 Multiple SDKs - JavaScript, Python, PHP, Java, and more
  • 🔔 Webhook Support - Real-time notifications for price changes
  • 📊 Market Intelligence - Comprehensive analytics and insights
  • 🎯 Ready-to-Use Clients - Official SDKs and demo portal

🛠️ Quick Start​

Get started with the API in just a few lines of code:

// Initialize API client
const api = new ShopapisAPI({
  apiKey: 'your-api-key',
  baseUrl: 'https://api.shopapis.com',
});

// Search for products across multiple platforms
const response = await api.search({
  query: 'iPhone 15',
  platforms: ['amazon', 'ebay', 'walmart'],
  price_min: 500,
  price_max: 1000,
  limit: 100,
});

console.log(`Found ${response.data.length} products`);

Python Example​

import shopapis

# Initialize client
client = shopapis.Client(api_key='your-api-key')

# Get product details
product = client.get_product('amazon', 'B0CHX1W1XY')

print(f"Product: {product.title}")
print(f"Price: {product.price.formatted}")
print(f"Platform: {product.platform}")

PHP Example​

<?php
require_once 'vendor/autoload.php';

use Shopapis\Client;

// Initialize client
$client = new Client('your-api-key');

// Search products
$response = $client->search([
    'query' => 'gaming laptop',
    'platforms' => ['amazon', 'bestbuy'],
    'price_min' => 800,
    'price_max' => 2000,
    'limit' => 50
]);

echo "Found " . count($response->data) . " products\n";
?>

📊 Sample API Response​

{
  "success": true,
  "data": [
    {
      "id": "amazon_B0CHX1W1XY",
      "title": "Apple iPhone 15 Pro Max 256GB Natural Titanium",
      "platform": "amazon",
      "price": {
        "amount": 1199.99,
        "currency": "USD",
        "formatted": "$1,199.99"
      },
      "seller": {
        "name": "Apple Store",
        "rating": 4.8,
        "type": "official"
      },
      "rating": {
        "score": 4.7,
        "count": 1250
      },
      "availability": "In Stock",
      "shipping": {
        "cost": 0,
        "type": "Free Prime"
      },
      "url": "https://amazon.com/dp/B0CHX1W1XY",
      "extracted_at": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "total": 1250,
    "page": 1,
    "limit": 100,
    "pages": 13
  },
  "metadata": {
    "extraction_time": "1.2s",
    "platforms_searched": ["amazon", "ebay", "walmart"],
    "cache_hit": false
  }
}

🔧 Core API Endpoints​

// Search across all platforms
const response = await api.search({
  query: 'gaming laptop',
  price_min: 800,
  price_max: 2000,
  platforms: ['amazon', 'bestbuy', 'newegg'],
  sort_by: 'price_asc',
  limit: 50,
});
// Search specific platform
const amazonProducts = await api.platforms.amazon.search({
  query: 'wireless headphones',
  category: 'electronics',
  price_min: 50,
  price_max: 300,
  prime_only: true,
  limit: 25,
});

Product Details​

// Get detailed product information
const product = await api.getProduct('amazon', 'B0CHX1W1XY');

// Get multiple products
const products = await api.getProducts([
  'amazon:B0CHX1W1XY',
  'ebay:123456789',
  'walmart:ABC123'
]);

Price Monitoring​

// Monitor price changes
const priceAlerts = await api.monitorPrices([
  'amazon:B0CHX1W1XY',
  'ebay:123456789',
  'walmart:ABC123'
], {
  interval: '1h',
  threshold: 10, // 10% price change
});

Competitive Analysis​

// Analyze competitor pricing
const analysis = await api.analyzeCompetitors({
  product_ids: ['amazon:B0CHX1W1XY'],
  platforms: ['amazon', 'ebay', 'walmart'],
  timeframe: '30d',
});

📈 Available Platforms​

🌍 Americas​

  • Amazon - AutoTrader, CarGurus, Cars.com, Carvana, Vroom
  • Walmart Marketplace - US, 19 countries
  • eBay - Global auction and marketplace
  • Best Buy - Electronics and technology
  • Target - General retail

🌍 Europe​

  • Zalando - European fashion marketplace
  • Otto - German general retail
  • Farfetch - Luxury fashion
  • Bol.com - Dutch general retail
  • Cdiscount - French electronics

🌍 Asia-Pacific​

  • Alibaba - China's largest B2B and C2C platform
  • JD.com - China's premium B2C platform
  • TikTok Shop - Social commerce platform
  • Flipkart - India's e-commerce leader
  • Lazada - Southeast Asia marketplace

🌍 Emerging Markets​

  • MercadoLibre - Latin America (18+ countries)
  • Coupang - South Korea's e-commerce platform
  • Shopee - Southeast Asia mobile-first
  • Jumia - African e-commerce platform

🔐 Authentication​

All API requests require authentication using your API key:

// Include API key in headers
const headers = {
  Authorization: 'Bearer your-api-key',
  'Content-Type': 'application/json',
};

// Or use SDK authentication
const api = new ShopapisAPI({
  apiKey: 'your-api-key',
});

📊 Rate Limits​

Our API includes intelligent rate limiting to ensure optimal performance:

  • Starter Plan: 1,000 requests/hour
  • Professional Plan: 10,000 requests/hour
  • Enterprise Plan: Custom limits
// Check rate limit status
const rateLimit = await api.getRateLimit();
console.log(`Remaining requests: ${rateLimit.remaining}`);

🔔 Webhooks​

Receive real-time notifications for price changes and new listings:

// Configure webhook
await api.webhooks.create({
  url: 'https://your-domain.com/webhook',
  events: ['price.changed', 'product.added'],
  platforms: ['amazon', 'ebay'],
  filters: {
    price_change_threshold: 5, // 5% price change
    categories: ['electronics', 'fashion']
  }
});

📚 SDKs & Libraries​

JavaScript/Node.js​

npm install shopapis

Python​

pip install shopapis

PHP​

composer require shopapis/shopapis-php

Java​

<dependency>
    <groupId>com.shopapis</groupId>
    <artifactId>shopapis-java</artifactId>
    <version>1.0.0</version>
</dependency>

🎯 Ready-to-Use Clients​

Get started quickly with our official SDKs and demo portal:

Python Client​

Official Python SDK with full type safety and async support

  • Type-safe with Pydantic models
  • Async/await support
  • Full API coverage
  • Auto-generated from OpenAPI

TypeScript Client​

Official TypeScript SDK with modern ES6+ features

  • Full TypeScript support
  • Browser & Node.js compatible
  • Modern ES6+ syntax
  • Zero-dependency design

Demo Portal​

Ready-to-use e-commerce demo portal built with Next.js

  • Pre-configured setup
  • Docker ready
  • Responsive design
  • Production ready

View All Clients →

🚀 Getting Started​

  1. Authentication - Set up API authentication
  2. First Request - Make your first API call
  3. Rate Limits - Understand usage limits
  4. SDKs - Choose your preferred SDK

💡 Best Practices​

  • Implement Caching - Cache results to reduce API calls
  • Handle Errors Gracefully - Implement proper error handling
  • Use Webhooks - Get real-time updates for price changes
  • Monitor Rate Limits - Stay within API limits
  • Use Platform-Specific Filters - Optimize searches for better results

Start extracting e-commerce data today with our professional APIs!