Getting started
Make your first code in a few minutes. All you need is a free account and an API key.
1. Get a key
Sign in and open Developers. Create a key, and copy it somewhere safe: it’s shown once. Use a read-only key for anything that only needs to look.
2. Create a code
Send the key as a bearer token. The reply has a short_url, which is what goes in the printed code.
curl https://pikaqr.com/api/v1/qr \
-H "Authorization: Bearer $PIKAQR_KEY" \
-H "Content-Type: application/json" \
-d '{
"title": "Dinner menu",
"qr_type": "menu",
"destination_url": "https://example.com/menu",
"tags": ["dining-room"],
"metadata": { "site": "main" }
}'3. Print it
Fetch the code as an image from GET /qr/:id/image, as a PNG or an SVG.
4. Change it whenever you like
Send a new destination_url with PATCH /qr/:id. Printed codes follow straight away, and the old address stays in the code’s history.
curl -X PATCH https://pikaqr.com/api/v1/qr/$CODE_ID \
-H "Authorization: Bearer $PIKAQR_KEY" \
-H "Content-Type: application/json" \
-d '{ "destination_url": "https://example.com/winter-menu" }'Errors
Errors have a sentence for people and a code for programs. The code won’t change, so it’s safe to match on.
{
"error": "Rate limit of 1000 requests per hour reached",
"code": "rate_limited"
}Rate limits
Every reply says where you stand, and a 429 says when to try again.
X-RateLimit-LimitRequests allowed per hour: 1,000 on Free and 10,000 on Premium
X-RateLimit-RemainingRequests left in this hour
X-RateLimit-ResetWhen the count resets, in Unix seconds
Retry-AfterSeconds to wait, sent with a 429
Next
Read about menus and tables, rules and webhooks, or see the API reference.