Skip to main content

Endpoints

GET /api/emails/scraped_forwarded_emails

Retrieves parsed e-receipt data from forwarded emails matching the specified time filters.

Query Parameters

ParameterTypeRequiredDescription
web_api_keystringYesYour API token
ereceipt[from_date]stringYesStart date filter — format YYYY-MM-DD
ereceipt[to_date]stringYesEnd date filter — format YYYY-MM-DD
ereceipt[from_time]stringYesStart time filter — format HH:MM:SS AM/PM
ereceipt[to_time]stringYesEnd time filter — format HH:MM:SS AM/PM
ereceipt[from]stringNoStart date only (no time) — use with ereceipt[to] for date-only filtering
ereceipt[to]stringNoEnd date only (no time) — use with ereceipt[from] for date-only filtering
ereceipt[page]integerNoPage number. Each page returns 20 items and includes a max_page value. Omit to return the full collection.
ereceipt[show_html]booleanNoWhen true, includes the raw HTML of the forwarded email in the response

Example Request

curl "https://licensing.blinkreceipt.com/api/emails/scraped_forwarded_emails?\
web_api_key=YOUR_API_KEY&\
ereceipt[from_date]=2024-01-01&\
ereceipt[to_date]=2024-01-31&\
ereceipt[from_time]=12:00:00 AM&\
ereceipt[to_time]=11:59:59 PM"

GET /api/emails/scraped_forwarded_stats

Retrieves metadata and statistics for forwarded emails matching the specified filters.

Query Parameters

ParameterTypeRequiredDescription
web_api_keystringYesYour API token
ereceipt[from_date]stringYesStart date filter — format YYYY-MM-DD
ereceipt[to_date]stringYesEnd date filter — format YYYY-MM-DD
ereceipt[from]stringNoStart date only (no time)
ereceipt[to]stringNoEnd date only (no time)
ereceipt[from_time]stringNoStart time filter — format HH:MM:SS AM/PM
ereceipt[to_time]stringNoEnd time filter — format HH:MM:SS AM/PM
ereceipt[page]integerNoPage number. Each page returns 20 items and includes a max_page value. Omit to return the full collection.

Example Request

curl "https://licensing.blinkreceipt.com/api/emails/scraped_forwarded_stats?\
web_api_key=YOUR_API_KEY&\
ereceipt[from_date]=2024-01-01&\
ereceipt[to_date]=2024-01-31"