Skip to main content
GET
/
api
/
consumer-prices
/
v1
/
get-consumer-price-freshness
GetConsumerPriceFreshness
curl --request GET \
  --url https://api.example.com/api/consumer-prices/v1/get-consumer-price-freshness
{
  "marketCode": "<string>",
  "asOf": "<string>",
  "retailers": [
    {
      "slug": "<string>",
      "name": "<string>",
      "lastRunAt": "<string>",
      "status": "<string>",
      "parseSuccessRate": 123,
      "freshnessMin": 123
    }
  ],
  "overallFreshnessMin": 123,
  "stalledCount": 123,
  "upstreamUnavailable": true
}

Documentation Index

Fetch the complete documentation index at: https://worldmonitor.app/docs/llms.txt

Use this file to discover all available pages before exploring further.

Query Parameters

market_code
string

market_code is the ISO 3166-1 alpha-2 market identifier.

Response

Successful response

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
object[]
overallFreshnessMin
integer<int32>

overall_freshness_min is the average freshness lag across all retailers.

stalledCount
integer<int32>

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.