QR Code Reader API
Overview
To use QR Code Reader, you need an API key. You can get one by creating a free account and visiting your dashboard.
POST Endpoint
https://api.apiverve.com/v1/qrcodereaderExample
How to call the QR Code Reader API in different programming languages.
curl -X POST \
"https://api.apiverve.com/v1/qrcodereader" \
-H "X-API-Key: your_api_key_here" \
-F "image=@/path/to/image.jpg"const formData = new FormData();
formData.append('image', fileInput.files[0]);
const response = await fetch('https://api.apiverve.com/v1/qrcodereader', {
method: 'POST',
headers: {
'X-API-Key': 'your_api_key_here'
},
body: formData
});
const data = await response.json();
console.log(data);import requests
headers = {
'X-API-Key': 'your_api_key_here'
}
files = {
'image': open('/path/to/image.jpg', 'rb')
}
response = requests.post('https://api.apiverve.com/v1/qrcodereader', headers=headers, files=files)
data = response.json()
print(data)package main
import (
"bytes"
"fmt"
"io"
"mime/multipart"
"net/http"
"os"
)
func main() {
file, _ := os.Open("/path/to/image.jpg")
defer file.Close()
body := &bytes.Buffer{}
writer := multipart.NewWriter(body)
part, _ := writer.CreateFormFile("image", "image.jpg")
io.Copy(part, file)
writer.Close()
req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/qrcodereader", body)
req.Header.Set("X-API-Key", "your_api_key_here")
req.Header.Set("Content-Type", writer.FormDataContentType())
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
respBody, _ := io.ReadAll(resp.Body)
fmt.Println(string(respBody))
}{
"status": "ok",
"error": null,
"data": {
"text": "'Twas brillig",
"location": {
"topLeft": {
"x": 9.927694968294492,
"y": 9.927694968294492
},
"topRight": {
"x": 215.24999999999997,
"y": 9.749999999999996
},
"bottomLeft": {
"x": 9.749999999999996,
"y": 215.24999999999997
},
"bottomRight": {
"x": 216.14779062994094,
"y": 216.14779062994094
}
}
}
}Authentication
The QR Code Reader API requires authentication via API key. Include your API key in the request header:
X-API-Key: your_api_key_hereInteractive API Playground
Test the QR Code Reader API directly in your browser with live requests and responses.
File Upload Required
multipart/form-data. Do not use Content-Type: application/json for QR Code Reader.| Property | Value |
|---|---|
| Field Name | image |
| Accepted Types | .jpg, .jpeg, .png, .gif |
| Max File Size | 10MB |
curl -X POST "https://api.apiverve.com/v1/qrcodereader" \
-H "X-API-Key: your_api_key_here" \
-F "image=@/path/to/your/file"const formData = new FormData();
formData.append('image', fileInput.files[0]);
const response = await fetch('https://api.apiverve.com/v1/qrcodereader', {
method: 'POST',
headers: {
'X-API-Key': 'your_api_key_here'
},
body: formData
});
const data = await response.json();
console.log(data);Parameters
The following parameters are available for the QR Code Reader API:
Read QR Code
| Parameter | Type | Required | Description | Default | Example |
|---|---|---|---|---|---|
image | string | optional | Upload an image file containing a QR code to decode (supported formats: JPG, PNG, GIF) | - |
Response
The QR Code Reader API returns responses in JSON, XML, YAML, and CSV formats. The JSON response is shown in the Example section above; alternative formats below.
Other Response Formats
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>ok</status>
<error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<data>
<text>'Twas brillig</text>
<location>
<topLeft>
<x>9.927694968294492</x>
<y>9.927694968294492</y>
</topLeft>
<topRight>
<x>215.24999999999997</x>
<y>9.749999999999996</y>
</topRight>
<bottomLeft>
<x>9.749999999999996</x>
<y>215.24999999999997</y>
</bottomLeft>
<bottomRight>
<x>216.14779062994094</x>
<y>216.14779062994094</y>
</bottomRight>
</location>
</data>
</response>
status: ok
error: null
data:
text: '''Twas brillig'
location:
topLeft:
x: 9.927694968294492
'y': 9.927694968294492
topRight:
x: 215.24999999999997
'y': 9.749999999999996
bottomLeft:
x: 9.749999999999996
'y': 215.24999999999997
bottomRight:
x: 216.14779062994094
'y': 216.14779062994094
| key | value |
|---|---|
| text | 'Twas brillig |
| location | {topLeft:{x:9.927694968294492,y:9.927694968294492},topRight:{x:215.24999999999997,y:9.749999999999996},bottomLeft:{x:9.749999999999996,y:215.24999999999997},bottomRight:{x:216.14779062994094,y:216.14779062994094}} |
Response Structure
All API responses follow a consistent structure with the following fields:
| Field | Type | Description | Example |
|---|---|---|---|
status | string | Indicates whether the request was successful ("ok") or failed ("error") | ok |
error | string | null | Contains error message if status is "error", otherwise null | null |
data | object | null | Contains the API response data if successful, otherwise null | {...} |
Learn more about response formats →
Response Data Fields
When the request is successful, the data object contains the following fields:
| Field | Type | Sample Value | Description |
|---|---|---|---|
text | string | - | |
location | object | - | |
â”” topLeft | object | - | |
â”” x | number | - | |
â”” y | number | - | |
â”” topRight | object | - | |
â”” x | number | - | |
â”” y | number | - | |
â”” bottomLeft | object | - | |
â”” x | number | - | |
â”” y | number | - | |
â”” bottomRight | object | - | |
â”” x | number | - | |
â”” y | number | - |
Headers
Only X-API-Key is required. Optional headers include Accept for response format negotiation (JSON, XML, or YAML), User-Agent, and X-Request-ID for request tracing. See all request headers →
CORS Support
The QR Code Reader API accepts cross-origin requests from any origin, so it can be called directly from browser-based applications without a proxy. See CORS support →
Rate Limiting
QR Code Reader requests are throttled per minute on the Free plan and unthrottled on paid plans. Exceeding the limit returns 429 Too Many Requests; rate-limit usage is reported in the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset response headers. See per-plan limits and best practices →
Error Codes
The QR Code Reader API uses standard HTTP status codes — 200 on success, 400 for invalid parameters, 401 for missing or invalid keys, 403 for insufficient credits, 429 for rate-limit exhaustion, and 500/503 for server-side issues. Each error response includes an X-Request-ID header you can quote when contacting support. See full error handling guide →
SDKs for QR Code Reader
Official QR Code Reader packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →
No-Code Integrations
QR Code Reader works with Zapier, Make, Pipedream, n8n, and Power Automate using the same API key. See setup guides →
Frequently Asked Questions
How do I get an API key for QR Code Reader?
How many credits does QR Code Reader cost?
Each successful QR Code Reader API call consumes credits based on plan tier. Check the pricing section above for the exact credit cost. Failed requests and errors don't consume credits, so you only pay for successful qr code reader lookups.
Can I use QR Code Reader in production?
The free plan is for testing and development only. For production use of QR Code Reader, upgrade to a paid plan (Starter, Pro, or Mega) which includes commercial use rights, no attribution requirements, and guaranteed uptime SLAs. All paid plans are production-ready.
Can I use QR Code Reader from a browser?
What happens if I exceed my QR Code Reader credit limit?
When you reach your monthly credit limit, QR Code Reader API requests will return an error until you upgrade your plan or wait for the next billing cycle. You'll receive notifications at 80% and 95% usage to give you time to upgrade if needed.








