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

# Get app

> Use this first when a user mentions an app. Pass any identifier or a name in `{app}`. Data older than
`max_age` (default 7 days) is refreshed from the store; an app we never saw is fetched on the spot (if it
is still being fetched after ~25 s you get HTTP 202 with `data: null` and a `job_id`).
`include` adds sections: `markets` (every storefront), `iap` (in-app purchases), `versions` (version
history with release notes), `privacy` (App Store privacy labels), `estimates` (modelled downloads /
revenue), `charts` (current top-chart positions), `summary` (AI summary, coming soon).




## OpenAPI

````yaml openapi.json GET /apps/{app}
openapi: 3.1.0
info:
  title: AppGoat API
  version: 1.0.0
  summary: App Store + Google Play data for agents and apps.
  description: >
    Every app and developer in both stores, daily top charts, reviews, change
    feeds, metric history and keyword

    (search-rank) intelligence.


    **Conventions**

    - `{app}` accepts anything that identifies an app: an App Store id
    (`284882215`, `id284882215`), a Play
      package (`com.spotify.music`), an Apple bundle id (`com.spotify.client`), a store URL, `apple:<id>` /
      `play:<id>`, or a name (`spotify` → best match, with a warning in `meta.warnings`). Add `store=apple|play`
      to disambiguate. `data.linked` is the same app in the other store when we know it.
    - Freshness is automatic: app-scoped reads refresh data older than `max_age`
    seconds from the store first
      (1 credit per country fetched, capped at 10). `wait=true` (default) blocks up to ~25 s; on timeout, or with
      `wait=false`, you get the cached data with `meta.freshness.refreshing: true` and a `job_id` to poll at
      `GET /v1/jobs/{id}` (free).
    - `country` defaults to `us`; pass a comma list (paid plans) or `all`
    (Studio).

    - `include=` adds sections, `fields=` keeps only the listed top-level
    fields, lists page with `cursor`
      (pass `meta.next_cursor` back unchanged).
    - Every success is `{ data, meta }`; `meta.credits_used` is what the call
    cost and `meta.credits_remaining`
      what is left. Errors are `{ error: { code, message, hint, docs } }`: read `hint`, it says what to do next.
    - `x-credits` on each operation documents its price.

    - Watches turn store changes into events: `POST /v1/watches`, then poll `GET
    /v1/events` or add a webhook
      (`POST /v1/webhooks`). Watches, events and webhooks are free; only the plan's watched-app and keyword-slot
      limits apply. `/v1/tracked-keywords` is deprecated: use keyword watches.
  contact:
    email: support@appgoat.ai
    url: https://appgoat.ai
servers:
  - url: https://api.appgoat.ai/v1
security:
  - apiKey: []
tags:
  - name: Apps
  - name: Search & charts
  - name: Keywords
  - name: Developers
  - name: Audits
  - name: Watches & events
    description: >-
      Watch apps, competitors and keywords; significant changes become events
      (feed, webhooks, Slack, GitHub, daily email digest).
  - name: Webhooks
  - name: Connections
  - name: Actions
  - name: Jobs
  - name: Account
paths:
  /apps/{app}:
    get:
      tags:
        - Apps
      summary: >-
        Get everything about one app (metadata, ratings, price, markets, linked
        app in the other store).
      description: >
        Use this first when a user mentions an app. Pass any identifier or a
        name in `{app}`. Data older than

        `max_age` (default 7 days) is refreshed from the store; an app we never
        saw is fetched on the spot (if it

        is still being fetched after ~25 s you get HTTP 202 with `data: null`
        and a `job_id`).

        `include` adds sections: `markets` (every storefront), `iap` (in-app
        purchases), `versions` (version

        history with release notes), `privacy` (App Store privacy labels),
        `estimates` (modelled downloads /

        revenue), `charts` (current top-chart positions), `summary` (AI summary,
        coming soon).
      operationId: getApp
      parameters:
        - $ref: '#/components/parameters/App'
        - $ref: '#/components/parameters/StoreHint'
        - $ref: '#/components/parameters/Country'
        - name: include
          in: query
          description: Comma list of extra sections.
          schema:
            type: string
            example: versions,iap
        - $ref: '#/components/parameters/MaxAgeApp'
        - $ref: '#/components/parameters/Wait'
        - $ref: '#/components/parameters/Fields'
      responses:
        '200':
          description: The app.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - properties:
                      data:
                        $ref: '#/components/schemas/App'
              example:
                data:
                  store: apple
                  app_id: '324684580'
                  bundle_id: com.spotify.client
                  title: 'Spotify: Music and Podcasts'
                  developer:
                    id: '324684583'
                    name: Spotify
                  rating: 4.78
                  ratings_count: 42668141
                  version: 9.1.92
                  markets:
                    - country: us
                      available: true
                      price: 0
                      currency: USD
                      rating: 4.78
                      ratings_count: 42668141
                      version: 9.1.92
                      fetched_at: '2026-10-22T15:03:07Z'
                  linked:
                    store: play
                    app_id: com.spotify.music
                    title: 'Spotify: Music and Podcasts'
                    icon_url: https://…
                    match: developer
                meta:
                  credits_used: 1
                  credits_remaining: 9981
                  store: apple
                  freshness:
                    fetched_at: '2026-10-22T15:03:07Z'
                    age_seconds: 3600
                    stale: false
                    refreshing: false
                    job_id: null
                  request_id: req_123
        '202':
          $ref: '#/components/responses/Fetching'
        '400':
          $ref: '#/components/responses/InvalidParam'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '404':
          $ref: '#/components/responses/AppNotFound'
