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

# Shopify Category Ranking API

> Category metadata plus a paginated listing of its apps.



## OpenAPI

````yaml openapi.json GET /v1/shopify/apps/category/{handle}
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/shopify/apps/category/{handle}:
    get:
      tags:
        - shopify
        - app-store
        - categories
      summary: Get one page of a Shopify App Store category
      description: Category metadata plus a paginated listing of its apps.
      parameters:
        - schema:
            type: string
            minLength: 1
            example: marketing
          required: true
          name: handle
          in: path
        - schema:
            type: integer
            minimum: 0
            exclusiveMinimum: true
            example: 1
          required: false
          name: page
          in: query
      responses:
        '200':
          description: Get one page of a Shopify App Store category
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CategoryDetail'
        '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:
    CategoryDetail:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        appCount:
          type: integer
        apps:
          type: array
          items:
            $ref: '#/components/schemas/CategoryApp'
        pagination:
          $ref: '#/components/schemas/Pagination'
        pageType:
          type: string
          enum:
            - topic
            - secondary
            - tertiary
        breadcrumbs:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              url:
                type: string
              handle:
                type: string
              parentHandle:
                type: string
                nullable: true
            required:
              - name
              - url
              - handle
              - parentHandle
        subCategories:
          type: array
          items:
            type: string
      required:
        - name
        - description
        - appCount
        - apps
        - pagination
        - pageType
        - breadcrumbs
        - subCategories
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: NOT_FOUND
            message:
              type: string
          required:
            - code
            - message
      required:
        - error
    CategoryApp:
      type: object
      properties:
        name:
          type: string
        url:
          type: string
        handle:
          type: string
          nullable: true
        developer:
          type: string
          nullable: true
        rating:
          type: number
          nullable: true
        isSponsored:
          type: boolean
        isBuiltForShopify:
          type: boolean
        position:
          type: integer
      required:
        - name
        - url
        - handle
        - developer
        - rating
        - isSponsored
        - isBuiltForShopify
        - position
    Pagination:
      type: object
      properties:
        hasNextPage:
          type: boolean
        totalPages:
          type: integer
        currentPage:
          type: integer
      required:
        - hasNextPage
        - totalPages
        - currentPage
  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.

````