> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Google play reviews API

> Get an app's Google Play reviews. Call the Google play reviews API and get JSON back in one request. 1 credit per call. Failed calls cost nothing.

Returns an app's Google Play reviews. The app is identified by its URL or ID.

## Request

Exactly one of `appUrl` or `appId` is required. A request that sets both, or none, fails with `invalidRequest`.

<CodeGroup>
  ```typescript TypeScript icon="https://mintlify.s3.us-west-1.amazonaws.com/sirathic/images/icons/typescript.svg" theme={null} theme={null}
  import { Stophy } from "stophy";

  const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
  const result = await stophy.google.play.reviews({ appId: "com.spotify.music" });
  console.log(result.data.results);
  ```

  ```python Python icon="python" theme={null} theme={null}
  from stophy import Stophy

  stophy = Stophy()  # reads STOPHY_API_KEY
  result = stophy.google.play.reviews(app_id="com.spotify.music")
  print(result["data"]["results"])
  ```

  ```bash cURL icon="terminal" theme={null} theme={null}
  curl -X POST https://api.stophy.dev/v1/google/play/reviews \
    -H "Authorization: Bearer $STOPHY_API_KEY" \
    -H "content-type: application/json" \
    -d '{"appId":"com.spotify.music"}'
  ```

  ```bash CLI icon="square-terminal" theme={null} theme={null}
  stophy google play reviews --appId com.spotify.music
  ```
</CodeGroup>

## Response

If successful, the response body contains the standard envelope. `data.results[]` contains the app's reviews, each with its rating, text and app version.

The following example is a real response, truncated: each list shows one item and long strings are cut.

```json theme={null}
{
  "success": true,
  "data": {
    "results": [
      {
        "reviewId": "1a4c762b-2485-43c9-b650-26f156a0bb8e",
        "reviewUrl": "https://play.google.com/store/apps/details?id=com.spotify.music&reviewId=1a4c762b-2485-43c9-b650-26f156a0bb8e",
        "rating": 5,
        "text": "wonderful",
        "authorName": "Catherine Karnes",
        "authorAvatarUrl": "https://play-lh.googleusercontent.com/a-/ALV-UjVTvMvluNuCMD5by8WaWKHREjxco1xFbkGxTiAYWQR56WM3NQ",
        "publishedAt": "2026-10-04T20:41:00.000Z",
        "likes": 0,
        "appVersion": "9.1.88.2204"
      }
    ],
    "cursor": "Cs4BIsUBAV8d1P1XyJzoCkS2MkuhVw8-kSz5Novn3dcOEAaUonNI3-AUKSEanOvKpDWreoUnFQ5wxw35brKzwAbyPz1gFz18G5S5_YzCDNXUNJ7H9NAofms…"
  },
  "creditsUsed": 1,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}
```

| Field | Type | Description |
| - | - | - |
| `cursor` | string | The pagination token. Pass it as `cursor` to retrieve the next page. Omitted on the last page. |
| `publishedAt` | string (ISO 8601) | The publication time, in UTC. |
| `rating` | integer | The average star rating, on a scale of 1 to 5. |
| `likes` | integer | The number of likes. |

For every field, see the response schema on this page.

## Optional parameters

| Parameter | Type | Description |
| - | - | - |
| `country` | string | The country to query, as a two-letter ISO 3166-1 code such as `us`. If unset, defaults to `us`. |
| `language` | string | The language of the results, as a BCP 47 tag such as `en` or `pt-BR`. If unset, defaults to `en`. |
| `sort` | string | Specifies which reviews are returned first. Acceptable values are `newest`, `relevance` and `highest`. If unset, defaults to `newest`. |
| `rating` | integer | Restricts results to reviews with this many stars. Must be between 1 and 5. |
| `cursor` | string | The pagination token from the previous response. |

## Billing

Each successful request consumes 1 credit, regardless of the number of items returned. Requests that fail, or that return no items, are not billed.

## Pagination

Results are paginated. To retrieve the next page, pass the value of `data.cursor` as `cursor` in a subsequent request. A response that omits `cursor` is the last page.

## Related methods

* [Google Play app](/api-reference/endpoint/google-play-app): Accepts the same `appId`. Returns an app's details from Google Play.


## OpenAPI

````yaml api-reference/openapi.json POST /v1/google/play/reviews
openapi: 3.1.0
info:
  title: Stophy API
  version: '1'
  description: >-
    Every endpoint is a POST that takes its input as a JSON object body. Unknown
    fields are rejected with 400.


    Responses leave out empty values: null, empty strings, empty objects and
    empty nested lists are not sent.


    x-credits is what one call costs. Every call costs the same, whatever it
    returns, unless an operation's description says it costs per 10 results, or
    per second of audio. Then x-credits is the lowest price and x-credits-max
    the most one call can cost. Where an operation takes limit, send it to
    return fewer results and pay for fewer.


    When a response has a cursor, send it back unchanged with the same input to
    get the next page. When it has a page, send the next page number.
