BannerCraft API Documentation

Learn how to generate server-side rendered Minecraft banners dynamically via URL parameters or JSON payloads.

1. GET Request (URL Params)

The simplest way to use the API inside an <img /> tag. Pass your configuration through standard URL query parameters.

GET /api/bannerCreate?base=white&layers=[{"shape":"creeper","color":"black"}]

Parameters

base (string) - Valid Minecraft color name for the banner background. Default is white.
layers (string) - URL Encoded JSON string representing an array of layer objects.
width (number, optional) - Target width of the SVG in pixels.
height (number, optional) - Target height of the SVG. (Do not provide if width is set).
filetype (string, optional) - Target export format. Supports svg (default), png, jpg, and webp.

2. POST Request (JSON Payload)

Best for programmatic integrations where payload size matters (bypasses URL length limits) or when sending dynamic data directly from a server.

POST /api/bannerCreate

{ "base": "red", "layers": [ { "shape": "stripe_bottom", "color": "blue" }, { "shape": "creeper", "color": "white" } ], "height": 400, "filetype": "png" }

API Playground

Test the POST endpoint directly from your browser. Modify the JSON payload below and run the request to see the SVG output.

Request Body (JSON)

Result

Hit send to fetch result