---
title: "GetConsumerPriceFreshness"
method: GET
path: "/api/consumer-prices/v1/get-consumer-price-freshness"
tags: ["ConsumerPricesService"]
---

# GetConsumerPriceFreshness

`GET /api/consumer-prices/v1/get-consumer-price-freshness`

## Request

- Base URL: `https://api.worldmonitor.app`
- URL: `https://api.worldmonitor.app/api/consumer-prices/v1/get-consumer-price-freshness`
- Auth: one of:
  - API key in header `X-WorldMonitor-Key`
  - API key in header `X-Api-Key`

GetConsumerPriceFreshness retrieves feed freshness and coverage health per retailer.

## Query parameters

- `market_code` string
- `jmespath` string

## Response `200`

OK

- WorldmonitorConsumerPricesV1GetConsumerPriceFreshnessResponse: GetConsumerPriceFreshnessResponse describes feed health for all retailers.
  - `marketCode` string: market_code echoes the requested market.
  - `asOf` string, int64: as_of is the Unix millisecond timestamp of the snapshot.
  - `retailers` WorldmonitorConsumerPricesV1RetailerFreshnessInfo[]
    - `slug` string: slug is the retailer identifier.
    - `name` string: name is the retailer display name.
    - `lastRunAt` string, int64: last_run_at is the Unix millisecond timestamp of the last successful scrape.
    - `status` string: status is one of "ok", "stale", "failed", "unknown".
    - `parseSuccessRate` number, double: parse_success_rate is the fraction of pages parsed successfully (0–1).
    - `freshnessMin` integer: freshness_min is minutes since last successful observation.
  - `overallFreshnessMin` integer: overall_freshness_min is the average freshness lag across all retailers.
  - `stalledCount` integer: stalled_count is the number of retailers with no recent successful scrape.
  - `upstreamUnavailable` boolean: upstream_unavailable is true when the companion service could not be reached.

## Other responses

- `400`: Validation error
- `401`: Missing or invalid API key.
- `403`: API access requires an active subscription (the API key's subscription is inactive or expired).
- `429`: Rate limit exceeded.
- `503`: Service unavailable. Billing-verification responses include code and X-Billing-Verification; other gateway infrastructure failures use the generic GatewayError shape.
- `default`: Gateway or handler error response.

---

[API](https://skmtc.dev/worldmonitor/apis/worldmonitor-api.md) · [All operations](https://skmtc.dev/worldmonitor/apis/worldmonitor-api/llms.txt) · [OpenAPI document](https://skmtc.dev/worldmonitor/apis/worldmonitor-api/revisions/e3dc8463a5c9?raw)