API Reference

Complete reference for the PriceSentry API with code examples in multiple languages and response examples.

API Endpoints

Complete reference for all available endpoints with code examples and response formats.

Products

Manage your monitored products

GET/api/v1/products
FreeAvailable

List all products with pagination and filtering

GET/api/v1/products

List all products with pagination and filtering

GET /api/v1/products
curl -X GET "https://api.pricesentry.io/api/v1/products" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Examples

POST/api/v1/products
StarterAvailable

Create a new product for monitoring

POST/api/v1/products

Create a new product for monitoring

POST /api/v1/products
curl -X POST "https://api.pricesentry.io/api/v1/products" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "iPhone 15 Pro",
  "brand": "Apple",
  "sku": "IPHONE15PRO",
  "category": "Electronics",
  "description": "Latest iPhone model",
  "base_price": 999.99,
  "currency": "USD",
  "url": "https://example.com/iphone-15-pro"
}'

Response Examples

GET/api/v1/products/{id}
FreeAvailable

Get detailed information for a specific product

GET/api/v1/products/{id}

Get detailed information for a specific product

GET /api/v1/products/{id}
curl -X GET "https://api.pricesentry.io/api/v1/products/{id}" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Examples

PUT/api/v1/products/{id}
StarterAvailable

Update product information

PUT/api/v1/products/{id}

Update product information

PUT /api/v1/products/{id}
curl -X PUT "https://api.pricesentry.io/api/v1/products/{id}" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "iPhone 15 Pro Updated",
  "brand": "Apple",
  "base_price": 899.99,
  "currency": "USD"
}'

Response Examples

DELETE/api/v1/products/{id}
StarterAvailable

Delete a product from monitoring

DELETE/api/v1/products/{id}

Delete a product from monitoring

DELETE /api/v1/products/{id}
curl -X DELETE "https://api.pricesentry.io/api/v1/products/{id}" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Examples

Competitors

Manage competitor tracking and analysis

Prices

Access price data and historical trends

Alerts

Manage price alerts and notifications

Webhooks

Manage webhook endpoints for real-time notifications

Need Help?

Get started quickly with our guides and resources.

SDKs & Libraries
  • Node.js/TypeScriptComing Soon
  • PythonComing Soon
  • PHPComing Soon
  • GoComing Soon
  • JavaComing Soon