The VCTR API
Everything you do in the app, from your own code: create Links and QR Codes, change Destinations, render codes and read stats. Plain JSON over HTTPS.
On every plan. 60 requests a minute per key on Free, 600 requests a minute on Pro and Business.
Start in a minute
Create a Workspace API key in the app, then create your first Link:
curl -X POST https://vctr.io/api/v1/links \
-H "Authorization: Bearer $VCTR_API_KEY" \
-H 'Content-Type: application/json' \
-d '{ "destination": "https://example.com/spring-menu" }'The answer holds the Link with its shortUrl. Errors always answer { "error": { "code", "message" } } with a stable code, so your integration can handle limits and permissions cleanly.
What you can do
- Create, list, update and delete Links, with custom Codes and the full Destination history.
- Create QR Codes and download them as SVG, PNG or PDF, with style options in the request.
- Read time series and breakdowns by country, device, OS, browser, language, referrer and channel, per Link, QR Code or Workspace.
- Keys are
editororviewer, and act on one Workspace only.
Typed clients from the OpenAPI document
The API is described by an OpenAPI 3.1 document at /api/v1/openapi.json, generated from the same route table that serves the API. Feed it to your favourite generator for a typed client. The API reference is built from it too.
Print it once. Keep it forever.
Make your first dynamic QR Code in a minute. Free, no credit card.