Piloterr Kroger API
The Kroger API from Piloterr — 2 operation(s) for kroger.
The Kroger API from Piloterr — 2 operation(s) for kroger.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/piloterr-com:piloterr-com-kroger-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Piloterr API Reference Kroger API
description: Complete API reference documentation.
version: 1.0.0
servers:
- url: https://api.piloterr.com
description: API Server
tags:
- name: Kroger
paths:
/v2/kroger/search:
get:
summary: Kroger Search
description: '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'
operationId: get-kroger-search
security:
- ApiKeyAuth: []
parameters:
- name: query
in: query
required: true
description: 'Keyword or a full Kroger search URL.
**Examples:**
```
milk
```
```
https://www.kroger.com/search?query=milk&searchType=default_search
```'
schema:
type: string
description: 'Keyword or a full Kroger search URL.
**Examples:**
```
milk
```
```
https://www.kroger.com/search?query=milk&searchType=default_search
```'
- name: page
in: query
required: false
description: Page number, 1-based.
schema:
type: number
description: Page number, 1-based.
- name: location_id
in: query
required: false
description: 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.
schema:
type: string
description: 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.
- name: return_page_source
in: query
required: false
description: When true, return rendered HTML instead of JSON.
schema:
type: boolean
description: When true, return rendered HTML instead of JSON.
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/is_async'
- $ref: '#/components/parameters/soft_fail'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
results:
type: array
items:
type: object
properties:
id:
type: string
url:
type: string
size:
type: string
brand:
type: string
image:
type: string
price:
type: number
title:
type: string
rating:
type: number
currency:
type: string
sponsored:
type: boolean
was_price:
nullable: true
store_name:
type: string
location_id:
type: string
review_count:
type: integer
price_display:
type: string
unit_price_display:
type: string
pagination:
type: object
properties:
next:
type: string
page:
type: integer
per_page:
type: integer
total_pages:
type: integer
total_results:
type: integer
examples:
Whole milk gallon:
value:
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
'400':
description: Bad Request — missing or invalid parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Bad Request
'401':
description: Unauthorized — the API key is missing, invalid, inactive, or expired, or a rate limit was exceeded (`Rate limit exceeded…` message).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
invalidKey:
value:
error: Invalid API Key
planRateLimit:
value:
error: 'Rate limit exceeded: You''ve exceeded the per second rate limit on your subscription'
keyQuota:
value:
error: 'Rate limit exceeded for the API key: quota monthly'
'402':
description: Payment Required — your subscription or credit balance is insufficient.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Payment required
'500':
description: Internal Server Error — something went wrong on our side.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Internal Error
tags:
- Kroger
post:
summary: Kroger Search
description: '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'
operationId: post-kroger-search
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/is_async'
- $ref: '#/components/parameters/soft_fail'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
query:
type: string
description: 'Keyword or a full Kroger search URL.
**Examples:**
```
milk
```
```
https://www.kroger.com/search?query=milk&searchType=default_search
```'
page:
type: number
description: Page number, 1-based.
location_id:
type: string
description: 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:
type: boolean
description: When true, return rendered HTML instead of JSON.
required:
- query
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
results:
type: array
items:
type: object
properties:
id:
type: string
url:
type: string
size:
type: string
brand:
type: string
image:
type: string
price:
type: number
title:
type: string
rating:
type: number
currency:
type: string
sponsored:
type: boolean
was_price:
nullable: true
store_name:
type: string
location_id:
type: string
review_count:
type: integer
price_display:
type: string
unit_price_display:
type: string
pagination:
type: object
properties:
next:
type: string
page:
type: integer
per_page:
type: integer
total_pages:
type: integer
total_results:
type: integer
examples:
Whole milk gallon:
value:
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
'400':
description: Bad Request — missing or invalid parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Bad Request
'401':
description: Unauthorized — the API key is missing, invalid, inactive, or expired, or a rate limit was exceeded (`Rate limit exceeded…` message).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
invalidKey:
value:
error: Invalid API Key
planRateLimit:
value:
error: 'Rate limit exceeded: You''ve exceeded the per second rate limit on your subscription'
keyQuota:
value:
error: 'Rate limit exceeded for the API key: quota monthly'
'402':
description: Payment Required — your subscription or credit balance is insufficient.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Payment required
'500':
description: Internal Server Error — something went wrong on our side.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Internal Error
tags:
- Kroger
/v2/kroger/product:
get:
summary: Kroger Product
description: 'Read one Kroger product by UPC. The sheet uses the same default store as search. You get the shelf price and the previous price when Kroger shows one.
**Credit cost:** 2 credits per call'
operationId: get-kroger-product
security:
- ApiKeyAuth: []
parameters:
- name: query
in: query
required: true
description: 'Kroger product URL or UPC.
**Examples:**
```
0001111040101
```
```
https://www.kroger.com/p/kroger-vitamin-d-whole-milk-gallon/0001111040101
```'
schema:
type: string
description: 'Kroger product URL or UPC.
**Examples:**
```
0001111040101
```
```
https://www.kroger.com/p/kroger-vitamin-d-whole-milk-gallon/0001111040101
```'
- name: location_id
in: query
required: false
description: 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.
schema:
type: string
description: 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.
- name: return_page_source
in: query
required: false
description: When true, return rendered HTML instead of JSON.
schema:
type: boolean
description: When true, return rendered HTML instead of JSON.
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/is_async'
- $ref: '#/components/parameters/soft_fail'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
id:
type: string
url:
type: string
size:
type: string
aisle:
type: string
brand:
type: string
image:
type: string
price:
type: number
title:
type: string
rating:
type: number
currency:
type: string
in_stock:
type: boolean
was_price:
nullable: true
store_name:
type: string
description:
type: string
location_id:
type: string
review_count:
type: integer
price_display:
type: string
store_address:
type: string
unit_price_display:
type: string
examples:
Whole milk gallon:
value:
id: '0001111040101'
url: https://www.kroger.com/p/kroger-vitamin-d-whole-milk-gallon/0001111040101
size: 1 gal
aisle: DAIRY 100
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
in_stock: true
was_price: null
store_name: Rolla
description: Kroger® Vitamin D Whole Milk Gallon is full of refreshing goodness. Enriched with Vitamin D to brighten your day and strengthen your bones. A healthier alternative for your breakfast without compromising on flavor. Kroger® – Trusted for the everyday moments that matter. 1 gal Jug of Kroger® Vitamin D Whole Milk Gallon Gives you Vitamin D for bone health Perfect for breakfast or baking A great addition to coffee Kroger® quality you can trust
location_id: '02100537'
review_count: 102
price_display: $3.19
store_address: 605 W 4Th St, Rolla, MO 65401
unit_price_display: $0.02/fl oz
'400':
description: Bad Request — missing or invalid parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Bad Request
'401':
description: Unauthorized — the API key is missing, invalid, inactive, or expired, or a rate limit was exceeded (`Rate limit exceeded…` message).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
invalidKey:
value:
error: Invalid API Key
planRateLimit:
value:
error: 'Rate limit exceeded: You''ve exceeded the per second rate limit on your subscription'
keyQuota:
value:
error: 'Rate limit exceeded for the API key: quota monthly'
'402':
description: Payment Required — your subscription or credit balance is insufficient.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Payment required
'500':
description: Internal Server Error — something went wrong on our side.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Internal Error
tags:
- Kroger
post:
summary: Kroger Product
description: 'Read one Kroger product by UPC. The sheet uses the same default store as search. You get the shelf price and the previous price when Kroger shows one.
**Credit cost:** 2 credits per call'
operationId: post-kroger-product
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/is_async'
- $ref: '#/components/parameters/soft_fail'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
query:
type: string
description: 'Kroger product URL or UPC.
**Examples:**
```
0001111040101
```
```
https://www.kroger.com/p/kroger-vitamin-d-whole-milk-gallon/0001111040101
```'
location_id:
type: string
description: 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:
type: boolean
description: When true, return rendered HTML instead of JSON.
required:
- query
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
id:
type: string
url:
type: string
size:
type: string
aisle:
type: string
brand:
type: string
image:
type: string
price:
type: number
title:
type: string
rating:
type: number
currency:
type: string
in_stock:
type: boolean
was_price:
nullable: true
store_name:
type: string
description:
type: string
location_id:
type: string
review_count:
type: integer
price_display:
type: string
store_address:
type: string
unit_price_display:
type: string
examples:
Whole milk gallon:
value:
id: '0001111040101'
url: https://www.kroger.com/p/kroger-vitamin-d-whole-milk-gallon/0001111040101
size: 1 gal
aisle: DAIRY 100
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
in_stock: true
was_price: null
store_name: Rolla
description: Kroger® Vitamin D Whole Milk Gallon is full of refreshing goodness. Enriched with Vitamin D to brighten your day and strengthen your bones. A healthier alternative for your breakfast without compromising on flavor. Kroger® – Trusted for the everyday moments that matter. 1 gal Jug of Kroger® Vitamin D Whole Milk Gallon Gives you Vitamin D for bone health Perfect for breakfast or baking A great addition to coffee Kroger® quality you can trust
location_id: '02100537'
review_count: 102
price_display: $3.19
store_address: 605 W 4Th St, Rolla, MO 65401
unit_price_display: $0.02/fl oz
'400':
description: Bad Request — missing or invalid parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Bad Request
'401':
description: Unauthorized — the API key is missing, invalid, inactive, or expired, or a rate limit was exceeded (`Rate limit exceeded…` message).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
invalidKey:
value:
error: Invalid API Key
planRateLimit:
value:
error: 'Rate limit exceeded: You''ve exceeded the per second rate limit on your subscription'
keyQuota:
value:
error: 'Rate limit exceeded for the API key: quota monthly'
'402':
description: Payment Required — your subscription or credit balance is insufficient.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Payment required
'500':
description: Internal Server Error — something went wrong on our side.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Internal Error
tags:
- Kroger
components:
parameters:
fields:
name: fields
in: query
required: false
description: Comma-separated list of response fields to return, with dot notation for nested fields (e.g. `name,location.city`).
schema:
type: string
is_async:
name: is_async
in: query
required: false
description: 'Run the request as a background job: the API answers `202` with a `job_id` to poll on `GET /v1/jobs/{id}`.'
schema:
type: boolean
default: false
soft_fail:
name: soft_fail
in: query
required: false
description: Return HTTP 200 even when the request fails; the error is in the `error` field of the body.
schema:
type: boolean
default: false
schemas:
ErrorResponse:
type: object
required:
- error
properties:
error:
type: string
description: Human-readable error message.
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: Your API key. Include it in the x-api-key header for every request.