Commercial use

The TweakReviewsDB API is free to use for non-commercial use. If you would like to use it with a commercial application or if you have any questions about the API, you can send us an email or message us on Twitter.

Including reviews from TweakReviewsDB in Sileo depictions

You can easily include reviews from TweakReviewsDB in your Sileo depictions by adding a table button view.

{
  "class": "DepictionTableButtonView",
  "title": "Reviews",
  "action": "depiction-https://tweakreviews.pixelomer.com/sileo/package/package-id.json"
}

The following query items are supported.

  • maxReviews: When this item is set to an integer, the number of returned reviews will not be more than this number.
Including reviews from TweakReviewsDB in HTML depictions

You can include reviews from TweakReviewsDB in your HTML depictions with an iframe.

<iframe src="https://tweakreviews.pixelomer.com/web/package/package-id?hideHeader=1">
</iframe>

The following query items are supported.

  • maxReviews: When this item is set to an integer, the number of returned reviews will not be more than this number.
  • hideHeader: Hides the "TweakReviewsDB Web" header when set to 1. Recommended.
  • hideSummary: Hides the summary at the top of the page when set to 1.
Fetching reviews with the TweakReviewsDB API

You can fetch reviews with the following endpoint.

GET /api/v3/package/:packageID/:packageVersion/:iOS/:deviceModel

The parameters iOS, deviceModel and packageVersion are optional. You can specify "any" for these parameters. These parameters only affect compatibility reviews and do not affect content reviews.

Example request

The following query items are supported.

  • maxReviews: Specifies the number of reviews to include in a single response. This endpoint supports pagination.
  • includeStatus: Compatibility reviews will not be returned when this item is set to 0.
  • includeReviews: Content reviews will not be returned when this item is set to 0.