servers:
  - url: https://api.stophy.dev
security:
  - apiKey: []
paths:
  /v1/google/play/reviews:
    post:
      summary: Get an app's Google Play reviews
      description: Costs 1 credit per call. Pages with cursor.
      operationId: googlePlayReviews
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                appUrl:
                  type: string
                  description: >-
                    Link to the Google Play app, like
                    https://play.google.com/store/apps/details?id=com.spotify.music.
                    Send this or appId.
                appId:
                  type: string
                  description: >-
                    Google Play app package name, like com.spotify.music. Send
                    this or appUrl.
                country:
                  default: us
                  type: string
                  pattern: ^[A-Za-z]{2}$
                  description: >-
                    ISO 3166-1 alpha-2 country code, e.g. us. Any case is
                    accepted.
                language:
                  default: en
                  type: string
                  pattern: ^[A-Za-z]{2,3}(?:[-_][A-Za-z0-9]{2,4})?$
                  description: BCP 47 language tag, e.g. en or pt-BR. Any case is accepted.
                sort:
                  default: newest
                  type: string
                  enum:
                    - newest
                    - relevance
                    - highest
                rating:
                  type: integer
                  minimum: 1
                  maximum: 5
                cursor:
                  type: string
                  minLength: 1
                  description: The cursor from the previous response. Send it as is.
              sendOne:
                - appUrl
                - appId
              additionalProperties: false
            example:
              appId: com.spotify.music
      responses:
        '200':
          description: The data, and the credits this call used.
          headers:
            X-Request-ID:
              $ref: '#/components/headers/RequestId'
            x-credits-used:
              $ref: '#/components/headers/CreditsUsed'
            X-RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            x-cache:
              $ref: '#/components/headers/Cache'
            x-cache-age:
              $ref: '#/components/headers/CacheAge'
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                  - creditsUsed
                  - requestId
                properties:
                  success:
                    const: true
                  data:
                    type: object
                    additionalProperties: false
                    properties:
                      results:
                        type: array
                        items:
                          type: object
                          additionalProperties: false
                          properties:
                            reviewId:
                              type: string
                            reviewUrl:
                              type: string
                              format: uri
                            rating:
                              type: integer
                              minimum: 1
                              maximum: 5
                            text:
                              type: string
                            authorName:
                              type: string
                            authorAvatarUrl:
                              type: string
                              format: uri
                            publishedAt:
                              type: string
                              format: date-time
                              pattern: >-
                                ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                            likes:
                              type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                            appVersion:
                              type: string
                            ownerReplyText:
                              type: string
                            ownerReplyAt:
                              type: string
                              format: date-time
                              pattern: >-
                                ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                          required:
                            - reviewUrl
                            - rating
                            - likes
                      cursor:
                        type: string
                    required:
                      - results
                  creditsUsed:
                    type: integer
                  requestId:
                    type: string
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
components:
  headers:
    RequestId:
      description: The request id. Quote it when you report a problem.
      schema:
        type: string
    CreditsUsed:
      description: Credits this call used.
      schema:
        type: integer
    RateLimitLimit:
      description: Requests allowed in the current window.
      schema:
        type: integer
    RateLimitRemaining:
      description: Requests left in the current window.
      schema:
        type: integer
    RateLimitReset:
      description: Unix time in seconds when the current window resets.
      schema:
        type: integer
    Cache:
      description: hit if this result came from the cache, miss if it was fetched live.
      schema:
        type: string
    CacheAge:
      description: Seconds since the returned result was written to the cache.
      schema:
        type: integer
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
  responses:
    Error:
      description: The request failed. retryable says whether trying again can help.
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestId'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
        - success
        - error
      properties:
        success:
          const: false
        error:
          type: object
          required:
            - code
            - message
            - retryable
            - requestId
          properties:
            code:
              type: string
              enum:
                - cliSessionCompleted
                - cliSessionExists
                - cliSessionNotFound
                - forbidden
                - insufficientCredits
                - internalError
                - inviteClaimed
                - inviteDisabled
                - inviteExpired
                - inviteUsedUp
                - invalidCliSession
                - invalidCliVerifier
                - invalidRequest
                - notFound
                - rateLimited
                - sourceChanged
                - sourceRefused
                - sourceTimeout
                - sourceUnavailable
                - tooManyInFlight
                - unauthorized
                - unsupportedMediaType
            message:
              type: string
            retryable:
              type: boolean
            retryAfterSeconds:
              type: integer
            requestId:
              type: string
            requiredCredits:
              type: number
            availableCredits:
              type: number
            billingUrl:
              type: string
              const: https://stophy.dev/billing
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.