> ## 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 keywords

> `popularity` is 5–100 (search volume proxy; `popularity_source: apple` = Apple Search Ads data),
`difficulty` 0–100 (how entrenched the top 10 is), `est_downloads_at_1` the modelled daily downloads of the
#1 result. Terms not measured in the last 7 days are measured live (≤ 5 per call, 2–5 s each) when
`wait=true`; others return `pending: true` — call again in a minute.
`include=related` adds ~10 related terms with their metrics, `suggestions` the store's autocomplete,
`top_apps` the current top 10 apps. Pass `app=` to get that app's rank and a metadata `relevance` (0–1) for
every term — the core of an ASO keyword audit.




## OpenAPI

````yaml openapi.json GET /keywords
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:
  /keywords:
    get:
      tags:
        - Keywords
      summary: >-
        Get keyword metrics (popularity, difficulty) for up to 25 terms; with
        include=related, keyword research.
      description: >
        `popularity` is 5–100 (search volume proxy; `popularity_source: apple` =
        Apple Search Ads data),

        `difficulty` 0–100 (how entrenched the top 10 is), `est_downloads_at_1`
        the modelled daily downloads of the

        #1 result. Terms not measured in the last 7 days are measured live (≤ 5
        per call, 2–5 s each) when

        `wait=true`; others return `pending: true` — call again in a minute.

        `include=related` adds ~10 related terms with their metrics,
        `suggestions` the store's autocomplete,

        `top_apps` the current top 10 apps. Pass `app=` to get that app's rank
        and a metadata `relevance` (0–1) for

        every term — the core of an ASO keyword audit.
      operationId: getKeywords
      parameters:
        - name: q
          in: query
          description: One term. Use `qs` for several.
          schema:
            type: string
            example: photo editor
        - name: qs
          in: query
          description: Comma-separated terms (≤ 25; ≤ 5 with related / suggestions).
          schema:
            type: string
            example: photo editor,collage maker
        - name: store
          in: query
          description: Required unless `app` is given.
          schema:
            $ref: '#/components/schemas/Store'
        - name: country
          in: query
          schema:
            type: string
            default: us
        - name: include
          in: query
          description: 'Comma list: related, suggestions, top_apps.'
          schema:
            type: string
        - name: app
          in: query
          description: >-
            Any app identifier (as in `{app}`); adds `app.rank` and
            `app.relevance` per term.
          schema:
            type: string
        - $ref: '#/components/parameters/Wait'
      responses:
        '200':
          description: One entry per term, in request order.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/Keyword'
              example:
                data:
                  - term: photo editor
                    store: apple
                    country: us
                    popularity: 62
                    popularity_source: proxy
                    difficulty: 81
                    results_count: 200
                    est_downloads_at_1: 2900
                    measured_at: '2026-10-20T10:00:00Z'
                    pending: false
                    top_app_ids:
                      - '1'
                      - '2'
                    app:
                      store: apple
                      app_id: '1'
                      rank: 14
                      relevance: 1
                meta:
                  credits_used: 1
                  store: apple
        '400':
          $ref: '#/components/responses/InvalidParam'
        '402':
          $ref: '#/components/responses/PaymentRequired'
components:
  schemas:
    Store:
      type: string
      enum:
        - apple
        - play
    Envelope:
      type: object
      required:
        - data
        - meta
      properties:
        data: {}
        meta:
          $ref: '#/components/schemas/Meta'
    Keyword:
      allOf:
        - $ref: '#/components/schemas/KeywordMetrics'
        - type: object
          properties:
            top_app_ids:
              type: array
              items:
                type: string
            top_apps:
              type: array
              items:
                $ref: '#/components/schemas/AppCard'
            related:
              type: array
              items:
                $ref: '#/components/schemas/KeywordMetrics'
            suggestions:
              type: array
              items:
                type: string
            app:
              type: object
              properties:
                store:
                  $ref: '#/components/schemas/Store'
                app_id:
                  type: string
                rank:
                  type:
                    - integer
                    - 'null'
                relevance:
                  type: number
                  description: >-
                    0–1: term coverage in title (1), subtitle (0.7), description
                    (0.4).
    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.
    KeywordMetrics:
      type: object
      properties:
        term:
          type: string
        store:
          $ref: '#/components/schemas/Store'
        country:
          type: string
        popularity:
          type:
            - integer
            - 'null'
          description: 5–100.
        popularity_source:
          type:
            - string
            - 'null'
          enum:
            - apple
            - proxy
            - null
        difficulty:
          type:
            - integer
            - 'null'
          description: 0–100.
        difficulty_breakdown:
          type:
            - object
            - 'null'
        results_count:
          type:
            - integer
            - 'null'
        est_downloads_at_1:
          type:
            - integer
            - 'null'
        measured_at:
          type:
            - string
            - 'null'
          format: date-time
        pending:
          type: boolean
          description: Being measured; call again in a minute.
    AppCard:
      type: object
      properties:
        store:
          $ref: '#/components/schemas/Store'
        app_id:
          type: string
        title:
          type:
            - string
            - 'null'
        developer_name:
          type:
            - string
            - 'null'
        icon_url:
          type:
            - string
            - 'null'
        category:
          type:
            - string
            - 'null'
        rating:
          type:
            - number
            - 'null'
        ratings_count:
          type:
            - integer
            - 'null'
        installs_min:
          type:
            - integer
            - 'null'
          description: Play install bucket lower bound.
        price:
          type:
            - number
            - 'null'
    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'
  parameters:
    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
  responses:
    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'
  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.