/
/OpenQR API
DocsSign in
Sign in
  • APIs
  • Generators
  • Stacks
  • Projects
  • Docs
  • History
  • Schema
Checked 5h ago · Updated 1w ago
  • getAPI discovery index
  • getGet the account that owns your API key
  • getGet your branded subdomain
  • putClaim or change your branded subdomain (Pro)
  • deleteRelease your branded subdomain
  • getGenerate a QR code (query params)
  • postGenerate a QR code (JSON body)
  • getList your dynamic (editable) QR codes
  • postCreate a dynamic (editable) QR code
  • postCreate up to 200 dynamic codes at once
  • getGet one code's full details
  • deleteDelete a dynamic code
  • patchEdit a dynamic code (any field the dashboard can edit)
  • getGet scan analytics for a dynamic code
  • getList your saved style themes
  • postSave a reusable style theme
  • deleteDelete a saved theme (styled codes keep their look)
  • getList your folders
  • postCreate a folder
  • deleteDelete a folder (its codes are un-filed, not deleted)
  • patchRename a folder

Generate a QR code (JSON body)

post/v1/qr

Request body

datastring required

Text or URL to encode.

format'svg' | 'png'
sizeinteger
margininteger
darkstring

Foreground hex, e.g. 232E3A.

lightstring

Background hex, e.g. FFFFFF.

themestring

A saved theme id or name (applies its colours/margin).

Response

The rendered QR code.

Changes