Piloterr

Kroger Search

GET
/v2/kroger/search

Search Kroger groceries by keyword and page the results. Prices come from the default pickup store returned in the response. A location id you pass is not applied.

Credit cost: 2 credits per call

Authorization

ApiKeyAuth
x-api-key<token>

Your API key. Include it in the x-api-key header for every request.

In: header

Query Parameters

query*string

Keyword or a full Kroger search URL.

Examples:

milk
https://www.kroger.com/search?query=milk&searchType=default_search
page?number

Page number, 1-based.

location_id?string

Ignored. Prices stay on the default Rolla store, 02100537 (Kroger, 605 W 4th St, Rolla, MO 65401). The response location_id is the store that was actually priced.

return_page_source?boolean

When true, return rendered HTML instead of JSON.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v2/kroger/search?query=string"
{  "results": [    {      "id": "0001111040101",      "url": "https://www.kroger.com/p/kroger-vitamin-d-whole-milk-gallon/0001111040101",      "size": "1 gal",      "brand": "Kroger",      "image": "https://www.kroger.com/product/images/large/front/0001111040101",      "price": 3.19,      "title": "Kroger® Vitamin D Whole Milk Gallon",      "rating": 2.85,      "currency": "USD",      "sponsored": false,      "was_price": null,      "store_name": "Rolla",      "location_id": "02100537",      "review_count": 102,      "price_display": "$3.19",      "unit_price_display": "$0.02/fl oz"    }  ],  "pagination": {    "next": "https://www.kroger.com/search?query=milk&searchType=default_search&page=2",    "page": 1,    "per_page": 27,    "total_pages": 6,    "total_results": 161  }}
{  "error": "Bad Request"}
{  "error": "Invalid API Key"}
{  "error": "Payment required"}
{  "error": "Rate limit exceeded for the API key: quota monthly"}
{  "error": "Internal Error"}