# Orca Scan Barcode Parser API

Free API to parse, validate and extract data from raw barcode values.
No authentication required.

Base URL: https://parser.orcascan.com

## What it does

Send a GET request with a barcode value. Receive structured JSON with parsed fields, validation results and the matching barcode data standard.

## Supported barcode data standards

asin, bcbp, cccd, container, csv, ean, fmd, geo, gpon, gs1, hibc, ical, ip, isbn, isbt, iso15434, item-link, json, mac, peb, pin, psv, tel, tsv, udi, upc, url, vcard, vin, wifi

Pass the standard name as ?type=

## Query parameters

| Parameter | Default | Description                                                            |
|-----------|---------|------------------------------------------------------------------------|
| barcode   | (none)  | Raw barcode value to parse (must be URL encoded)                       |
| type      | (none)  | Force parsing as a specific barcode data standard                      |
| data      | true    | Include parsed barcode data in matches                                 |
| schema    | false   | Include JSON schema for parsed data in matches                         |
| regex     | (none)  | Parse only the value matched by a regex capture group                  |
| first     | false   | Return only the first matching result                                  |
| case      | (none)  | Format keys as: human, upper, lower, title, camel, pascal              |
| flat      | false   | Flatten the response: true, false, full                                |
| include   | (none)  | Comma separated list of fields to include                              |
| exclude   | (none)  | Comma separated list of fields to exclude                              |
| rename    | (none)  | Comma separated list of fields to rename fromName:toName               |

Formatting parameters are applied in order.

## Examples

Auto-detect barcode type:
https://parser.orcascan.com/?barcode=0190076338838502320100062111210518217103001192

Parse as GS1 with schema:
https://parser.orcascan.com/?barcode=0190076338838502320100062111210518217103001192&type=gs1&schema=true

Parse ISBN:
https://parser.orcascan.com/?barcode=9780761169253&type=isbn

Parse VIN:
https://parser.orcascan.com/?barcode=1GBEG25K9E7169086&type=vin

First match with human-readable keys:
https://parser.orcascan.com/?barcode=0190076338838502320100062111210518217103001192&first=true&case=human

## OpenAPI spec

https://parser.orcascan.com/openapi.json

## Full guide

https://orcascan.com/guides/barcode-parser-api-320fb366