favicon.zip API

openapi: 3.1.0
info:
  title: favicon.zip API
  version: '2026-11-07'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-07: 4 operation(s) read from 4 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; favicon.zip has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 2
    documentation: 2
    pages-with-code: 3
    pages-read: 4
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-07'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://favicon.zip/favicon-api
  - https://favicon.zip/favicon-checker
  - https://favicon.zip/llms.txt
  - https://favicon.zip/text-favicon-generator
paths:
  /api/check:
    get:
      operationId: get_api_check
      tags:
      - Api
      summary: Favicon Generator API — Generate Favicons over HTTP | favicon.zip
      description: Endpoint returns a JSON favicon report for the given URL.
      x-source: https://favicon.zip/favicon-api
      parameters:
      - name: url
        in: query
        required: true
        schema:
          type: string
        description: Domain to check, e.g. example.com
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiCheckResponse'
      x-evidence:
        kind: documentation
  /api/fetch-icon:
    get:
      operationId: get_api_fetch_icon
      tags:
      - Api
      summary: Favicon Generator API — Generate Favicons over HTTP | favicon.zip
      description: Returns the best favicon for the given site as raw bytes.
      x-source: https://favicon.zip/favicon-api
      parameters:
      - name: url
        in: query
        required: true
        schema:
          type: string
        description: Domain to fetch the best icon from, e.g. example.com
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiFetchIconResponse'
      x-evidence:
        kind: documentation
  /api/generate:
    get:
      operationId: get_api_generate
      tags:
      - Api
      summary: GET /api/generate
      x-source: https://favicon.zip/favicon-api
      parameters:
      - name: spec
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiGenerateResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -o favicon.zip "https://favicon.zip/api/generate?spec=$SPEC" Other endpoints endpoint returns GET /api/check?url=example.com
          A JSON favicon report, the same one the checker shows. GET /api/fetch-icon?url=example.com The best icon the site currently ships, as
          bytes. The x-icon-source header says which file was chosen. Errors and limits Validation problems return 400 with {"error": "..."} expla'
    post:
      operationId: post_api_generate
      tags:
      - Api
      summary: POST /api/generate
      x-source: https://favicon.zip/favicon-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiGenerateRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiGenerateResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X POST https://favicon.zip/api/generate  -H ''content-type: application/json''  -d ''{"text": "F", "font": "Inter", "background":
          "#daff24", "radius": 0.25, "padding": 0.1}''  -o favicon.zip The response is application/zip : favicon.ico , icon.svg , favicon-96x96.png
          , apple-touch-icon.png , the PWA icons, manifest.webmanifest , and a favicon-setup.md with the install snippet for your framework.'
components:
  schemas:
    GetApiCheckResponse:
      type: object
      properties:
        report:
          type: object
          description: A JSON favicon report, the same one the checker shows.
    GetApiFetchIconResponse:
      type: object
      properties:
        icon_bytes:
          type: string
          description: The best icon the site currently ships, returned as raw bytes.
        x-icon-source:
          type: string
          description: Header indicating which file was chosen.
    GetApiGenerateResponse:
      type: object
      properties:
        error:
          type: string
    PostApiGenerateRequest:
      type: object
      properties:
        text:
          type: string
        font:
          type: string
        background:
          type: string
        radius:
          type: number
        padding:
          type: number
    PostApiGenerateResponse:
      type: object
      properties:
        text:
          type: string
        background:
          type: string
        text_color:
          type: string
        radius:
          type: number
tags:
- name: Api