API CatalogWiFi QR Code API

WiFi QR Code API

Generate WiFi QR codes that connect a phone to a network on scan — no typing the password. Use it for guest networks, offices, cafes, venues, vacation rentals, events, and onboarding flows. Output is a ready-to-use PNG or SVG image.

This endpoint is part of the QR Code Generator API.

Open QR Code Generator API on RapidAPI

Base URL and authentication

https://qr-code-generator-api-with-logo.p.rapidapi.com
HeaderValue
Content-Typeapplication/json
X-RapidAPI-KeyYour RapidAPI key
X-RapidAPI-Hostqr-code-generator-api-with-logo.p.rapidapi.com

See Authentication, Rate limits, and Errors for shared behavior.

Endpoint

POST /v1/qr/wifi

Request body

FieldTypeRequiredDefaultDescription
ssidstringYesWiFi network name. 1–128 characters.
passwordstringNonullWiFi password. Up to 256 characters. Omit for open networks.
encryptionWPA, WEP, nopassNoWPANetwork security type. Use nopass for open networks.
hiddenbooleanNofalseWhether the SSID is hidden (non-broadcasting).
outputpng or svgNopngOutput image format.
fill_colorstringNo#000000Foreground (module) color.
back_colorstringNo#ffffffBackground color.
box_sizeintegerNo10Pixel size of each module, 240.
borderintegerNo4Quiet-zone width in modules, 012.
error_correctionL, M, Q, HNoMError correction level.

Example request

curl --request POST \
  --url https://qr-code-generator-api-with-logo.p.rapidapi.com/v1/qr/wifi \
  --header "Content-Type: application/json" \
  --header "X-RapidAPI-Key: $RAPIDAPI_KEY" \
  --header "X-RapidAPI-Host: qr-code-generator-api-with-logo.p.rapidapi.com" \
  --data '{"ssid":"Guest WiFi","password":"secret123","encryption":"WPA","hidden":false,"output":"png"}'

Example response

{
  "success": true,
  "data": {
    "payload": "WIFI:T:WPA;S:Guest WiFi;P:secret123;H:false;;",
    "format": "png",
    "mime_type": "image/png",
    "data_base64": "iVBORw0KGgo...",
    "data_url": "data:image/png;base64,iVBORw0KGgo...",
    "size_px": 330
  },
  "error": null,
  "meta": { "request_id": "req_8f3b1d6a0c25" }
}

Response fields

FieldTypeDescription
payloadstringThe encoded WiFi string.
formatpng or svgOutput format.
mime_typestringimage/png or image/svg+xml.
data_base64stringImage bytes as base64.
data_urlstringReady-to-embed data: URL.
size_pxinteger or nullRendered width in pixels for PNG; null for SVG.

Tips

  • Open networks: set encryption to nopass and omit password.
  • Hidden networks: set hidden to true so the device knows to search for a non-broadcasting SSID.
  • Special characters: the API escapes ;, ,, :, and \ in the SSID and password for you — send them as-is.
  • Print large: for posters, raise box_size or use output: "svg" so the code stays crisp at any size.

Errors

Validation failures return INVALID_REQUEST (HTTP 400); auth and quota issues return UNAUTHORIZED (401) or RATE_LIMIT_EXCEEDED (429). See Errors for the full list.