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

# App Store App Profile API

> Name, description, rating, developer, pricing, and screenshots for one app.



## OpenAPI

````yaml openapi.json GET /v1/apple/apps/{appId}
openapi: 3.0.0
info:
  title: ScoutLayer API
  version: 1.0.0
  description: Competitor data. One API.
servers:
  - url: https://api.scoutlayer.io
    description: Production
security:
  - ApiKeyAuth: []
  - BearerAuth: []
paths:
  /v1/apple/apps/{appId}:
    get:
      tags:
        - apple
        - app-store
        - apps
      summary: Get an App Store app by ID
      description: >-
        Name, description, rating, developer, pricing, and screenshots for one
        app.
      parameters:
        - schema:
            type: string
            minLength: 1
            example: '310633997'
          required: true
          name: appId
          in: path
        - schema:
            type: string
            example: US
          required: false
          name: country
          in: query
      responses:
        '200':
          description: Get an App Store app by ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppStoreListing'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: Insufficient credits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '501':
          description: This endpoint is declared but not yet implemented — never charged
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: The orchestrator failed or was unreachable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKeyAuth: []
        - BearerAuth: []
components:
  schemas:
    AppStoreListing:
      type: object
      properties:
        appId:
          type: string
        store:
          type: string
          enum:
            - apple
            - google-play
            - shopify
        title:
          type: string
        subtitle:
          type: string
          nullable: true
          description: Apple only
        url:
          type: string
        iconUrl:
          type: string
        description:
          type: string
        rating:
          type: object
          properties:
            value:
              type: number
              nullable: true
            max:
              type: integer
          required:
            - value
            - max
        reviewsCount:
          type: integer
          nullable: true
          description: >-
            Apple doesn't expose a total review count — null there is real, not
            missing data
        price:
          type: object
          properties:
            current:
              type: number
            currency:
              type: string
            displayed:
              type: string
          required:
            - current
            - currency
            - displayed
        isFree:
          type: boolean
        mainCategory:
          type: string
        categories:
          type: array
          items:
            type: string
        installs:
          type: string
          nullable: true
          description: Google Play only, e.g. "10,000,000+"
        installsCount:
          type: integer
          nullable: true
          description: Google Play only
        developer:
          type: object
          properties:
            name:
              type: string
            id:
              type: string
            url:
              type: string
            email:
              type: string
              nullable: true
              description: Google Play only
            website:
              type: string
              nullable: true
              description: Google Play only
          required:
            - name
            - id
            - url
            - email
            - website
        minimumOsVersion:
          type: string
          nullable: true
        sizeBytes:
          type: integer
          nullable: true
        releasedAt:
          type: string
          nullable: true
        lastUpdatedAt:
          type: string
          nullable: true
          description: A competitor's release cadence signal
        updateNotes:
          type: string
          nullable: true
        screenshotUrls:
          type: array
          items:
            type: string
        videoUrls:
          type: array
          items:
            type: string
        languages:
          type: array
          items:
            type: string
        contentRating:
          type: string
          nullable: true
        similarApps:
          type: array
          items:
            type: object
            properties:
              appId:
                type: string
              title:
                type: string
            required:
              - appId
              - title
        moreByDeveloper:
          type: array
          items:
            type: object
            properties:
              appId:
                type: string
              title:
                type: string
            required:
              - appId
              - title
        checkedAt:
          type: string
      required:
        - appId
        - store
        - title
        - subtitle
        - url
        - iconUrl
        - description
        - rating
        - reviewsCount
        - price
        - isFree
        - mainCategory
        - categories
        - installs
        - installsCount
        - developer
        - minimumOsVersion
        - sizeBytes
        - releasedAt
        - lastUpdatedAt
        - updateNotes
        - screenshotUrls
        - videoUrls
        - languages
        - contentRating
        - similarApps
        - moreByDeveloper
        - checkedAt
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: NOT_FOUND
            message:
              type: string
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API key passed as the X-API-Key request header. Recommended for
        server-to-server calls.
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key (or OAuth token) passed as a Bearer token in the Authorization
        header.

````