Official examples, SDKs, and integration guides for the Proofio API.
Proofio aggregates customer reviews from every major platform — App Store, Google Play, Trustpilot, Google Maps, Yelp, G2, Facebook, and more — and surfaces AI-powered insights through a simple REST API and TypeScript SDK.
# Install the official SDK
npm install proofio-sdkimport { ProofioClient } from "proofio-sdk";
const proofio = new ProofioClient({ apiKey: "YOUR_API_KEY" });
const reviews = await proofio.reviews.list({ limit: 10, sentiment: "positive" });
console.log(reviews);Get your API key from the Proofio Dashboard → Project → Settings → API.
examples/
javascript/ Vanilla JS + Node.js fetch examples
react/ React hooks and components
nextjs/ Next.js App Router integration
python/ Python (requests) examples
php/ PHP cURL examples
ruby/ Ruby examples
curl/ Raw cURL one-liners
widgets/ Embeddable review widgets
html/ Standalone HTML snippets
react/ React widget components
nextjs/ Next.js widget pages
wordpress/ WordPress integration
shopify/ Shopify Liquid templates
guides/
quickstart.md Get up and running in 5 minutes
authentication.md API keys, scopes, and security
rate-limiting.md Quotas, headers, and best practices
filtering.md Query parameters reference
error-handling.md Status codes and retry logic
webhooks.md Real-time event notifications (coming soon)
Base URL: https://api.proofio.app/api/v1/public
| Endpoint | Description |
|---|---|
GET /reviews |
Fetch paginated reviews with filters |
GET /aggregations |
Rating distributions & sentiment breakdown |
GET /clusters |
AI-generated topic clusters |
Authentication: Pass your API key in the x-api-key header.
curl https://api.proofio.app/api/v1/public/reviews \
-H "x-api-key: YOUR_API_KEY"| Plan | Monthly Requests |
|---|---|
| Starter (Free) | 300 |
| Growth ($39/mo) | 10,000 |
| Scale ($199/mo) | 50,000 |
Rate limit headers are returned on every response:
X-RateLimit-Limit: 10000
X-RateLimit-Remaining: 9847
X-RateLimit-Reset: 1746057600
Found a bug or want to add an example in a new language? PRs are welcome.
- Fork the repo
- Create a branch:
git checkout -b feat/my-example - Add your example with a clear
README.md - Open a pull request
Please follow the existing file structure and naming conventions.
MIT — see LICENSE