HTMLCompressor public API (beta)

To use the API simply perform a POST request to https://htmlcompressor.com/compress with at least the code parameter containing the code you want to compress / minify. In the following integration examples we make use of curl in a linux terminal for its simplicity, brevity and power.

Compressing a code snippet

curl -X POST -s --data-urlencode "code=<script> alert( 1 ); </script>" https://htmlcompressor.com/compress

To compress an html code snippet simply POST the code to the API url.

Compressing a file and overwriting only if successful

curl -X POST -s --fail --compressed --data-urlencode "code@index.html" --output "index.html" https://htmlcompressor.com/compress

By default the HTMLCompressor API asumes that the received code is html and performs a safe html minimization including any contained CSS and JavaScript code. The default output_mode is text. When the compression generates any errors the API returns an http status 400 Bad Request, therefore in the previous example the --fail parameter is used to prevent curl from outputting anything on http errors.

Recursively compressing all PHP, HTML, CSS and JS files inside a directory

while IFS= read -d $'\0' -r file; do curl -X POST -s --fail --compressed --data "code_type=${file##*.}" --data-urlencode "code@$file" --output "$file" https://htmlcompressor.com/compress && echo "$file: (OK)" || echo "$file: (ERROR)"; done < <(find /path/to/directory -type f -regextype egrep -regex '.*\.(php|html|css|js)' -print0)

This one-liner example recursively processes all the files with extensions .php., .html, .css and .js in the specified directory while providing the corresponding code_type parameter to the API and showing the progress and success of each file.

An alias for your shell

alias htmlc='htmlc(){ [ ! -z "$1" ] &&  while IFS= read -d $'\''\0'\'' -r file; do curl -X POST -s --fail --compressed --data "code_type=${file##*.}" --data-urlencode "code@$file" --output "$file" https://htmlcompressor.com/compress && echo "$file: (OK)" || echo "$file: (ERROR)"; done < <(find "$1" -type f -regextype egrep -regex ".*\.(php|html|css|js)" -print0); unset -f htmlc; }; htmlc'

To make better use of the previous example in a comfortable manner add this alias to your shell. To compress a php file in your local computer simply do $ htmlc index.php or to process a directory recursively do $ htmlc projects/web.

Integration with a code editor

#!/bin/bash
STDIN=$(cat <&0); echo -n "$STDIN" | curl -X POST -s --fail --compressed --data "code_type=${1:-html}" --data "js_engine=${2:-yui}" --data-urlencode "code@-" https://htmlcompressor.com/compress || echo -n "$STDIN"

This small script reads the code to compress from STDIN and allows 2 optional parameters: code_type and js_engine. If the compression is successful it returns the compressed code, otherwise the original code. For this example we are going to use Geany code editor. Save this script as htmlcompressor-stdin.sh then in Geany go to Edit / Format / Send Selection to / Set Custom Commands, click Add and insert the command as htmlcompressor-stdin.sh js closure and add some identifying label. Use htmlcompressor-stdin.sh css for CSS and htmlcompressor-stdin.sh for HTML. Now you can select any text in your editor and have it compressed with HTMLCompressor API without leaving your code editor. Awesome!

Integration with the linux desktop

#!/bin/bash

# Open a new terminal if processing a folder and running on a dumb terminal
if [[ "$TERM" == "dumb" ]] && [[ -d "$1" ]]; then
    xterm -geometry 120x40-100+100 -fa 'Monospace' -fs 10 -e "$0" "$1" "--wait"
    exit
fi

# Compress PHP, HTML, CSS and JS files in current dir or given as argument (file or dir arg)
while IFS= read -d $'\0' -r file; do
    curl -X POST -s --fail --compressed --data "code_type=${file##*.}" --data-urlencode "code@$file" --output "$file" https://htmlcompressor.com/compress && echo "$file: (OK)" || echo "$file: (ERROR)"
done < <(find "${1:-.}" -regextype egrep -regex '.*\.(php|html|css|js)' -print0)

# Wait for keypress to close xterm
[[ "$2" == "--wait" ]] && read -p "Press enter key to close..."

