PricesAPI Documentation

Real-time pricing data from thousands of retailers worldwide.

The PricesAPI provides programmatic access to product pricing data, seller information, and historical price trends. Build price comparison tools, track competitor pricing, or integrate live product offers into your application.

Base URL

https://api.pricesapi.io/api/v1

Authentication

All API requests require authentication using an API key. Simply add your API key as a query parameter to any request:

curl "https://api.pricesapi.io/api/v1/products/search?q=iphone&api_key=your_api_key"

Alternative: Header-Based Authentication

You can also pass your API key via the x-api-key header if preferred:

-H "x-api-key: $your_api_key"

Keep your API key secure! Never commit API keys to version control or expose them in client-side code. Your API key starts with pricesapi_ prefix.

Quick Start

Get started with a simple product search request:

javascript

// Simple GET request with query parameter
const apiKey = 'your_api_key';
const url = `https://api.pricesapi.io/api/v1/products/search?q=laptop&limit=10&api_key=${apiKey}`;

const response = await fetch(url);
const data = await response.json();
console.log(data);

Rate Limits

API rate limits depend on your subscription plan:

Plan	Monthly Limit	Rate
Personal	1,000 requests	10 req/min
Developer	25,000 requests	60 req/min
Business	100,000 requests	300 req/min
Enterprise	500,000+ requests	1000 req/min

Search Products

GET /api/v1/products/search

Search for products in our database across all retailers.

Query Parameters

Parameter	Type	Description
q	string	Search query (required)
limit	integer	Results per page (default: 20, max: 100)

Example Request

curl "https://api.pricesapi.io/api/v1/products/search?q=macbook+pro&limit=10" \
  -H "x-api-key: your_api_key"

Example Response

json

{
  "success": true,
  "data": {
    "query": "macbook pro",
    "results": [
      {
        "id": "12345",
        "title": "MacBook Pro 14-inch M3",
        "image": "https://example.com/image.jpg",
        "offerCount": 12
      },
      {
        "id": "12346",
        "title": "MacBook Pro 16-inch M3 Max",
        "image": "https://example.com/image2.jpg",
        "offerCount": 8
      }
    ],
    "total": 10
  }
}

Get Product Offers

GET /api/v1/products/:id/offers

Retrieve current pricing and offers for a specific product from all available sellers.

⚡ Real-Time Scraping

This endpoint performs real-time scraping to fetch the latest prices. Response times may vary from 5-30 seconds depending on the number of retailers.

Example Request

curl "https://api.pricesapi.io/api/v1/products/3669/offers" \
  -H "x-api-key: your_api_key"

Example Response

json

{
  "success": true,
  "data": {
    "id": 2919949736654117913,
    "title": "Apple iPhone 17 512GB White",
    "image": "https://example.com/image.jpg",
    "offerCount": 5,
    "offers": [
      {
        "seller": "Best Buy",
        "seller_url": "https://www.bestbuy.com",
        "price": 1199,
        "currency": "USD",
        "rating": 4.8,
        "reviewCount": 1892,
        "stock": "In stock",
        "delivery_info": "Free delivery by Fri",
        "productTitle": "Apple iPhone 17 512GB White",
        "url": "https://www.bestbuy.com/site/apple-iphone-17-512gb-white"
      },
      {
        "seller": "Amazon",
        "seller_url": "https://www.amazon.com",
        "price": 1199,
        "currency": "USD",
        "rating": 4.7,
        "reviewCount": 3421,
        "stock": "In stock",
        "delivery_info": "Free Prime delivery",
        "productTitle": "Apple iPhone 17 512GB (White)",
        "url": "https://www.amazon.com/dp/B0D1234567"
      },
      {
        "seller": "Apple",
        "seller_url": "https://www.apple.com",
        "price": 1199,
        "currency": "USD",
        "rating": 4.9,
        "reviewCount": 5841,
        "stock": "In stock",
        "delivery_info": "Free delivery",
        "productTitle": "iPhone 17 512GB White Unlocked",
        "url": "https://www.apple.com/shop/buy-iphone/iphone-17"
      }
    ]
  }
}

Supported Countries

The API supports price comparison across 18 countries. Use the country query parameter to specify the target market.

Country Parameter

Add ?country=CODE to your request. Default is au (Australia) if not specified.

GET /api/v1/products/:id/offers?country=uk

Americas

🇺🇸US - United States
🇨🇦CA - Canada
🇧🇷BR - Brazil
🇲🇽MX - Mexico

Europe

🇬🇧UK - United Kingdom
🇩🇪DE - Germany
🇫🇷FR - France
🇮🇹IT - Italy
🇪🇸ES - Spain
🇳🇱NL - Netherlands
🇸🇪SE - Sweden
🇵🇱PL - Poland

Asia-Pacific & Middle East

🇦🇺AU - Australia
🇯🇵JP - Japan
🇮🇳IN - India
🇸🇬SG - Singapore
🇦🇪AE - UAE
🇸🇦SA - Saudi Arabia

Example with Country Parameter

# Get prices in the UK
curl "https://api.pricesapi.io/api/v1/products/3669/offers?country=uk" \
  -H "x-api-key: your_api_key"

Error Codes

The API uses standard HTTP status codes and returns detailed error information:

Authentication Errors

Code	Error	Description
401	MISSING_API_KEY	API key not provided in request
401	INVALID_API_KEY_FORMAT	API key doesn't start with pricesapi_ prefix
401	INVALID_API_KEY	API key not found in database
403	SUBSCRIPTION_CANCELLED	Your subscription has been cancelled
403	CREDITS_EXCEEDED	Monthly API credits limit reached
429	RATE_LIMIT_EXCEEDED	Too many requests per minute

Request Errors

Code	Error	Description
400	MISSING_QUERY	Search query parameter 'q' is required
400	MISSING_PRODUCT_ID	Product ID is required in URL path
400	INVALID_PRODUCT_ID	Product ID must be a valid number
400	INVALID_LIMIT	Limit must be a positive integer
404	PRODUCT_NOT_FOUND	Product ID does not exist in database
404	NOT_FOUND	Requested endpoint does not exist

Server Errors

Code	Error	Description
500	SEARCH_FAILED	Product search failed
500	PRICES_FAILED	Failed to fetch product prices
500	VALIDATION_ERROR	Failed to validate API key

Error Response Format

json

{
  "success": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "API key is invalid",
    "details": "The provided API key was not found"
  }
}

Complete Code Examples

Full examples showing how to search for products and retrieve pricing data:

const API_KEY = 'your_api_key';
const BASE_URL = 'https://api.pricesapi.io/api/v1';

async function searchProducts(query) {
  const response = await fetch(
    `${BASE_URL}/products/search?q=${query}&limit=10`,
    {
      headers: {
        'x-api-key': API_KEY
      }
    }
  );

  const data = await response.json();
  return data;
}

async function getProductOffers(productId) {
  const response = await fetch(
    `${BASE_URL}/products/${productId}/offers`,
    {
      headers: {
        'x-api-key': API_KEY
      }
    }
  );

  const data = await response.json();
  return data;
}

// Example usage
searchProducts('laptop').then(data => {
  console.log(`Found ${data.data.total} products`);

  if (data.data.results.length > 0) {
    const productId = data.data.results[0].id;
    return getProductOffers(productId);
  }
}).then(offersData => {
  if (offersData) {
    console.log(`Found ${offersData.data.offerCount} offers`);
  }
});