Skip to main content

Email Forwarding API

The Email Forwarding API returns parsed e-receipt data from emails forwarded to BlinkReceipt for scraping. It enables automated e-receipt collection without requiring users to authenticate with their email provider directly.

How It Works

  1. BlinkReceipt provides you with a web_api_key for forwarded email access.
  2. You set up a process that forwards user e-receipt emails to receipts@blinkreceipt.com.
  3. BlinkReceipt scrapes and parses each forwarded email, typically within 5 minutes.
  4. You retrieve the parsed results via the API.

Forwarding Requirements

For best results, forwarded emails must preserve:

  • The full HTML body of the original e-receipt
  • The forwarding header, including the original sender, date, and subject. Example:
---------- Forwarded message ---------
From: Walmart Grocery <grocery-wmt@walmart.com>
Date: Sat, Nov 23, 2019 at 5:29 PM
Subject: Thanks for your order. Here's the receipt.

Base URL

https://licensing.blinkreceipt.com

Authentication

All requests require a web_api_key query parameter provided by your BlinkReceipt account team.

?web_api_key=YOUR_API_KEY

Endpoints

MethodPathDescription
GET/api/emails/scraped_forwarded_emailsRetrieve parsed e-receipt data from forwarded emails
GET/api/emails/scraped_forwarded_statsRetrieve metadata and statistics for forwarded emails