Documentation

# Core functionality
pip install grubscan

# With barcode decoding support
pip install grubscan[barcode]

from grubscan import GrubscanClient

client = GrubscanClient(
    api_key="gs_your_api_key_here",
)

# Search for foods
results = client.search_foods("chicken breast", limit=10)
for food in results.data:
    print(f"{food.description}: {food.calories} cal")

# Lookup barcode
product = client.lookup_barcode("074807750100")
print(product.brand_owner, product.source)

# From file path
result = client.scan_food("/path/to/food.jpg")

# From bytes
with open("/path/to/food.jpg", "rb") as f:
    result = client.scan_food(f.read())

print(result.detected_food)           # "Grilled Chicken Salad"
print(result.confidence_score)      # 0.92
print(result.estimated_nutrition.calories)

from grubscan import BarcodeDecoder

decoder = BarcodeDecoder()

# Decode from image file
result = decoder.decode_from_file("/path/to/barcode.png")
if result:
    print(f"Barcode: {result.data}, Type: {result.type}")

# Decode and auto-lookup
product = decoder.decode_and_lookup("barcode.png", client)
print(product.description)

with GrubscanClient(api_key="gs_...") as client:
    results = client.search_foods("avocado")
    # Session automatically closed on exit

# Core SDK
npm install @grubscan/sdk

# With barcode scanning (browser)
npm install @grubscan/sdk @zxing/browser @zxing/library

import { GrubscanClient } from '@grubscan/sdk';

const client = new GrubscanClient({
  apiKey: 'gs_your_api_key_here',
});

// Search for foods
const results = await client.searchFoods('greek yogurt', { limit: 10 });
console.log(results.data);

// Lookup barcode
const product = await client.lookupBarcode('074807750100');
console.log(product.data.brand_owner);

// From file input
const fileInput = document.getElementById('photo');
const file = fileInput.files[0];

const result = await client.scanFood(file, {
  onProgress: (progress) => {
    console.log(`Upload: ${progress}%`);
  },
});

console.log(result.detected_food);
console.log(result.confidence_score);
console.log(result.estimated_nutrition);

import { GrubscanBarcodeScanner } from '@grubscan/sdk/barcode';

const scanner = new GrubscanBarcodeScanner({
  videoElement: 'video-preview',
  onDetected: async (barcode) => {
    console.log('Scanned:', barcode);
    const product = await client.lookupBarcode(barcode);
    console.log(product.data);
  },
  onError: (error) => console.error(error),
  preferredCamera: 'environment',
  formats: ['EAN_13', 'UPC_A'],
});

await scanner.start();

import { GrubscanClient } from '@grubscan/sdk';
import fs from 'fs';

const client = new GrubscanClient({ apiKey: 'gs_...' });

// Scan from file buffer
const imageBuffer = fs.readFileSync('./food.jpg');
const blob = new Blob([imageBuffer], { type: 'image/jpeg' });
const result = await client.scanFood(blob);

npm install @grubscan/react-native react-native-vision-camera

# iOS setup
cd ios && pod install

# Add to Info.plist
<key>NSCameraUsageDescription</key>
<string>We need camera access to scan barcodes</string>

import { GrubscanClient, GrubscanBarcodeScanner } from '@grubscan/react-native';

const client = new GrubscanClient({
  apiKey: 'gs_your_api_key_here',
});

function ScannerScreen() {
  return (
    <GrubscanBarcodeScanner
      client={client}
      onBarcodeDetected={(result) => {
        console.log('Barcode:', result.barcode.value);
        if (result.product) {
          console.log('Product:', result.product.description);
        }
      }}
      autoLookup={true}
      showOverlay={true}
    />
  );
}

import { launchImageLibrary } from 'react-native-image-picker';

const result = await launchImageLibrary({ mediaType: 'photo' });

if (result.assets?.[0]) {
  const scan = await client.scanFood(
    {
      uri: result.assets[0].uri,
      name: result.assets[0].fileName,
      type: result.assets[0].type,
    },
    {
      onProgress: (progress) => console.log(`${progress}% uploaded`),
    }
  );
  console.log(scan.detected_food, scan.confidence_score);
}

import { useBarcodeScanner } from '@grubscan/react-native';
import { Camera } from 'react-native-vision-camera';

function CustomScanner() {
  const { state, device, codeScanner, requestPermission } = useBarcodeScanner({
    onBarcodeDetected: (barcode) => console.log('Scanned:', barcode.value),
    formats: ['ean-13', 'upc-a'],
    continuous: false,
  });

  if (!state.hasPermission) {
    return <Button title="Grant Permission" onPress={requestPermission} />;
  }

  return <Camera device={device} isActive={state.isScanning} codeScanner={codeScanner} style={{ flex: 1 }} />;
}