API Reference

REST API Reference

The PriceParity REST API is used by the SDK to evaluate pricing for a given visitor. You can also call it directly for server-side integrations.

Base URL

https://api.priceparity.net

All endpoints are served over HTTPS. HTTP requests are redirected automatically.

Authentication

All API requests (except the engine endpoint) require an X-API-Key header containing your API key. Your API key is available in Dashboard → Settings → API Key.

curl https://api.priceparity.net/v1/tenants/me \ -H "X-API-Key: YOUR_API_KEY"

Keep your API key secret. Never expose it in client-side JavaScript or public repositories. The SDK uses a separate read-only key that is safe to include in frontend code.

Endpoints

POST/v1/engine/evaluateUsed by SDK

Evaluates the pricing for a visitor given their product ID. The API automatically detects the visitor's IP from the request. Returns a localised price and Paddle coupon code if a discount applies.

Request body

{ "productId": "pri_XXXXXXXXXXXXXXXXXXXXXXX" }

Response — discount applied

{ "productId": "pri_XXXXXXXXXXXXXXXXXXXXXXX", "countryCode": "BR", "discountPercent": 40, "couponCode": "PPP-BR-40-A1B2C3", "originalPrice": 49.00, "localizedPrice": 29.40, "currency": "USD", "tierName": "LATAM" }

Response — no discount

{ "productId": "pri_XXXXXXXXXXXXXXXXXXXXXXX", "countryCode": "US", "discountPercent": 0, "couponCode": null, "originalPrice": 49.00, "localizedPrice": 49.00, "currency": "USD", "tierName": null }

GET/health

Returns API health status. No authentication required.

{ "status": "healthy", "timestamp": "2026-04-27T10:00:00Z" }

Rate limits

Limit	Value
Per API key	200 req / min
Per IP address	60 req / min
Trial plan (evaluations)	200 / 30 days

Rate limit headers are returned on every response: X-RateLimit-Limit and X-RateLimit-Remaining.

Error codes

Status	Meaning
200 OK	Request succeeded.
400 Bad Request	Missing or invalid request body.
401 Unauthorized	Missing or invalid X-API-Key header.
402 Payment Required	Trial evaluation quota exceeded. Upgrade to Pro.
404 Not Found	Product ID not found or not associated with your account.
429 Too Many Requests	Rate limit exceeded. Slow down and retry.
500 Internal Server Error	Something went wrong on our end. Contact support if this persists.