openapi: 3.1.0
info:
  title: SEO Scanner Public API
  version: 1.0.0
  description: Account-based API for SEO Scanner technical analysis, WHOIS/RDAP lookup, sitemap discovery, site snapshots, badges, OG images, and vitals. API access must be enabled in account settings.
servers:
  - url: https://seoscanner.it/api/v1
  - url: https://seoscanner.it
paths:
  /analyze:
    post:
      summary: Analyze a single page
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required: [url]
              properties:
                url:
                  type: string
                  format: uri
      responses:
        '200':
          description: Analysis completed
        '400':
          description: Invalid request
        '429':
          description: Rate limit exceeded
  /whois:
    post:
      summary: Lookup WHOIS / RDAP data
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required: [domain]
              properties:
                domain:
                  type: string
      responses:
        '200':
          description: WHOIS lookup completed
  /sitemap:
    post:
      summary: Discover and parse a sitemap
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required: [url]
              properties:
                url:
                  type: string
                  format: uri
      responses:
        '200':
          description: Sitemap discovery completed
  /api/site/{domain}:
    get:
      summary: Get a site snapshot
      parameters:
        - name: domain
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Site snapshot returned
  /api/badge/{slug}:
    get:
      summary: Get a score badge
      parameters:
        - name: slug
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: SVG badge returned
  /api/og/{slug}:
    get:
      summary: Get an OG image
      parameters:
        - name: slug
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OG image returned
  /api/vitals:
    post:
      summary: Submit web vitals
      responses:
        '204':
          description: Vitals accepted