This basic script shows how easy it is to use the API to integrate in a linux desktop workflow. Save it as htmlcompressor.sh and use it as a custom command to execute for directories and the file types you want to process. The script will process single files silently and will open a terminal with progress and status for directories. Extend and modify as you see fit.

Integration with the Windows desktop

@echo off
setlocal EnableExtensions EnableDelayedExpansion

set CURL="c:\curl\curl.exe"
set SELF=%~n0
set ARG=%~1

if "%ARG%" == "" goto help
if not exist "%ARG%" goto not_found

pushd "%ARG%" >nul 2>&1 && (
    for /R %%f in (*.php, *.html, *.css, *.js) do call :PROCESS_FILE "%%f"
    popd
    echo Press any key to continue...
    pause >nul
) || (
    call :PROCESS_FILE "%ARG%"
    timeout /t 3
)

goto end

:PROCESS_FILE
    set FILE_NAME=%~1
    for /f "delims=" %%a in ("%FILE_NAME%") do set BASE_NAME=%%~na
    for /f "delims=" %%a in ("%FILE_NAME%") do set EXT=%%~xa
    for /f "delims=" %%a in ("%BASE_NAME%") do set EXTSUB=%%~xa

    if "%EXT%" == ".html" (
        call :API_POST html "%FILE_NAME%"
    ) else if "%EXT%" == ".php" (
        call :API_POST php "%FILE_NAME%"
    ) else if "%EXT%" == ".css" (
        if NOT "%EXTSUB%" == ".min" call :API_POST css "%FILE_NAME%"
    ) else if "%EXT%" == ".js" (
        if NOT "%EXTSUB%" == ".min" call :API_POST js "%FILE_NAME%"
    )
exit /B 0

:API_POST
    set CODE_TYPE=%1
    set FILE=%~2
    %CURL% -X POST -s --fail --compressed --data "code_type=%CODE_TYPE%" --data-urlencode "code@%FILE%" --output "%FILE%" https://htmlcompressor.com/compress && echo %FILE%: (OK) || echo %FILE%: (ERROR)
exit /B 0

:help
echo Please use %SELF% file.^(css^|html^|js^|php^) or %SELF% dir.
goto end

:not_found
echo The given parameter is not an existing file or directory!

:end

This batch script makes it very easy to use the API on a Windows desktop. Download curl for windows and extract the contents of the bin folder to C:\curl or edit the CURL path in the script. Save it as htmlc.bat and then copy it to %APPDATA%\Microsoft\Windows\SendTo so it shows up in your Send to folder. You can also create a shortcut on your desktop to drag files to compress or use it as a commandline tool. Extend and modify as you see fit.

HTMLCompressor API reference

Overview

To request compressed code from the HTMLCompressor public API, you must send an HTTP POST request to the URL https://htmlcompressor.com/compress with at least the code parameter containing the code you want to compress.

Boolean parameters are enabled with 1 and disabled with 0. If the parameter is not specified, the default value is used.

The default parameters are the equivalent to:

• code_type=html
• output_format=text
• html_level=1
• minimize_style=1
• minimize_events=1
• minimize_js_href=1
• minimize_css=1
• minimize_js=1
• js_engine=yui

Required Parameters

code

Source code to compress.

General Parameters

{
    "success": true,
    "result": "<script>alert(1);<\/script>"
}

{
    "success": false,
    "result": "<script>alert( 1 ;<\/script>",
    "error": {
        "script": ["[ERROR] in temp.js\n  1:10:missing ) after argument list\n[ERROR] in temp.js\n  1:0:Compilation produced 1 syntax errors.\n"]
    }
}

HTML Parameters

CSS Minimization Parameters

JavaScript Minimization Parameters

Yahoo YUI Compressor Parameters

Google Closure Compiler Parameters

Yahoo YUI Compressor for S.S.C. Parameters

JavaScript Minimization (S.S.C.) Parameters

PHP Minimization Parameters

Smarty Minimization Parameters

For a more detailed explanation of each option please visit the HTMLCompressor UI page and check the inline help for each available option.