Overview

vprinter provides a public HTTP API for ingesting and querying ESC/POS print jobs without sending them to a physical printer.

Host

Production API requests use this host:

https://api.vprinter.dev

All endpoint paths in this documentation are relative to that host.

API Categories

Prints

The Prints API stores, updates, searches, and retrieves ESC/POS print outputs for a workspace.

Use it to:

  • create a print from raw ESC/POS bytes or JSON base64 data
  • attach searchable metadata such as label, deviceId, and tag
  • update print metadata
  • retrieve the stored raw print data
  • search prints within a workspace

Authentication

Most endpoints require an API token. Send it as a bearer token:

GET https://api.vprinter.dev/api/user/me
Authorization: Bearer at_xxxxxxxx.xxxxxxxx

See Auth for token format and scope behavior.

Need to generate ESC/POS bytes before uploading? react-thermal-printer can compose a receipt as React components and render it to the byte stream vprinter ingests.

On this page