components:
  parameters:
    App:
      name: app
      in: path
      required: true
      description: >-
        Any app identifier: App Store id (`284882215`, `id284882215`), Play
        package (`com.spotify.music`), Apple bundle id (`com.spotify.client`),
        store URL (URL-encoded), `apple:<id>` / `play:<id>`, or a name
        (`spotify`).
      schema:
        type: string
        example: com.spotify.music
    StoreHint:
      name: store
      in: query
      description: Disambiguates `{app}` (a bundle id vs a Play package, or a name).
      schema:
        $ref: '#/components/schemas/Store'
    Country:
      name: country
      in: query
      description: >-
        ISO country code(s): `us` (default), a comma list (paid plans), or `all`
        (Studio).
      schema:
        type: string
        default: us
        example: us,de
    MaxAgeApp:
      name: max_age
      in: query
      description: >-
        Refresh from the store when our data is older than this many seconds (0
        = always). Default 604800 (7 days).
      schema:
        type: integer
        minimum: 0
        default: 604800
    Wait:
      name: wait
      in: query
      description: >-
        Block up to ~25 s for a refresh (default). false = answer immediately
        from cache with a job id.
      schema:
        type: boolean
        default: true
    Fields:
      name: fields
      in: query
      description: >-
        Comma list of top-level fields to return (identifiers are always kept),
        e.g. `title,rating,version`.
      schema:
        type: string
  schemas:
    Envelope:
      type: object
      required:
        - data
        - meta
      properties:
        data: {}
        meta:
          $ref: '#/components/schemas/Meta'
    App:
      type: object
      properties:
        store:
          $ref: '#/components/schemas/Store'
        app_id:
          type: string
        bundle_id:
          type:
            - string
            - 'null'
        url:
          type: string
        title:
          type:
            - string
            - 'null'
        subtitle:
          type:
            - string
            - 'null'
          description: App Store subtitle / Play short description.
        description:
          type:
            - string
            - 'null'
        developer:
          type: object
          properties:
            id:
              type:
                - string
                - 'null'
            name:
              type:
                - string
                - 'null'
        category:
          type:
            - string
            - 'null'
        genres:
          type: array
          items:
            type: string
        content_rating:
          type:
            - string
            - 'null'
        free:
          type:
            - boolean
            - 'null'
        price:
          type:
            - number
            - 'null'
        currency:
          type:
            - string
            - 'null'
        has_iap:
          type:
            - boolean
            - 'null'
        has_ads:
          type:
            - boolean
            - 'null'
        rating:
          type:
            - number
            - 'null'
        ratings_count:
          type:
            - integer
            - 'null'
        reviews_count:
          type:
            - integer
            - 'null'
        histogram:
          type:
            - array
            - 'null'
          items:
            type: integer
          description: 1★…5★ counts.
        installs_min:
          type:
            - integer
            - 'null'
        installs_exact:
          type:
            - integer
            - 'null'
        installs_text:
          type:
            - string
            - 'null'
        version:
          type:
            - string
            - 'null'
        release_notes:
          type:
            - string
            - 'null'
        min_os:
          type:
            - string
            - 'null'
        size_bytes:
          type:
            - integer
            - 'null'
        released_at:
          type:
            - string
            - 'null'
          format: date-time
        updated_at:
          type:
            - string
            - 'null'
          format: date-time
        icon_url:
          type:
            - string
            - 'null'
        screenshots:
          type: array
          items:
            type: string
        languages:
          type: array
          items:
            type: string
        status:
          type: string
          enum:
            - pending
            - active
            - delisted
            - error
        first_seen_at:
          type: string
          format: date-time
        last_fetched_at:
          type:
            - string
            - 'null'
          format: date-time
        markets:
          type: array
          items:
            $ref: '#/components/schemas/Market'
          description: The requested countries (all with include=markets).
        linked:
          type:
            - object
            - 'null'
          description: The same app in the other store.
          properties:
            store:
              $ref: '#/components/schemas/Store'
            app_id:
              type: string
            title:
              type:
                - string
                - 'null'
            icon_url:
              type:
                - string
                - 'null'
            match:
              type: string
              enum:
                - bundle_id
                - developer
        iap:
          type: object
          description: 'include=iap: items (App Store) or price_range (Play).'
        versions:
          type: array
          items:
            type: object
            properties:
              version:
                type: string
              first_seen_at:
                type: string
                format: date-time
              release_notes:
                type:
                  - string
                  - 'null'
        privacy:
          type: object
          description: 'include=privacy: App Store privacy labels.'
        estimates:
          type: array
          items:
            type: object
            properties:
              country:
                type: string
              month:
                type: string
              downloads:
                type:
                  - integer
                  - 'null'
              revenue_usd:
                type:
                  - integer
                  - 'null'
              confidence:
                type:
                  - number
                  - 'null'
        charts:
          type: array
          items:
            type: object
            properties:
              country:
                type: string
              chart:
                type: string
              category:
                type: string
              date:
                type: string
              rank:
                type: integer
    Store:
      type: string
      enum:
        - apple
        - play
    Meta:
      type: object
      properties:
        credits_used:
          type: integer
        credits_remaining:
          type: integer
          description: Added by the gateway.
        request_id:
          type: string
          description: Added by the gateway.
        freshness:
          $ref: '#/components/schemas/Freshness'
        next_cursor:
          type:
            - string
            - 'null'
        store:
          $ref: '#/components/schemas/Store'
        warnings:
          type: array
          items:
            type: string
          description: Things to know (e.g. "resolved by name"); safe to show to the user.
    Market:
      type: object
      properties:
        country:
          type: string
        available:
          type: boolean
        title:
          type:
            - string
            - 'null'
        price:
          type:
            - number
            - 'null'
        currency:
          type:
            - string
            - 'null'
        rating:
          type:
            - number
            - 'null'
        ratings_count:
          type:
            - integer
            - 'null'
        version:
          type:
            - string
            - 'null'
        fetched_at:
          type: string
          format: date-time
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              enum:
                - invalid_param
                - invalid_credentials
                - unauthorized
                - forbidden
                - insufficient_credits
                - plan_limit
                - free_audit_used
                - not_found
                - app_not_found
                - developer_not_found
                - job_not_found
                - conflict
                - not_ready
                - rate_limited
                - provider_error
                - internal_error
                - not_configured
            message:
              type: string
            hint:
              type: string
              description: What to do next.
            docs:
              type: string
              format: uri
            param:
              type: string
    Freshness:
      type: object
      properties:
        fetched_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When the oldest requested country was last fetched from the store.
        age_seconds:
          type:
            - integer
            - 'null'
        stale:
          type: boolean
          description: Older than max_age (or missing).
        refreshing:
          type: boolean
          description: A store fetch is still running; poll job_id.
        job_id:
          type:
            - string
            - 'null'
  responses:
    Fetching:
      description: >-
        Not in the catalog yet and still being fetched; poll `GET
        /v1/jobs/{meta.freshness.job_id}` and call again.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Envelope'
    InvalidParam:
      description: A parameter is missing or invalid (`error.param` names it).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: invalid_param
              message: limit must be ≤ 100
              hint: Fix the parameter and retry.
              docs: https://appgoat.ai/docs/errors#invalid_param
              param: limit
    PaymentRequired:
      description: >-
        `insufficient_credits` (the call costs more than you have left; nothing
        was done) or `plan_limit` (a feature of a higher plan).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    AppNotFound:
      description: Nothing matches `{app}`, or the store does not have it.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Create a key at https://dash.appgoat.ai.

````

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