Prices people actually paid, from official open data: homes, rents, fuel, energy, food, medicines.
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Use this when a user asks what people actually pay for a flight between two cities or airports (for example JFK to LAX, or Chicago to Miami), or what the average airfare out of a city is, in Australia (domestic routes) (country AU) or the United States (domestic flights within the contiguous 48 states) (country US). Returns the official average fare per passenger each way, in the currency the answer states, for the latest quarter published, with (where the source publishes them) the passengers per day behind it, the share of the largest carrier, the change on a year earlier and the last few quarters, plus the official source and licence. This is a published quarterly average of fares paid (price_type official_statistic), not a range built from tickets, so the range fields are null and there is no sample size; how fresh: Australia (domestic routes): monthly; the newest month is usually the one just ended; the United States (domestic flights within the contiguous 48 states): quarterly, published about five to six months after the quarter ends (the first quarter of 2026 was published in September 2026); every answer states its quarter. Do not use for today's fare, a specific date, airline or cabin, a booking or price alert, international flights, routes outside the places named above, hotels, or other countries.
Where the flight starts: an airport code (JFK, LAX) or a city (Chicago, 'Portland, OR'). Required. AU: city or airport code (Sydney, SYD, 'Gold Coast', OOL). Required, and AU also needs 'to'. US: airport code (JFK, ORD) or city ('Chicago', 'Portland, OR', 'New York'). Airports in one metro area share one city market for city-level questions.
AU = Australia (domestic routes between about 70 city pairs; cheapest advertised return fare, not a fare paid); US = United States, contiguous 48 states (domestic flights only; Alaska, Hawaii and territories are not covered)
Where it ends: an airport code or a city. Leave out to get the average fare over the busiest routes out of the 'from' city. AU: city or airport code. Required for AU (the answer is for one route, either direction). US: airport code or city. Two airports give the airport-pair average where DOT publishes it; otherwise (and for cities) the city-pair average.
How many recent quarters to include in the trend (default 4, at most 20). The headline figure is always the latest quarter. AU: the range covers this many quarters of monthly fares (default 4 = 12 months; at least 2 are needed for a range). AU publishes one cheapest advertised return fare per route per month: advertised, not paid, so the price type is posted_price. US: the trend lists this many quarters, newest first. DOT publishes about five to six months after a quarter ends.
Use this when a user asks what people actually pay for a flight between two cities or airports (for example JFK to LAX, or Chicago to Miami), or what the average airfare out of a city is, in Australia (domestic routes) (country AU) or the United States (domestic flights within the contiguous 48 states) (country US). Returns the official average fare per passenger each way, in the currency the answer states, for the latest quarter published, with (where the source publishes them) the passengers per day behind it, the share of the largest carrier, the change on a year earlier and the last few quarters, plus the official source and licence. This is a published quarterly average of fares paid (price_type official_statistic), not a range built from tickets, so the range fields are null and there is no sample size; how fresh: Australia (domestic routes): monthly; the newest month is usually the one just ended; the United States (domestic flights within the contiguous 48 states): quarterly, published about five to six months after the quarter ends (the first quarter of 2026 was published in September 2026); every answer states its quarter. Do not use for today's fare, a specific date, airline or cabin, a booking or price alert, international flights, routes outside the places named above, hotels, or other countries.
| Argument | Type | Description |
|---|---|---|
| to | string | Where it ends: an airport code or a city. Leave out to get the average fare over the busiest routes out of the 'from' city. AU: city or airport code. Required for AU (the answer is for one route, either direction). US: airport code or city. Two airports give the airport-pair average where DOT publishes it; otherwise (and for cities) the city-pair average. |
| from* | string | Where the flight starts: an airport code (JFK, LAX) or a city (Chicago, 'Portland, OR'). Required. AU: city or airport code (Sydney, SYD, 'Gold Coast', OOL). Required, and AU also needs 'to'. US: airport code (JFK, ORD) or city ('Chicago', 'Portland, OR', 'New York'). Airports in one metro area share one city market for city-level questions. |
| country* | string | AU = Australia (domestic routes between about 70 city pairs; cheapest advertised return fare, not a fare paid); US = United States, contiguous 48 states (domestic flights only; Alaska, Hawaii and territories are not covered) |
| quarters | integer | How many recent quarters to include in the trend (default 4, at most 20). The headline figure is always the latest quarter. AU: the range covers this many quarters of monthly fares (default 4 = 12 months; at least 2 are needed for a range). AU publishes one cheapest advertised return fare per route per month: advertised, not paid, so the price type is posted_price. US: the trend lists this many quarters, newest first. DOT publishes about five to six months after a quarter ends. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country",
"from"
],
"properties": {
"to": {
"type": "string",
"minLength": 2,
"description": "Where it ends: an airport code or a city. Leave out to get the average fare over the busiest routes out of the 'from' city. AU: city or airport code. Required for AU (the answer is for one route, either direction). US: airport code or city. Two airports give the airport-pair average where DOT publishes it; otherwise (and for cities) the city-pair average."
},
"from": {
"type": "string",
"minLength": 2,
"description": "Where the flight starts: an airport code (JFK, LAX) or a city (Chicago, 'Portland, OR'). Required. AU: city or airport code (Sydney, SYD, 'Gold Coast', OOL). Required, and AU also needs 'to'. US: airport code (JFK, ORD) or city ('Chicago', 'Portland, OR', 'New York'). Airports in one metro area share one city market for city-level questions."
},
"country": {
"enum": [
"AU",
"US"
],
"type": "string",
"description": "AU = Australia (domestic routes between about 70 city pairs; cheapest advertised return fare, not a fare paid); US = United States, contiguous 48 states (domestic flights only; Alaska, Hawaii and territories are not covered)"
},
"quarters": {
"type": "integer",
"maximum": 20,
"minimum": 1,
"description": "How many recent quarters to include in the trend (default 4, at most 20). The headline figure is always the latest quarter. AU: the range covers this many quarters of monthly fares (default 4 = 12 months; at least 2 are needed for a range). AU publishes one cheapest advertised return fare per route per month: advertised, not paid, so the price type is posted_price. US: the trend lists this many quarters, newest first. DOT publishes about five to six months after a quarter ends."
}
}
}Use this when a user asks what used, surplus or seized goods (vehicles, heavy equipment, electronics, office furniture, tools and similar) went for at public auction in Canada (federal surplus), France (state auctions) or the United States (federal surplus). Returns the median final bid on sold lots, a typical range (10th–90th percentile), the number of lots, the period, and the source and licence. How fresh: Canada (federal surplus): half-yearly files; the newest sale in the latest file can be several months old; France (state auctions): yearly file: calendar 2024 (published 20 Feb 2026); the 2025 file is expected around Feb 2027; the United States (federal surplus): monthly file, covers the last six months of auctions. These are winning bid levels on lots marked sold (before any buyer premium, not confirmed receipts) for used goods, not retail prices. Nothing is returned for fewer than 5 lots, and no seller or lot is named. Do not use for new goods, shop prices or other countries.
| Argument | Type | Description |
|---|---|---|
| what* | string | Lot type: a group name or words from the lot title, such as 'vehicles', 'heavy equipment', 'office furniture' or 'forklift'. CA: one of vehicles, heavy-equipment, electronics, office-furniture, boats, tools-machinery, or a word such as 'truck', 'laptop', 'forklift', 'desk'. FR: 'cars', 'vans', 'motorbikes', 'bicycles', 'computers', 'furniture', 'jewellery', 'wine', or words from the brand, model or description ('renault clio'). |
| state | string | Optional region to narrow to, see the country notes below. CA: province or territory, name or two-letter code ('ON', 'Quebec'). Omit for all of Canada. FR: the auction house city (CAV) such as 'Lyon', 'Marseille' or 'Toulouse'. The data is the 2024 file of French state auctions (seized, impounded and court sales). US: two-letter state or territory code ('TX'). The auctions are US federal surplus and seized goods. |
Use this when a user asks what traded goods are worth at the border, per kilogram, as declared to customs: for example what a country pays per kg to import wheat, diesel, cheese or timber, or earns per kg exporting whisky or steel, in the United Kingdom (country GB), optionally from or to one partner country. Returns the customs value divided by the net weight (a value-weighted average per kg in the reporting country's currency), a range between the 10th and 90th percentile of the individual customs lines weighted by weight, the months it covers, the biggest partner countries and the official source and licence. This is a customs unit value (price_type official_statistic) built from declared trade values and weights, not a shelf price, not a wholesale quote and not a receipt, so there is no sample size. How fresh: monthly: HMRC publishes each month's trade statistics about six weeks after the month ends; our figures are read live and each answer states its months. Do not use for what a shopper pays in a shop, for a single contract or shipment, for futures or spot quotes, for services, or for countries that are not listed.
| Argument | Type | Description |
|---|---|---|
| months | integer | How many months to include, ending with the period. Default 1. More months smooth out lumpy shipments. GB: months to include, 1 to 12 (default 1). |
| period | string | Optional last month to include, as YYYY-MM. Default: the newest month the customs authority has published. GB: the last month to include (YYYY-MM). HMRC publishes about six weeks after the month ends; default is the newest published month. |
| country* | string | GB = United Kingdom (HMRC Overseas Trade Statistics: customs value per kilogram of goods imported or exported, by customs commodity code and partner country, monthly) |
Use this when a user asks what home internet (fixed broadband at a given speed, with or without phone and TV) or a mobile data plan costs per month in the EU, or how that compares between countries. Returns the official figure for a standard offer in the latest year published, the previous year and the change, and the same country's other offers, with the official source and licence. It is the cheapest posted offer of the largest operators, not what customers actually paid, and not a range built from sales: the range fields are null and there is no sample size. How fresh: annual figures with a lag of about two years (newest year 2024, dataset updated May 2026); each answer states its reference year. Do not use for a quote from one provider, for business lines, or for countries that are not listed.
| Argument | Type | Description |
|---|---|---|
| offer | string | Which standard offer. Friendly names such as fixed_100_200 (fixed internet 100-200 Mbps, the default), fixed_30_100, fixed_1gbps, mobile_10gb, mobile_unlimited, or a publisher code. The country notes list them. EU, Eurostat: the cheapest posted offer of the largest operators, PPP euro per month. Names: fixed_lt12 (FI_MBPS_LT12), fixed_30_100 (FI_MBPS30-100), fixed_100_200 (FI_MBPS100-200), fixed_200_999 (FI_MBPS200-999), fixed_1gbps (FI_GBPS_GE1), fixed_100_200_phone (FI_MBPS100-200_P), fixed_100_200_phone_tv (FI_MBPS100-200_PTV), mobile_1gb (MI_GB1_NC), mobile_2gb (MI_GB2_NC), mobile_5gb (MI_GB5_NC), mobile_10gb (MI_GB10_NC), mobile_20gb (MI_GB20_NC), mobile_50gb (MI_GB50_NC), mobile_unlimited (MI_NLTD_NC). Any Eurostat offer code also works, e.g. FI_MBPS30-100_PTV (fixed 30-100 Mbps with phone and TV). Default fixed_100_200. |
| country* | string | EU member states as ISO codes (GR for Greece): AT = Austria, BE = Belgium, BG = Bulgaria, HR = Croatia, CY = Cyprus, CZ = Czechia, DK = Denmark, EE = Estonia, FI = Finland, FR = France, DE = Germany, GR = Greece, HU = Hungary, IE = Ireland, IT = Italy, LV = Latvia, LT = Lithuania, LU = Luxembourg, MT = Malta, NL = Netherlands, PL = Poland, PT = Portugal, RO = Romania, SK = Slovakia, SI = Slovenia, ES = Spain, SE = Sweden |
Use this when a user asks what people actually paid for the right to own or buy a car (an entitlement or quota certificate, a sale or an auction result) in Singapore car ownership rights (COE) (country SG). Returns the median winning price, a typical range (10th–90th percentile), the number of bidding rounds or sales, the period covered, a confidence label, and the official source and licence. Do not use for asking prices, dealer listings, or other countries.
| Argument | Type | Description |
|---|---|---|
| months | integer | How many recent months to include. Default 12. |
| country* | string | SG = Singapore COE (Certificate of Entitlement) bidding results |
| product | string | Which price. 'coe' = Certificate of Entitlement bidding results (the country notes say where it exists). Default 'coe'. SG: 'coe'. |
| vehicle_class | string | SG only: COE category. A = cars up to 1600cc (default), B = cars above 1600cc, C = goods vehicles/buses, D = motorcycles, E = open. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country"
],
"properties": {
"months": {
"type": "integer",
"maximum": 60,
"minimum": 1,
"description": "How many recent months to include. Default 12."
},
"country": {
"enum": [
"SG"
],
"type": "string",
"description": "SG = Singapore COE (Certificate of Entitlement) bidding results"
},
"product": {
"enum": [
"coe"
],
"type": "string",
"description": "Which price. 'coe' = Certificate of Entitlement bidding results (the country notes say where it exists). Default 'coe'. SG: 'coe'."
},
"vehicle_class": {
"enum": [
"A",
"B",
"C",
"D",
"E"
],
"type": "string",
"description": "SG only: COE category. A = cars up to 1600cc (default), B = cars above 1600cc, C = goods vehicles/buses, D = motorcycles, E = open."
}
}
}Use this before paying: when a user or agent has a proposed price for something (a rent, a home, a litre of fuel, a medicine, a contract) and wants to know whether it is typical against recorded official evidence. Give the category (border-prices, broadband, cars, childcare, commercial-property, construction, contracts, diet-costs, energy, farm-gate-prices, farm-prices, flights, fuel, groceries, health-insurance, home-sales, home-upgrades, hotels, insurance, land-prices, medical, medicines, price-levels, producer-prices, rent, surplus-auctions, tuition, wholesale-fresh-food, wholesale-markets and wholesale-power), the country, the same parameters that category's own tool takes, and the price. It runs the category's normal answer and returns a verdict: within, above or below the typical range (10th–90th percentile of recorded prices) when the evidence is a set of records; about, above or below the average when the evidence is one official average or median (within 5% counts as about average, and it says plainly this is an average, not a distribution); or cannot_judge, with the reason, when the currency or unit differs (ProofPrice never converts), there are too few records or nothing matched. It also returns where the price sits (for example '27% above the median and above the 90th percentile'), the reasons and cautions (posted prices are not paid prices, old periods), what is missing, one quotable sentence, and the full evidence answer with source, licence and audit-trail fields to keep with the reasoning. Do not use it to value one specific item or address, as financial or legal advice, or to compare prices in different currencies or units. After 20 free calls a day per caller this tool costs USD 0.10 per answered call, paid with x402 (USDC); a 402 reply lists how. Nothing is charged for "not enough records" or errors.
| Argument | Type | Description |
|---|---|---|
| to | string | number | Parameter of the category (same name and meaning as in its own tool). flights: Where it ends: an airport code or a city. Leave out to get the average fare over the busiest routes out of the 'from' city. AU: city or airport code. Required for AU (the answer is for one route, eith |
Use this when a user asks what childcare costs parents: the price of a nursery, daycare, childminder or after-school place for a baby, toddler, preschool or school-age child in a county, region, state or city, or how childcare prices compare, in England (country GB), Ireland (country IE), Norway (country NO) or the United States (country US). These are official surveys and statistics of the fees providers charge parents (or what households report paying), not adverts or listings, and they are before public subsidies or funded hours unless the answer says otherwise. Each answer is an official average or median (price_type official_statistic): the range fields are null, and there is a sample size only where the publisher gives one. Every answer states its unit (for example US dollars per week, or pounds per hour), the year it describes, a confidence label, and the official source and licence. How fresh: England: calendar year 2025 (survey fieldwork May to July 2025, published 11 December 2025; next release December 2026); Ireland: 2016 only (CSO has not repeated the table); regional, not county; ten years old; Norway: annual (January figures); the 2026 figures were published on 30 April 2026; the United States: county prices for 2022 (the latest year the Department of Labor has published; the database lags by several years). Some of this data is several years old: always read the period in the answer. Do not use for the cost of a specific nursery, advertised fees or waiting-list prices, the value of government subsidies, tuition for schools or universities, babysitting or nanny wages, or other countries.
| Argument | Type | Description |
|---|---|---|
| area | string | Place: a county, a region, a local authority, or a state or city where the source says so (examples: 'Cook County, IL', 'London', 'Dublin'). Leave out for the whole country, where the source has a national figure. GB: England (leave out), a region (London, North West ...) or a local authority (Manchester, Leeds, Camden ...). Local authorities are published for 2 year olds and 3 and 4 year olds only. IE: a county, city or region such as Dublin, Cork, Galway or Mid-West; the answer is for the CSO region it belongs to. Leave out for the whole State. NO: a municipality such as Oslo, Bergen, Trondheim, Stavanger or Tromso (Norwegian spellings work). Leave out for the whole country. US: required. A county, for example 'Cook County, IL' or 'Harris County, Texas' (add the state when the name is not unique). Cities, ZIP codes and states are not published; use the county. |
Use this when a user asks what shops, offices, workshops, warehouses or other commercial premises actually sold for, or what a plot of non-farm land (a building plot) sold for, per square metre, in a town or postcode, in France (country FR) or Taiwan (country TW). Returns the median price per square metre, a typical range (10th–90th percentile), the number of sales, the period covered, a confidence label, and the official source and licence, from government sale records (prices paid, not asking prices). How fresh: France: twice a year, with a delay of several months; Taiwan: every 10 days. A sale appears one to two months after the deal; answers cover whole calendar months ending at least 30 days before the newest deal. Do not use for homes, farmland, rents, asking prices or listings, the value of one particular building, or other countries.
| Argument | Type | Description |
|---|---|---|
| town | string | Town or city. FR: town, e.g. 'Bordeaux', or use postcode. TW: a city or county in English or Chinese ('Taipei', 'New Taipei', 'Taichung', 'Kaohsiung', '臺北市'), or a district with its city ("Zhongshan, Taipei", '臺北市中山區'). Omit for all of Taiwan. |
| months | integer | How many recent months to include. Default 24. TW: 12 or 24 whole calendar months; up to 18 gives 12 (24 if a place has too few sales in 12), more gives 24. |
| country* | string | FR = France (DVF); TW = Taiwan |
| postcode | string | Postcode, for a precise area. FR: 5-digit postcode, e.g. '33000'; use instead of town for a precise area. TW: not supported (the register has no postcodes); give the city, county or district as town. |
Use this when a user asks what it costs to build a home or other building per square metre in Brazil (country BR), how much of that is materials and how much is labour, or how states or regions compare. Returns the official average cost per square metre for the latest month published, split into materials and labour, with the previous month, the official source and licence. This is a published survey average of unit costs (price_type official_statistic), not a range built from invoices or sales, so the range fields are null and there is no sample size. How fresh: monthly; the latest month on 16 Oct 2026 was September 2026. Do not use for the price of a finished home, for a builder's quote, for renovation work, or for countries that are not listed.
| Argument | Type | Description |
|---|---|---|
| area | string | State or region, where the publisher splits by place (the country notes say how). Leave out for the national figure. BR: state name or two-letter code ('São Paulo', 'SP', 'Bahia', 'RJ'); leave out for the national figure (Brasil). States: RO = Rondônia, AC = Acre, AM = Amazonas, RR = Roraima, PA = Pará, AP = Amapá, TO = Tocantins, MA = Maranhão, PI = Piauí, CE = Ceará, RN = Rio Grande do Norte, PB = Paraíba, PE = Pernambuco, AL = Alagoas, SE = Sergipe, BA = Bahia, MG = Minas Gerais, ES = Espírito Santo, RJ = Rio de Janeiro, SP = São Paulo, PR = Paraná, SC = Santa Catarina, RS = Rio Grande do Sul, MS = Mato Grosso do Sul, MT = Mato Grosso, GO = Goiás, DF = Distrito Federal. |
| country* | string | BR = Brazil (all 27 states plus the national figure; IBGE SINAPI average cost per m2) |
| component | string | Which part of the cost: total (default), material (building materials) or labour (wages). BR: total (default) = average cost per m2; material = materials part; labour = labour part. All in BRL per m2, monthly. |
Use this when a user asks what governments, councils, hospitals or other public buyers actually paid for something (laptops, school meals, road resurfacing, office cleaning, electricity, ambulances, waste collection and similar purchases) in Australia (federal contracts, AusTender), Canada (federal contracts, CanadaBuys), Colombia (public contracts, SECOP II), EU and EEA states (TED), France (public contracts, DECP), the United Kingdom (Contracts Finder), New Zealand (GETS), Singapore (GeBIZ), the United States (federal contracts) or South Africa (public contracts, eTenders). Returns, from official contract award notices, the median awarded value per contract, a typical range (10th–90th percentile), the number of awards, the period covered, a confidence label, and the official source and licence. Important: the figures are TOTAL values per contract (lot), not unit prices, unless the answer states a unit price (only when the notices give a quantity and unit). Nothing is returned for fewer than 5 awards, and individual suppliers are never named. How fresh: Australia (federal contracts, AusTender) and the United Kingdom (Contracts Finder): continuous: buyers publish award notices after a contract is awarded; Canada (federal contracts, CanadaBuys): daily: CanadaBuys refreshes the award notice files every day and our copy is collected once a day; Colombia (public contracts, SECOP II): daily: Colombia Compra Eficiente refreshes the open dataset about daily and our copy is collected once a day; EU and EEA states (TED): daily on working days: notices appear on TED within days of the buyer sending them; France (public contracts, DECP): daily: the consolidated monthly files are refreshed about daily and our copy is collected once a day; New Zealand (GETS): quarterly; awards up to the end of the last quarter; Singapore (GeBIZ): yearly; the United States (federal contracts): daily: agencies report contract actions within days and USAspending refreshes nightly; South Africa (public contracts, eTenders): monthly: the Open Contracting Partnership refreshes the eTenders bulk file about once a month and our copy is collected once a day. Do not use for what consumers or private companies pay, for tenders that are still open (those carry estimates, not prices paid), for the contracts of one named supplier, for asking prices, or for other countries.
| Argument |
|---|
Use this to see which countries and kinds of price the tools cover. It returns a short overview: for each tool the countries it answers for, how many official sources stand behind it and how often they update. Give category and/or country to get the full detail of the matching sources instead (publisher, licence, attribution line, limits, example requests). Every source at once, as JSON: https://proofprice.com/api/v1/coverage
| Argument | Type | Description |
|---|---|---|
| country | string | Optional. Return the full detail of the sources that cover this country: an ISO code such as IE, GB or FR. Can be combined with category. |
| category | string | Optional. Return the full detail of this category's sources: one of border-prices, broadband, cars, childcare, commercial-property, construction, contracts, diet-costs, energy, farm-gate-prices, farm-prices, flights, fuel, groceries, health-insurance, home-sales, home-upgrades, hotels, insurance, land-prices, medical, medicines, price-levels, producer-prices, rent, surplus-auctions, tuition, wholesale-fresh-food, wholesale-markets, wholesale-power (the tool name also works). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"country": {
"type": "string",
"description": "Optional. Return the full detail of the sources that cover this country: an ISO code such as IE, GB or FR. Can be combined with category."
},
"category": {
"type": "string",
"description": "Optional. Return the full detail of this category's sources: one of border-prices, broadband, cars, childcare, commercial-property, construction, contracts, diet-costs, energy, farm-gate-prices, farm-prices, flights, fuel, groceries, health-insurance, home-sales, home-upgrades, hotels, insurance, land-prices, medical, medicines, price-levels, producer-prices, rent, surplus-auctions, tuition, wholesale-fresh-food, wholesale-markets, wholesale-power (the tool name also works)."
}
}
}Use this when a user asks how much it costs to eat healthily in a country, for example the cost of the cheapest healthy diet per person per day, how that cost changed on a year earlier, or how much of it goes on fruit, vegetables, animal-source foods, legumes and nuts, oils and fats or starchy staples, in about 68 countries worldwide (World Bank estimates) (country IE), about 68 countries worldwide (World Bank estimates) (country GB), about 68 countries worldwide (World Bank estimates) (country FR), about 68 countries worldwide (World Bank estimates) (country ES), about 68 countries worldwide (World Bank estimates) (country PT), about 68 countries worldwide (World Bank estimates) (country IT), about 68 countries worldwide (World Bank estimates) (country DE), about 68 countries worldwide (World Bank estimates) (country NL), about 68 countries worldwide (World Bank estimates) (country BE), about 68 countries worldwide (World Bank estimates) (country AT), about 68 countries worldwide (World Bank estimates) (country PL), about 68 countries worldwide (World Bank estimates) (country DK), about 68 countries worldwide (World Bank estimates) (country SE), about 68 countries worldwide (World Bank estimates) (country NO), about 68 countries worldwide (World Bank estimates) (country FI), about 68 countries worldwide (World Bank estimates) (country GR), about 68 countries worldwide (World Bank estimates) (country LU), about 68 countries worldwide (World Bank estimates) (country CH), about 68 countries worldwide (World Bank estimates) (country IS), about 68 countries worldwide (World Bank estimates) (country CZ), about 68 countries worldwide (World Bank estimates) (country HU), about 68 countries worldwide (World Bank estimates) (country RO), about 68 countries worldwide (World Bank estimates) (country SK), about 68 countries worldwide (World Bank estimates) (country SI), about 68 countries worldwide (World Bank estimates) (country EE), about 68 countries worldwide (World Bank estimates) (country LV), about 68 countries worldwide (World Bank estimates) (country LT), about 68 countries worldwide (World Bank estimates) (country CY), about 68 countries worldwide (World Bank estimates) (country MT), about 68 countries worldwide (World Bank estimates) (country TR), about 68 countries worldwide (World Bank estimates) (country UA), about 68 countries worldwide (World Bank estimates) (country US), about 68 countries worldwide (World Bank estimates) (country CA), about 68 countries worldwide (World Bank estimates) (country MX), about 68 countries worldwide (World Bank estimates) (country BR), about 68 countries worldwide (World Bank estimates) (country AR), about 68 countries worldwide (World Bank estimates) (country CL), about 68 countries worldwide (World Bank estimates) (country CO), about 68 countries worldwide (World Bank estimates) (country PE), about 68 countries worldwide (World Bank estimates) (country AU), about 68 countries worldwide (World Bank estimates) (country NZ), about 68 countries worldwide (World Bank estimates) (country SG), about 68 countries worldwide (World Bank estimates) (country JP), about 68 countries worldwide (World Bank estimates) (country KR), about 68 countries worldwide (World Bank estimates) (country TW), about 68 countries worldwide (World Bank estimates) (country HK), about 68 countries worldwide (World Bank estimates) (country CN), about 68 countries worldwide (World Bank estimates) (country IN), about 68 countries worldwide (World Bank estimates) (country ID), about 68 countries worldwide (World Bank estimates) (country TH), about 68 countries worldwide (World Bank estimates) (country VN), about 68 countries worldwide (World Bank estimates) (country MY), about 68 countries worldwide (World Bank estimates) (country PH), about 68 countries worldwide (World Bank estimates) (country PK), about 68 countries worldwide (World Bank estimates) (country BD), about 68 countries worldwide (World Bank estimates) (country LK), about 68 countries worldwide (World Bank estimates) (country AE), about 68 countries worldwide (World Bank estimates) (country SA), about 68 countries worldwide (World Bank estimates) (country IL), about 68 countries worldwide (World Bank estimates) (country EG), about 68 countries worldwide (World Bank estimates) (country MA), about 68 countries worldwide (World Bank estimates) (country ZA), about 68 countries worldwide (World Bank estimates) (country NG), about 68 countries worldwide (World Bank estimates) (country KE), about 68 countries worldwide (World Bank estimates) (country GH), about 68 countries worldwide (World Bank estimates) (country TZ), about 68 countries worldwide (World Bank estimates) (country UG) or about 68 countries worldwide (World Bank estimates) (country ET). Returns the World Bank's modelled cost of a least-cost healthy diet, built from the food prices collected for the International Comparison Program: the figure in the country's own currency and in international (PPP) dollars, the year, the change on the previous year, the years since 2017, and the official source and licence. This is a modelled national estimate (price_type official_statistic), not a shop receipt, not what one household paid and not a range, so the range fields are null and there is no sample size. How fresh: roughly yearly: version 5.0 was last updated on 2026-07-21 and holds 2017 to 2025; every answer states its year. Do not use for the price of a particular food or shop, restaurant meals, a family's real food bill, or for countries that are not listed.
Use this when a user asks what households pay for electricity or natural gas per kWh in Brazil, Switzerland, the EU, Norway and Iceland, Great Britain, the Netherlands, New Zealand, Sweden, Singapore, Taiwan or the United States, how that compares with another country, or how it changed since the previous period. Returns the official average price per kWh for a standard household consumption band, for the latest period published, with the same band excluding VAT and excluding all taxes, every band, the previous period and the change, and the official source and licence. This is a published average (price_type official_statistic), not a range built from sales, so the range fields are null and there is no sample size. How fresh: Brazil: updated whenever ANEEL homologates a tariff adjustment (each distributor adjusts once a year); each answer states the validity period of the tariff; Switzerland: yearly: ElCom publishes next year's tariffs in autumn; each answer states the tariff year; the EU, Norway and Iceland: updated twice a year (half-yearly figures); each answer states its reference period, and the newest half-year Eurostat holds for the country is returned; Great Britain: quarterly (the cap is reset on 1 January, 1 April, 1 July and 1 October); each answer states the quarter it is for; the Netherlands: half-yearly (new figures end of March and end of September; the last two half-years are provisional); each answer states its reference half-year; New Zealand: monthly file; the newest month is about four to five months behind today. Each answer states its month.; Sweden: half-yearly (new half-year about three months after it ends); each answer states its reference half-year; Singapore: annual: the newest full calendar year (2025 was published in 2025-10); each answer states the year; Taiwan: updated when Taipower changes its tariff; each answer states the date the table took effect; the United States: monthly: EIA adds a month to each table about two months after it ends (electricity in the last week of the month, natural gas at the month's end); our copy is refreshed daily and each answer states its month. BUSINESS prices: set sector=business to get what businesses (non-household consumers: shops, offices, factories) pay instead, for the EU, Norway, Iceland and EU candidate countries (business), the United Kingdom (business) or the United States (business). The answer is the official average price paid by businesses in an annual-consumption band (consumption_band; the country notes list the bands), excluding VAT unless taxes says otherwise, with the other bands, the previous period and the change. It is an official average, not a quote or a tariff, and sector=business needs a country that has business figures. Business freshness: the EU, Norway, Iceland and EU candidate countries (business): updated twice a year (half-yearly figures); each answer states its reference period, and the newest half-year Eurostat holds for the country is returned; the United Kingdom (business): quarterly (DESNZ updates the tables at the end of March, June, September and December, about three months after the quarter ends); each answer states its quarter, and the newest quarter is provisional; the United States (business): monthly: EIA adds a month to each table about two months after it ends (electricity in the last week of the month, natural gas at the month's end); each answer states its month. Do not use for a specific supplier's offer or a quote for a particular home or company, for wholesale exchange prices, for petrol and diesel, or for other countries.
Use this when a user asks what farmers received, per month, for a crop or animal product (wheat, barley, oats, canola, soybeans, corn, potatoes, cattle, hogs, lambs, chickens, turkeys, milk, eggs) in a region of Canada, or how that price compares with the month before or a year earlier. Returns the newest monthly price the statistics office publishes for the product and region, in the unit the office uses (per tonne, per hundredweight, per dozen, per kilolitre), the month it applies to, the change on the previous month and a year earlier, the last 12 months, the same product in other regions, and the official source and licence. This is a published monthly average price received by farmers (price_type official_statistic), not a range built from sales, so the range fields are null and there is no sample size. How fresh: monthly, not live: Statistics Canada publishes each month's averages about six weeks after the month ends (August 2026 was released on 9 October 2026), and every answer states its reference month. Always read the month in the answer. Do not use for supermarket or shop prices, for wholesale market quotes, for the price of a particular farm, field or animal, for farmland, for fuel or energy, for futures prices, or for EU member states.
| Argument | Type | Description |
|---|---|---|
| region | string | Region inside the country, as the statistics office publishes it (for example a province or state). Some countries publish no national figure, so the answer then asks for a region. Canada: a province is required (Ontario, Quebec, Saskatchewan, Alberta, Manitoba, British Columbia, Nova Scotia, New Brunswick, Prince Edward Island, Newfoundland and Labrador). Statistics Canada publishes no Canada total in this table. A city such as Saskatoon is answered with its province. Not every product is published for every province. |
| country* | string | CA = Canada (Statistics Canada: monthly average prices received by farmers, by province, official statistic, not a live price) |
Use this when a user asks what farmers or wholesalers get for a food commodity (wheat, barley, maize, beef, pigs, lamb, chicken, eggs, milk, butter and other dairy products, olive oil, fruit and vegetables) in EU member states, how that price compares with last week, last month or a year ago, or how high it is against the last 12 months. Returns the latest official price for the country and product, per tonne or per 100 kg and per kg, for the week (milk: month) it applies to, the stage of the supply chain it is quoted at (farm gate, ex-silo, carcass, ex-packaging station), the change from the previous period and from a year earlier, the last 12 months, the other series the portal holds, and the official source and licence. This is a published price (price_type official_statistic), not a range built from trades, so the range fields are null and there is no sample size. How fresh: weekly for most products (raw milk monthly), updated as Member States report, usually within days (raw milk about two weeks after the month ends). Each answer states its week or month and flags quotes that are older than usual (fruit and vegetables are only quoted in season). Always read the period in the answer: an old quote is flagged and given lower confidence. Do not use for supermarket or shop prices, for the price of a particular farm, field, animal or meal, for farmland, for fuel or energy, for futures or stock-market prices, or for other countries.
| Argument | Type | Description |
|---|---|---|
| country* | string | EU member states, as ISO codes (GR for Greece): AT = Austria, BE = Belgium, BG = Bulgaria, HR = Croatia, CY = Cyprus, CZ = Czechia, DK = Denmark, EE = Estonia, FI = Finland, FR = France, DE = Germany, GR = Greece, HU = Hungary, IE = Ireland, IT = Italy, LV = Latvia, LT = Lithuania, MT = Malta, NL = Netherlands, PL = Poland, PT = Portugal, RO = Romania, SK = Slovakia, SI = Slovenia, ES = Spain, SE = Sweden. Not covered: LU (the portal holds no Luxembourg prices) and countries outside the EU such as GB and NO. Not every country reports every product (olive oil: ES, IT, PT, GR and HR only; dairy products about 16 countries); the answer says when a product is missing. |
Use this when a user asks how pump prices have changed over recent days or weeks in a place, or whether fuel is getting cheaper. Returns the daily median and typical range of pump prices in the area, with the change over the period, from our daily snapshots of official data. Do not use for today's cheapest stations. After 10 free calls a day per caller this tool costs USD 0.02 per answered call, paid with x402 (USDC); a 402 reply lists how. Nothing is charged for "not enough records" or errors.
| Argument | Type | Description |
|---|---|---|
| tax | string | EU Weekly Oil Bulletin countries only: 'with' (default) = the pump price with all duties and taxes; 'without' = the Commission's price net of duties and taxes (VAT and excise removed), the basis many fuel-surcharge indices use. The answer states which. Other countries refuse it with a 400 (they publish pump prices with taxes only). |
| area | string | Wider area when no postcode. AU (Queensland only): 'Brisbane' (postcodes 4000 to 4179) or 'QLD' (the whole state). A suburb name also works. BR: state as a two-letter code or name ('SP', 'Minas Gerais'); leave empty for all Brazil. Ontario: same as town (a market, or Ontario / Southern Ontario / Northern Ontario). Canada: same as town (a city, or 'Canada'). Provinces are not published. ES: province code ('28' = Madrid). EU Weekly Oil Bulletin countries: not used (national average only). FR: department ('69', '2A'). GB: not used (national average only). IT: province ('MI', 'RM'). MX: state name or code ('Ciudad de México', 'CDMX', 'Jalisco', 'NLE'); leave empty for all Mexico. Only states are available. MY: not used (national price only). Netherlands: not used (national average only). Norway: not used (national average only). NZ: not used (national price only). TW: not used (island-wide price only). US: a state ('TX', 'California') or PADD region ('Gulf Coast', 'PADD 1B', 'West Coast'); leave empty for the national average. EIA publishes gasoline for CA, CO, FL, MA, MN, NY, OH, TX and WA, diesel only for California plus the nation and PADD regions. Any other place gets the national average, and the answer says so (with its region as context). US heating oil and propane: not used (national average only). Uruguay: not used (national maximum price only). |
Use this when a user asks the current price of petrol, diesel, E10, E85, LPG or CNG near a place in Queensland, Brazil, Ontario, Canada, Spain, the EU (national averages), France, the United Kingdom (national averages), Italy, Mexico, Malaysia, the Netherlands, Norway, New Zealand, Taiwan, the United States or Uruguay, or where fuel is cheapest there. Returns the median and typical range of pump prices across stations in the area, the three cheapest stations, and the official source and licence. How fresh: Queensland: monthly file, published about a month after the month ends (the newest data is usually 5 to 8 weeks old); Brazil: ANP publishes the survey as one file per month, so the newest survey week is usually one to four weeks old. Our copy is refreshed daily, and every answer states the survey week it describes; Ontario: weekly (Mondays, before the end of the business day; the next working day after a holiday); Canada: monthly, not live: Statistics Canada publishes each month's averages about two weeks after the month ends (August 2026 was released on 14 September 2026), and every answer states its reference month; Spain: several times a day; the EU (national averages): weekly: Monday prices, published that week; France: about every 10 minutes; the United Kingdom (national averages): weekly: one national figure each week, usually available the same week; Italy: daily (prices at 08:00 of the extraction day); Mexico: the feeds are current prices reported by the stations and carry no timestamps; our copy is taken once a day and every answer shows the day of that copy; Malaysia: weekly, on Thursdays; the Netherlands: weekly publication of daily averages: new days appear each Thursday, up to the Monday of that week; every answer states the day it is for; Norway: monthly; the newest month is normally published in the first weeks of the next month (table updated 21 October 2026 with September 2026); every answer states the month it is for; New Zealand: weekly (Fridays), using the previous week's data; the newest weeks are marked Provisional by MBIE and revised; Taiwan: changes usually on Mondays; the next week's list price is published the day before; the United States: weekly: EIA dates each figure to the Monday it describes and publishes it a day or two later (a day later after a federal holiday); our copy of EIA's history files is refreshed daily and every answer states its week; the United States: weekly in the heating season (October to March, published Wednesdays); EIA collects no heating oil or propane prices from April to September, so in summer the newest week is from March. Our copy of EIA's files is refreshed daily and every answer states its week; Uruguay: monthly: the price in force in each month; a month without a quotation is marked S/C by ANCAP. Do not use for other countries or for historical prices.
Use this when a user asks what an everyday grocery item (milk, bread, eggs, butter, cheese, chicken, bananas, potatoes, sugar, tea, coffee, beer, wine...) costs in the shops in Canada (country CA), the United Kingdom (country GB), Hong Kong (country HK), Ireland (country IE), Latvia (country LV), Mexico (Profeco shelf prices) (country MX), Malaysia (shop shelf prices, DOSM PriceCatcher) (country MY), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country AF), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country AM), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country BD), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country BF), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country BI), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country BJ), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country BO), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country CD), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country CF), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country CI), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country CM), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country DJ), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country ET), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country GM), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country GN), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country GW), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country HT), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country ID), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country IN), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country IQ), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country JO), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country KG), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country LA), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country LB), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country LR), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country LS), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country ML), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country MM), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country MR), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country MW), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country MZ), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country NE), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country NG), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country NP), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country PH), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country PK), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country RW), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country SD), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country SL), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country SN), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country SO), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country SS), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country TD), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country TG), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country TL), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country TZ), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country UA), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country UG), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country YE), countries WFP surveys (Africa, Asia, Middle East, Latin America) (country ZW) or the United States (country US), or how that price has changed over the last year. Returns the official average or median shop price that the national statistics office publishes for a standard item, built from the shelf prices its price collectors record in shops for the consumer price index (shelf prices observed by price collectors, not receipts and not what one shopper paid; some offices also use retailers' scanner data), with the exact item definition (for example 'Full-fat milk, per 2 litres'), the unit, the reference month, the change on a year earlier where the office publishes comparable figures (an answer carries none where the office advises against comparing months), the official source and licence. Each country defines its own standard items, so the item definition in the answer matters and related definitions are listed. How fresh: Canada: monthly, not live: Statistics Canada publishes each month's averages about five weeks after the month ends (August 2026 was released on 7 October 2026), and every answer states its reference month; the United Kingdom: monthly: ONS publishes each month's file about three to four weeks after the month ends (August 2026 appeared in late September); our copy is refreshed daily and each answer states its reference month; Hong Kong: daily; Ireland: monthly, published with the Consumer Price Index (usually the second week of the following month); each answer states its reference month; Latvia: monthly, usually in the second week of the following month; each answer states its reference month; Mexico (Profeco shelf prices): monthly, about 7 weeks behind; Malaysia (shop shelf prices, DOSM PriceCatcher): DOSM refreshes the monthly file daily; our copy is refreshed daily and each answer names the newest price date; countries WFP surveys (Africa, Asia, Middle East, Latin America): WFP files are updated about monthly (HDX file last modified 2026-10-12); the newest observation in a country is often 1 to 5 months old; our copy is refreshed daily; the United States: monthly: BLS releases the new month about the 10th to 14th of the following month; our copy is refreshed daily and each answer states its reference month. This is a published national (or regional) average, not a range of individual transactions, so the range fields can be null. Do not use for the price at a particular supermarket or online shop, loyalty-card or special-offer prices, restaurant meals, petrol or diesel, or for other countries.
Use this when a user asks what compulsory basic health insurance costs per month under the approved tariffs, for example for an adult in a region with a given deductible, in Switzerland (country CH). Returns the median monthly premium with the typical range (10th to 90th percentile) across the insurers' approved tariffs, the number of tariffs behind it, the period, a confidence label, and the official source and licence. These are posted list tariffs approved by the regulator, the same for everyone in a region and age group, not amounts paid by individuals and not a personal quote. How fresh: once a year: premiums for the next year are approved and published in September. Do not use for a personal quote, for supplementary or private cover, or for countries not listed.
| Argument | Type | Description |
|---|---|---|
| area | string | Region (see the country notes), e.g. a canton code such as 'ZH'. Leave out for the whole country. CH: a canton code (AG, AI, AR, BE, BL, BS, FR, GE, GL, GR, JU, LU, NE, NW, OW, SG, SH, SO, SZ, TG, TI, UR, VD, VS, ZG, ZH); leave out for all of Switzerland. Premium regions inside a canton are pooled. |
| model | string | standard = free choice of doctor (default); alternative = family-doctor, telemedicine or HMO models with a restricted choice. |
| country* | string | CH = Switzerland (compulsory basic health insurance) |
| accident | string | Whether accident cover is included in the premium. Default: without for adults and young adults, with for children. |
Use this when a user asks what homes actually sold for in a town or area, what a fair price for a home is, or how much property costs there, in Austria (country AT), Australia (country AU), Belgium (country BE), British Columbia, Canada (country CA), Denmark (country DK), Bulgaria, Croatia, Cyprus, Czechia, Estonia, Germany, Hungary, Iceland, Italy, Latvia, Lithuania, Luxembourg, Malta, Poland, Romania, Slovakia, Slovenia and Spain (house price index only) (country BG), Bulgaria, Croatia, Cyprus, Czechia, Estonia, Germany, Hungary, Iceland, Italy, Latvia, Lithuania, Luxembourg, Malta, Poland, Romania, Slovakia, Slovenia and Spain (house price index only) (country HR), Bulgaria, Croatia, Cyprus, Czechia, Estonia, Germany, Hungary, Iceland, Italy, Latvia, Lithuania, Luxembourg, Malta, Poland, Romania, Slovakia, Slovenia and Spain (house price index only) (country CY), Bulgaria, Croatia, Cyprus, Czechia, Estonia, Germany, Hungary, Iceland, Italy, Latvia, Lithuania, Luxembourg, Malta, Poland, Romania, Slovakia, Slovenia and Spain (house price index only) (country CZ), Bulgaria, Croatia, Cyprus, Czechia, Estonia, Germany, Hungary, Iceland, Italy, Latvia, Lithuania, Luxembourg, Malta, Poland, Romania, Slovakia, Slovenia and Spain (house price index only) (country DE), Bulgaria, Croatia, Cyprus, Czechia, Estonia, Germany, Hungary, Iceland, Italy, Latvia, Lithuania, Luxembourg, Malta, Poland, Romania, Slovakia, Slovenia and Spain (house price index only) (country EE), Bulgaria, Croatia, Cyprus, Czechia, Estonia, Germany, Hungary, Iceland, Italy, Latvia, Lithuania, Luxembourg, Malta, Poland, Romania, Slovakia, Slovenia and Spain (house price index only) (country ES), Bulgaria, Croatia, Cyprus, Czechia, Estonia, Germany, Hungary, Iceland, Italy, Latvia, Lithuania, Luxembourg, Malta, Poland, Romania, Slovakia, Slovenia and Spain (house price index only) (country HU), Bulgaria, Croatia, Cyprus, Czechia, Estonia, Germany, Hungary, Iceland, Italy, Latvia, Lithuania, Luxembourg, Malta, Poland, Romania, Slovakia, Slovenia and Spain (house price index only) (country IS), Bulgaria, Croatia, Cyprus, Czechia, Estonia, Germany, Hungary, Iceland, Italy, Latvia, Lithuania, Luxembourg, Malta, Poland, Romania, Slovakia, Slovenia and Spain (house price index only) (country IT), Bulgaria, Croatia, Cyprus, Czechia, Estonia, Germany, Hungary, Iceland, Italy, Latvia, Lithuania, Luxembourg, Malta, Poland, Romania, Slovakia, Slovenia and Spain (house price index only) (country LV), Bulgaria, Croatia, Cyprus, Czechia, Estonia, Germany, Hungary, Iceland, Italy, Latvia, Lithuania, Luxembourg, Malta, Poland, Romania, Slovakia, Slovenia and Spain (house price index only) (country LT), Bulgaria, Croatia, Cyprus, Czechia, Estonia, Germany, Hungary, Iceland, Italy, Latvia, Lithuania, Luxembourg, Malta, Poland, Romania, Slovakia, Slovenia and Spain (house price index only) (country LU), Bulgaria, Croatia, Cyprus, Czechia, Estonia, Germany, Hungary, Iceland, Italy, Latvia, Lithuania, Luxembourg, Malta, Poland, Romania, Slovakia, Slovenia and Spain (house price index only) (country MT), Bulgaria, Croatia, Cyprus, Czechia, Estonia, Germany, Hungary, Iceland, Italy, Latvia, Lithuania, Luxembourg, Malta, Poland, Romania, Slovakia, Slovenia and Spain (house price index only) (country PL), Bulgaria, Croatia, Cyprus, Czechia, Estonia, Germany, Hungary, Iceland, Italy, Latvia, Lithuania, Luxembourg, Malta, Poland, Romania, Slovakia, Slovenia and Spain (house price index only) (country RO), Bulgaria, Croatia, Cyprus, Czechia, Estonia, Germany, Hungary, Iceland, Italy, Latvia, Lithuania, Luxembourg, Malta, Poland, Romania, Slovakia, Slovenia and Spain (house price index only) (country SK), Bulgaria, Croatia, Cyprus, Czechia, Estonia, Germany, Hungary, Iceland, Italy, Latvia, Lithuania, Luxembourg, Malta, Poland, Romania, Slovakia, Slovenia and Spain (house price index only) (country SI), Finland (country FI), France (country FR), England & Wales (country GB), Great Britain and Northern Ireland (country GB), Hungary (country HU), Ireland (country IE), the Netherlands (country NL), Norway (country NO), Poland (flats in the big cities) (country PL), Portugal (country PT), Sweden (country SE), Singapore public housing (country SG), Taiwan (country TW) or the United States (Connecticut, New York City and Cook County IL only) (country US). Returns the median sale price, a typical range (10th–90th percentile), the number of sales, the period covered, a confidence label, and the official source and licence, from government sale records. Do not use for rents, asking prices, commercial property, or other countries.
Use this when a user asks what a home upgrade costs in England and Wales (heat pumps) (country GB), Great Britain (country GB) or Ireland (country IE): a heat pump, solar panels (solar PV), loft/attic or wall insulation, or new windows. Returns an official statistic: the cost that installers or owners declared when a grant or tax claim was made (a median or average the publisher states for a period), with the period, the publisher's own wording of what the figure includes, the official source and licence. These are declared installed costs at grant or claim, not receipts, not quotes and not what one home paid; price_type is official_statistic, so the range fields can be null and the sample size is given only where the publisher states it. Each source covers only some measures: where a measure is not published the answer says so (status no_matches) instead of guessing. How fresh: England and Wales (heat pumps): monthly (the cost tables are updated each quarter, in January, April, July and October; the latest quarter ends about three months earlier); Great Britain: yearly (published each May for the financial year just ended; April to March); Ireland: irregular; the local-authority table currently ends with 2018/19. Some countries publish only a general renovation figure that is not split by type of work (the country notes say so). Do not use for a quote on a particular home, for installer prices or offers, for running costs or savings, or for other countries.
| Argument | Type | Description |
|---|---|---|
| area | string | Place, only where the publisher splits by place (the country notes say how). Leave out for the national figure. GB: national figures only; an area is ignored and the answer says so. IE: a county (Kerry, Cork, Dublin, Galway...) or a local authority (Fingal, DLR, Cork City...); leave out for all of Ireland. |
| country* | string | GB = England and Wales for heat pumps (Boiler Upgrade Scheme statistics) and Great Britain for solar panels; GB = Great Britain (solar PV: DESNZ declared installed cost per kW from MCS certificates; heat pumps: Boiler Upgrade Scheme statistics; England and Wales for heat pumps, Great Britain for solar); IE = Ireland (Revenue Home Renovation Incentive: declared value of renovation works by county; not split by type of work; SEAI figures are not included yet) |
Use this when a user asks what a hotel room costs per night, on average, in a country, region, province or city in Spain (country ES), Finland (country FI), Hong Kong (country HK) or Norway (country NO), or how hotel prices changed on a year earlier. Returns the official average daily rate: the average price actually charged per occupied hotel room per night, published monthly by the national statistics office from its hotel survey, with the month, the change on the same month a year earlier where published, the official source and licence. This is a published average over all hotels in the area, not a range of individual bookings and not a quote for a date, so the range fields are null and there is no sample size. How fresh: Spain: monthly, published about six weeks after the month ends; every answer states its month. Monthly history back to 2008; Finland and Norway: monthly, published about five weeks after the month ends; every answer states its month; Hong Kong: monthly, 2 to 3 months behind. A rolling five years. Do not use for the price of one named hotel, a booking for particular dates, holiday rentals or hostels, or for countries that are not listed.
| Argument | Type | Description |
|---|---|---|
| area | string | Region, province or city inside the country, in plain words (for example 'Madrid', 'Andalucia', 'Benidorm'). Leave out for the national average. ES: optional. A region ('Andalucia', 'Cataluña', 'Madrid'), a province ('Málaga', 'Cádiz', 'Illes Balears') or a tourist city or resort ('Benidorm', 'Barcelona', 'Alicante') as INE names them; accents are optional. Leave out for the Spain-wide average. A name that is both a province and a city gives the province and lists the other. FI: optional. A region ('Uusimaa', 'Lapland', 'Pirkanmaa', 'Southwest Finland', 'Aland') or a main city ('Helsinki', 'Tampere', 'Turku', 'Oulu', 'Rovaniemi'), which is answered with its region. Leave out for the whole country. HK: leave out. The Bureau publishes one citywide figure; a district name is refused rather than answered with the city average. NO: optional. A county ('Oslo', 'Vestland', 'Rogaland', 'Troms', 'Svalbard') or a main city ('Bergen', 'Stavanger', 'Trondheim', 'Tromso') as SSB counts them; Norwegian spellings work. Leave out for the whole country. |
Use this when a user asks what insurance actually costs the people who hold it, for example what homeowners pay per year for flood insurance in a ZIP code or state, in the United States (federal flood insurance) (country US). Returns the median yearly charge with the typical range (10th to 90th percentile) across real policies, the number of policies behind it, the period, a confidence label, and the official source and licence. Only aggregates are returned, never one policy, and never fewer than 5 policies. Read the method in the answer: some premiums are set partly by public rules, so they are real charges but not a free-market quote. How fresh: updated about monthly (data as of 2026-09-08 when checked); every answer states the period it covers. Do not use for a personal quote, for insurance that is not covered by a source here, for the value or replacement cost of a home, or for other countries.
| Argument | Type | Description |
|---|---|---|
| area | string | Place: a 5-digit ZIP code or a state code, depending on the country notes (examples: '32935', 'TX'). Required. US: required. A 5-digit ZIP code ('32935') or a 2-letter state or territory code ('TX', 'FL'). Flood insurance from the National Flood Insurance Program only; fewer than 5 policies in the last 12 months gives no figure. |
| country* | string | US = United States (federal flood insurance, NFIP, from FEMA OpenFEMA) |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country"
],
"properties": {
"area": {
"type": "string",
"minLength": 2,
"description": "Place: a 5-digit ZIP code or a state code, depending on the country notes (examples: '32935', 'TX'). Required. US: required. A 5-digit ZIP code ('32935') or a 2-letter state or territory code ('TX', 'FL'). Flood insurance from the National Flood Insurance Program only; fewer than 5 policies in the last 12 months gives no figure."
},
"country": {
"enum": [
"US"
],
"type": "string",
"description": "US = United States (federal flood insurance, NFIP, from FEMA OpenFEMA)"
}
}
}Use this when a user asks what agricultural land (farmland, arable land or grassland) sells for, or what it costs to rent, per hectare in EU member states and Norway, in a particular region of such a country, or how it changed since the year before. Returns the official average price per hectare (or the average rent per hectare for one year) for the latest year published, in the currency the answer states (euro and national currency where the source gives both), for the chosen land type (arable, permanent grassland and others), the previous year and change, the history, the other land types, the regions that exist, and the official source and licence. This is a published average (price_type official_statistic), not a range built from sales, so the range fields are null and there is no sample size. How fresh: annual. Eurostat publishes land data with a lag of about two years (on 2026-10-14 the newest year is 2024) and some countries are further behind; each answer states its reference year and flags old figures. Always read the reference year in the answer: the data are about two years behind and some countries are much older. Do not use for the value of a particular field or farm, for house or building land or commercial property, for listings or asking prices, or for other countries.
| Argument | Type | Description |
|---|---|---|
| region | string | Optional region code for a regional figure, where the source publishes one (the country notes say which codes). Leave out for the whole country. EU/NO, optional. A NUTS region code (Eurostat's regional land data), e.g. ES51 = Cataluña, ES61 = Andalucía, FRJ2 = Midi-Pyrénées, IE05 = Southern, NL32 = Noord-Holland, PT11 = Norte, PL91 = Warszawski stołeczny, SE11 = Stockholm. Leave out for the whole country. Every national answer lists its regions in extra.regions_available. Regions exist only for some countries and years: a code Eurostat does not hold gets a clear no_matches. |
| country* |
Use this when a user asks what a medical service or hospital stay costs, or what was actually paid for it, for example an office visit, an MRI, a colonoscopy, physical therapy, a knee replacement or a pneumonia stay, in Singapore (hospital bills for medical conditions) (country SG) or the United States (what Medicare paid doctors and hospitals) (country US). Returns the official average amount the public health insurer allowed per service (doctors' services, in an office or a facility) or paid per hospital stay (by hospital-stay group), nationally or for one state where the source publishes it, with the number of services or discharges behind it, the share the insurer itself paid, the national average for comparison and the data year, plus the official source and licence. These are public-insurance rates (price_type official_statistic): what the insurer allowed or paid, NOT private-insurance negotiated prices or cash prices, which are usually higher, and not a quote. A published average, so the range fields are null. Facility figures are the doctor's fee only; the hospital's or surgery centre's fee is separate. How fresh: Singapore (hospital bills for medical conditions): annual benchmark file (data year 2023, file last updated 15 May 2026); every answer states its data year; the United States (what Medicare paid doctors and hospitals): annual: one calendar year at a time (the 2024 data year was released in 2026); every answer states its data year. Do not use for a quote or what a specific hospital or doctor charges, private-insurance or out-of-pocket costs, drug or prescription prices, dental or vision plans, or other countries.
| Argument | Type | Description |
|---|---|---|
| state | string | A state or territory, where the source publishes one (the country notes say how to write it). Leave out for the national average. Singapore: the ward class, because Singapore has no states: c = public subsidised Ward C (default), b2 = public subsidised Ward B2, b1 = public unsubsidised Ward B1, a = public unsubsidised Ward A, private = private hospital. US: a state or territory as a two-letter code or name (TX, Texas). Leave out for the national average. |
Use this when a user asks what a medicine costs in a pharmacy, or how much of the price the health insurance reimburses, in Spain (country ES), France (country FR), England (NHS) (country GB), Italy (country IT), Japan (country JP), New Zealand (country NZ) or the United States (country US). Returns the median and typical range (10th–90th percentile) of the legally fixed price per box across all pack sizes and strengths sold under that medicine name, the number of packs, the period, a confidence label, and the official source and licence. These are regulated (posted) prices, not market transactions, and only for reimbursable medicines. Do not use for over-the-counter products with free prices or for other countries.
| Argument | Type | Description |
|---|---|---|
| country* | string | ES = Spain (Ministerio de Sanidad Nomenclator: legally fixed public prices of medicines billed to the national health service); FR = France (public medicines database: legally fixed prices of reimbursable medicines); GB = England (NHS Prescription Cost Analysis: the basic price the NHS reimburses for the drug, per tablet/capsule/ml, not a patient price; England only); IT = Italy (AIFA transparency list: public prices of reimbursable off-patent class A medicines); JP = Japan (MHLW National Health Insurance drug price list: official reimbursement prices in yen); NZ = New Zealand (PHARMAC Pharmaceutical Schedule: list prices of subsidised community medicines, NZD); US = United States (NADAC: the average price retail pharmacies pay to acquire a drug, weekly, per tablet/capsule/mL/gram; not the patient's counter price) |
| medicine* | string | Medicine brand or active-substance name, e.g. 'doliprane' or 'paracetamol'. Only the first word is used. ES: Spanish active-ingredient or brand name, first word used ('paracetamol', 'ibuprofeno', 'omeprazol', 'dolocatil'). Needs 5+ packs on sale under that name. FR: brand or active substance, first word used ('doliprane', 'paracetamol', 'amoxicilline'). Needs 5+ priced packs under that name. GB: generic or brand name, optionally with strength and form ('omeprazole', 'atorvastatin 20mg', 'Lipitor', 'paracetamol tablets'). NHS names follow the British National Formulary (the common American names are mapped). Returns the NHS net ingredient cost per unit and per 28-unit supply. IT: Italian active-substance or brand name, first word used ('paracetamolo', 'amoxicillina', 'glucobay'). Needs 5+ packs under that name. Off-patent reimbursable (class A) medicines only. JP: the active ingredient, in English ('paracetamol', 'amlodipine', 'metformin') or Japanese ('アムロジピン'); first word used. Not brand names. Needs 5+ listed products. Official reimbursement price per tablet, capsule, gram, millilitre or vial, not what a patient paid. NZ: English chemical or brand name, first word used ('paracetamol', 'amoxicillin', 'panadol'). Needs 5+ subsidised packs under that name. Subsidised community medicines only; list prices, not what patients paid. US: generic or brand name, optionally with strength and form ('atorvastatin', 'atorvastatin 20mg', 'metformin 500 mg tablet', 'Lipitor'). NADAC uses American generic names ('acetaminophen' for paracetamol, 'albuterol' for salbutamol; the common British names are mapped). Returns the per-unit cost to the pharmacy. |
Use this when a user asks how expensive a country is compared with an international average, for everyday spending such as food, housing, transport, health, clothing or restaurants, for example 'is food dearer here than in a neighbouring country', 'how much more expensive is a country than the average' or what a dollar buys in local currency (purchasing power parity), in 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country AU), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country AT), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country BE), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country CA), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country CL), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country CO), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country CR), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country CZ), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country DK), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country EE), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country FI), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country FR), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country DE), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country GR), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country HU), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country IS), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country IE), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country IL), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country IT), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country JP), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country KR), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country LV), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country LT), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country LU), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country MX), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country NL), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country NZ), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country NO), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country PL), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country PT), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country SK), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country SI), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country ES), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country SE), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country CH), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country TR), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country GB), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country US), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country BG), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country CY), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country MT), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country RO), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country AL), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country BA), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country MK), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country ME), 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states) (country RS), About 130 economies outside the OECD (World Bank ICP 2021) (country AF), About 130 economies outside the OECD (World Bank ICP 2021) (country AO), About 130 economies outside the OECD (World Bank ICP 2021) (country AE), About 130 economies outside the OECD (World Bank ICP 2021) (country AR), About 130 economies outside the OECD (World Bank ICP 2021) (country AM), About 130 economies outside the OECD (World Bank ICP 2021) (country AG), About 130 economies outside the OECD (World Bank ICP 2021) (country AZ), About 130 economies outside the OECD (World Bank ICP 2021) (country BI), About 130 economies outside the OECD (World Bank ICP 2021) (country BJ), About 130 economies outside the OECD (World Bank ICP 2021) (country BF), About 130 economies outside the OECD (World Bank ICP 2021) (country BD), About 130 economies outside the OECD (World Bank ICP 2021) (country BH), About 130 economies outside the OECD (World Bank ICP 2021) (country BS), About 130 economies outside the OECD (World Bank ICP 2021) (country BY), About 130 economies outside the OECD (World Bank ICP 2021) (country BZ), About 130 economies outside the OECD (World Bank ICP 2021) (country BO), About 130 economies outside the OECD (World Bank ICP 2021) (country BR), About 130 economies outside the OECD (World Bank ICP 2021) (country BB), About 130 economies outside the OECD (World Bank ICP 2021) (country BN), About 130 economies outside the OECD (World Bank ICP 2021) (country BT), About 130 economies outside the OECD (World Bank ICP 2021) (country BW), About 130 economies outside the OECD (World Bank ICP 2021) (country CF), About 130 economies outside the OECD (World Bank ICP 2021) (country CN), About 130 economies outside the OECD (World Bank ICP 2021) (country CI), About 130 economies outside the OECD (World Bank ICP 2021) (country CM), About 130 economies outside the OECD (World Bank ICP 2021) (country CD), About 130 economies outside the OECD (World Bank ICP 2021) (country CG), About 130 economies outside the OECD (World Bank ICP 2021) (country KM), About 130 economies outside the OECD (World Bank ICP 2021) (country CV), About 130 economies outside the OECD (World Bank ICP 2021) (country DJ), About 130 economies outside the OECD (World Bank ICP 2021) (country DM), About 130 economies outside the OECD (World Bank ICP 2021) (country DO), About 130 economies outside the OECD (World Bank ICP 2021) (country DZ), About 130 economies outside the OECD (World Bank ICP 2021) (country EC), About 130 economies outside the OECD (World Bank ICP 2021) (country EG), About 130 economies outside the OECD (World Bank ICP 2021) (country ER), About 130 economies outside the OECD (World Bank ICP 2021) (country ET), About 130 economies outside the OECD (World Bank ICP 2021) (country FJ), About 130 economies outside the OECD (World Bank ICP 2021) (country GA), About 130 economies outside the OECD (World Bank ICP 2021) (country GE), About 130 economies outside the OECD (World Bank ICP 2021) (country GH), About 130 economies outside the OECD (World Bank ICP 2021) (country GN), About 130 economies outside the OECD (World Bank ICP 2021) (country GM), About 130 economies outside the OECD (World Bank ICP 2021) (country GW), About 130 economies outside the OECD (World Bank ICP 2021) (country GQ), About 130 economies outside the OECD (World Bank ICP 2021) (country GD), About 130 economies outside the OECD (World Bank ICP 2021) (country GT), About 130 economies outside the OECD (World Bank ICP 2021) (country GY), About 130 economies outside the OECD (World Bank ICP 2021) (country HK), About 130 economies outside the OECD (World Bank ICP 2021) (country HN), About 130 economies outside the OECD (World Bank ICP 2021) (country HR), About 130 economies outside the OECD (World Bank ICP 2021) (country HT), About 130 economies outside the OECD (World Bank ICP 2021) (country ID), About 130 economies outside the OECD (World Bank ICP 2021) (country IN), About 130 economies outside the OECD (World Bank ICP 2021) (country IR), About 130 economies outside the OECD (World Bank ICP 2021) (country IQ), About 130 economies outside the OECD (World Bank ICP 2021) (country JM), About 130 economies outside the OECD (World Bank ICP 2021) (country JO), About 130 economies outside the OECD (World Bank ICP 2021) (country KZ), About 130 economies outside the OECD (World Bank ICP 2021) (country KE), About 130 economies outside the OECD (World Bank ICP 2021) (country KG), About 130 economies outside the OECD (World Bank ICP 2021) (country KH), About 130 economies outside the OECD (World Bank ICP 2021) (country KN), About 130 economies outside the OECD (World Bank ICP 2021) (country KW), About 130 economies outside the OECD (World Bank ICP 2021) (country LA), About 130 economies outside the OECD (World Bank ICP 2021) (country LB), About 130 economies outside the OECD (World Bank ICP 2021) (country LR), About 130 economies outside the OECD (World Bank ICP 2021) (country LY), About 130 economies outside the OECD (World Bank ICP 2021) (country LC), About 130 economies outside the OECD (World Bank ICP 2021) (country LK), About 130 economies outside the OECD (World Bank ICP 2021) (country LS), About 130 economies outside the OECD (World Bank ICP 2021) (country MO), About 130 economies outside the OECD (World Bank ICP 2021) (country MA), About 130 economies outside the OECD (World Bank ICP 2021) (country MD), About 130 economies outside the OECD (World Bank ICP 2021) (country MG), About 130 economies outside the OECD (World Bank ICP 2021) (country MV), About 130 economies outside the OECD (World Bank ICP 2021) (country ML), About 130 economies outside the OECD (World Bank ICP 2021) (country MM), About 130 economies outside the OECD (World Bank ICP 2021) (country MN), About 130 economies outside the OECD (World Bank ICP 2021) (country MZ), About 130 economies outside the OECD (World Bank ICP 2021) (country MR), About 130 economies outside the OECD (World Bank ICP 2021) (country MU), About 130 economies outside the OECD (World Bank ICP 2021) (country MW), About 130 economies outside the OECD (World Bank ICP 2021) (country MY), About 130 economies outside the OECD (World Bank ICP 2021) (country NA), About 130 economies outside the OECD (World Bank ICP 2021) (country NE), About 130 economies outside the OECD (World Bank ICP 2021) (country NG), About 130 economies outside the OECD (World Bank ICP 2021) (country NI), About 130 economies outside the OECD (World Bank ICP 2021) (country NP), About 130 economies outside the OECD (World Bank ICP 2021) (country OM), About 130 economies outside the OECD (World Bank ICP 2021) (country PK), About 130 economies outside the OECD (World Bank ICP 2021) (country PA), About 130 economies outside the OECD (World Bank ICP 2021) (country PE), About 130 economies outside the OECD (World Bank ICP 2021) (country PH), About 130 economies outside the OECD (World Bank ICP 2021) (country PY), About 130 economies outside the OECD (World Bank ICP 2021) (country PS), About 130 economies outside the OECD (World Bank ICP 2021) (country QA), About 130 economies outside the OECD (World Bank ICP 2021) (country RU), About 130 economies outside the OECD (World Bank ICP 2021) (country RW), About 130 economies outside the OECD (World Bank ICP 2021) (country SA), About 130 economies outside the OECD (World Bank ICP 2021) (country SD), About 130 economies outside the OECD (World Bank ICP 2021) (country SN), About 130 economies outside the OECD (World Bank ICP 2021) (country SG), About 130 economies outside the OECD (World Bank ICP 2021) (country SL), About 130 economies outside the OECD (World Bank ICP 2021) (country SV), About 130 economies outside the OECD (World Bank ICP 2021) (country SO), About 130 economies outside the OECD (World Bank ICP 2021) (country SS), About 130 economies outside the OECD (World Bank ICP 2021) (country ST), About 130 economies outside the OECD (World Bank ICP 2021) (country SR), About 130 economies outside the OECD (World Bank ICP 2021) (country SZ), About 130 economies outside the OECD (World Bank ICP 2021) (country SC), About 130 economies outside the OECD (World Bank ICP 2021) (country SY), About 130 economies outside the OECD (World Bank ICP 2021) (country TD), About 130 economies outside the OECD (World Bank ICP 2021) (country TG), About 130 economies outside the OECD (World Bank ICP 2021) (country TH), About 130 economies outside the OECD (World Bank ICP 2021) (country TJ), About 130 economies outside the OECD (World Bank ICP 2021) (country TM), About 130 economies outside the OECD (World Bank ICP 2021) (country TL), About 130 economies outside the OECD (World Bank ICP 2021) (country TT), About 130 economies outside the OECD (World Bank ICP 2021) (country TN), About 130 economies outside the OECD (World Bank ICP 2021) (country TW), About 130 economies outside the OECD (World Bank ICP 2021) (country TZ), About 130 economies outside the OECD (World Bank ICP 2021) (country UG), About 130 economies outside the OECD (World Bank ICP 2021) (country UA), About 130 economies outside the OECD (World Bank ICP 2021) (country UY), About 130 economies outside the OECD (World Bank ICP 2021) (country UZ), About 130 economies outside the OECD (World Bank ICP 2021) (country VC), About 130 economies outside the OECD (World Bank ICP 2021) (country VN), About 130 economies outside the OECD (World Bank ICP 2021) (country XK), About 130 economies outside the OECD (World Bank ICP 2021) (country ZA), About 130 economies outside the OECD (World Bank ICP 2021) (country ZM) or About 130 economies outside the OECD (World Bank ICP 2021) (country ZW). Returns the price level index (100 = the comparison average, 120 = prices 20% above it), the PPP rate in national currency, the year, the last years, the rank among the countries surveyed, and the official source and licence. This is a price level index from the international PPP survey (price_type official_statistic), not a shop price, not a receipt and not a range, so the range fields are null and there is no sample size. How fresh: 47 countries (the 38 OECD members plus Bulgaria, Cyprus, Malta, Romania and some Balkan states): yearly: the newest published year was 2024 at the last check (2022 onwards); every answer states its year; About 130 economies outside the OECD (World Bank ICP 2021): benchmark year 2021 (published 2024); the ICP runs a new round about every three years, every answer states its year. Do not use for the price of a particular product, a town or city, exchange rates on the money market, or for countries that are not listed.
Use this when a user asks what farmers received at the farm gate, per year, for a crop or animal product (wheat, maize, rice, soybeans, potatoes, tomatoes, apples, bananas, beef, pork, chicken, eggs, milk, coffee, cotton and many more) in 9 countries from FAOSTAT (US, CA, BR, MX, AU, NZ, SG, JP, KR), or how that annual price changed from the year before. Returns the newest annual producer price for the country and product, per tonne in the country's own currency (and in US dollars where available) and per kg, the year it applies to, the change on the previous year, whether the source marks the figure as estimated, related products, and the official source and licence. This is a published official statistic (price_type official_statistic), not a range built from sales, so the range fields are null and there is no sample size. How fresh: annual. FAO refreshes the file a few times a year and the newest year is usually one to two years behind today; our copy is refreshed daily and each answer states its reference year and whether FAO marks it as estimated. Always read the year in the answer: the newest annual figure is often one to two years old. Do not use for weekly or daily market quotes, for supermarket or shop prices, for the price of a particular farm, field or animal, for farmland, for fuel or energy, or for futures prices.
| Argument | Type | Description |
|---|---|---|
| country* | string | Countries outside the EU, as ISO codes: US = the United States, CA = Canada, BR = Brazil, MX = Mexico, AU = Australia, NZ = New Zealand, SG = Singapore, JP = Japan, KR = South Korea. FAOSTAT annual producer (farm-gate) prices: one figure per country, product and year, usually one to two years old. |
| product* | string | The crop or animal product, e.g. 'wheat', 'maize', 'rice', 'soybeans', 'potatoes', 'tomatoes', 'apples', 'bananas', 'beef', 'pork', 'chicken', 'eggs', 'milk', 'coffee', 'cotton'. US, CA, BR, MX, AU, NZ, SG, JP, KR (FAOSTAT; KR has few products): the crop or animal product, by everyday name: wheat, maize (corn), rice, barley, soybeans, potatoes, tomatoes, apples, bananas, oranges, beef, pork, chicken, eggs, milk, coffee, cotton and many more. Annual price per tonne in the country's own currency (and in US dollars where FAO gives it), also per kg. Not every country has every product: the answer lists what is available. |
Use this when a user asks what rent tenants actually pay or have agreed for a home in a town, area or postcode, how much it costs to rent a flat, house or room there, or how rents compare, in New South Wales, Australia (country AU), Queensland, Australia (country AU), Canada (country CA), Germany (country DE), Catalonia, Spain (country ES), Finland (country FI), France (country FR), England and Wales (country GB), Hong Kong (country HK), Ireland (country IE), Norway (country NO), New Zealand (country NZ), Portugal (country PT), Sweden (country SE), Singapore public housing (country SG) or Taiwan (country TW). These are rents actually agreed or paid, taken from official records and statistics: registered tenancies, rental bond lodgements, approved rentals, or official rent statistics built from administrative records of tenancies. Where the source holds individual rents the answer is a median with a typical range (10th–90th percentile) and the number of rents; where the source publishes an average or median (price_type official_statistic) the range fields are null and there is no sample size. Every answer states its unit (rent per month or per week, in the local currency), the period covered, a confidence label, and the official source and licence. How fresh: New South Wales, Australia: monthly; a month's lodgements are published in the first days of the next month; Queensland, Australia: quarterly; the RTA updates the workbook in April, July, October and January (the September quarter was published on 15 Oct 2026); Canada: annual: the October survey is released in the months after it (the October 2025 figures were released on 17 December 2025), and every answer states its survey month; Germany: static: the census date is 15 May 2022 (published 2024); the answer states that date and is not updated; Catalonia, Spain: quarterly; latest published quarter Q1 2026 (dataset updated 30 July 2026); Finland: quarterly; the newest quarter in the table on 22 Oct 2026 was 2026Q3; France: annual; the 2025 results were published in October 2026; England and Wales: monthly; each release adds a month about six weeks after it ends (the ONS labels these official statistics in development); Hong Kong: monthly, about 6 weeks after the month ends; the newest three months are provisional; Ireland: quarterly; a quarter is published about five months after it ends; Norway: annual; the 2025 survey was published on 22 December 2025; New Zealand: monthly; the files run about two months behind (the October 2026 files end in August 2026) and the latest month can still change; Portugal: quarterly, published about three months after the quarter ends (the 2nd Quarter 2026 figures were released on 29 September 2026); each answer states its quarter; Sweden: annual; the 2026 survey (rents at the start of 2026) was published on 2 October 2026; Sweden: annual; rents at 31 December 2025, published on 2 October 2026; Singapore public housing: monthly; the previous month's approvals appear in the first days of the next month; Taiwan: the Ministry publishes every 10 days (the 1st, 11th and 21st); a tenancy appears about one to two months after the contract date. Our collector re-reads the releases daily, and answers cover whole calendar months ending at least 30 days before the newest contract in the register. Do not use for asking rents or listings, holiday lets, commercial rent, rent for a specific address, home sale prices, or other countries.
Use this when a user asks what a university or college charges students per year (tuition or registration fees for a bachelor's or master's degree) in Canada (country CA), Europe (country BE), Europe (country BG), Europe (country CZ), Europe (country DK), Europe (country DE), Europe (country EE), Europe (country IE), Europe (country GR), Europe (country ES), Europe (country FR), Europe (country HR), Europe (country IT), Europe (country CY), Europe (country LV), Europe (country LT), Europe (country LU), Europe (country HU), Europe (country MT), Europe (country NL), Europe (country AT), Europe (country PL), Europe (country PT), Europe (country RO), Europe (country SI), Europe (country SK), Europe (country FI), Europe (country SE), Europe (country AL), Europe (country BA), Europe (country CH), Europe (country IS), Europe (country LI), Europe (country ME), Europe (country MK), Europe (country NO), Europe (country RS), Europe (country TR) or Taiwan (country TW), or how fees compare between countries or between home and international students. Returns the official statutory fee levels published for a country and academic year: the most common annual fee, the minimum and the maximum, in national currency with a euro equivalent. These are posted fee levels set by law or by universities, not what any one student paid and not a range built from sales: there is no sample size. How fresh: Canada: annual: one value per academic year (2026/2027 was published on 16 September 2026); every answer names its academic year; Europe: academic year 2023/24 (Eurydice release of September 2025); updated about once a year; Taiwan: annual: one value per academic year (the Ministry updates the file every October for the new year); every answer names its academic year. Fees are before grants, loans and fee waivers. Do not use for the price of one named course or university, living costs or rent, school fees, or countries that are not listed.
| Argument | Type | Description |
|---|---|---|
| cycle | string | Degree level: first = bachelor's (first cycle, the default), second = master's (second cycle). Also accepts bachelor, master, undergraduate, postgraduate. Canada, Statistics Canada: first = undergraduate (default), second = graduate (master's and doctorate). Europe, Eurydice: first = bachelor's (default), second = master's. Taiwan: first = bachelor's (the only level in the file). |
Use this when a user asks what the wholesale price of live pigs, cattle or chickens, fish, eggs or other fresh food is today in Australia (country AU), Canada (country CA), Germany (country DE), France (country FR), England and Wales (country GB), Hong Kong (country HK) or Malaysia (country MY), or how it moved on the previous day. Returns the newest daily average reference wholesale price that the government publishes for the food type, per kilogram or per egg, with the day it applies to, the change on the previous published day, the recent days, the official source and licence. This is a posted reference price reported by wholesalers (price_type posted_price), not a paid price and not a range built from sales, so the range fields are null and there is no sample size. How fresh: Australia: daily on trading days (MLA updates at midnight AEST); every answer states the trading day it describes; Canada: weekly (a Friday date); our copy is refreshed daily and each answer states the week its quotes apply to; Germany: weekly (calendar week); each answer states the week its price applies to; France: daily on market days (each market line carries its own date); each answer states the dates its quotes apply to; England and Wales: about every two weeks (a Monday date); each answer states the date its price applies to; Hong Kong: daily on working days, published by the AFCD when necessary; each answer states the day its price applies to; Malaysia: monthly, not live: the catalogue is refreshed after each month closes (catalogue last updated 10 October 2026 when checked); our copy is refreshed daily and every answer names its month. Do not use for supermarket or shop prices, for the price one farm received, for restaurant prices, for futures prices, or for other countries.
| Argument | Type | Description |
|---|---|---|
| level | string | Malaysia fish only: ex_vessel (the price fishers get at first sale at landing; default), wholesale or retail. |
| market |
Use this when a user asks what traders paid for vegetables or fruit (cabbage, tomatoes, cucumbers, onions, bananas, pineapples, guavas, melons, grapes...) at the wholesale produce markets of Taiwan (country TW), or what the price range at the wholesale market was this week. Returns a range built from the market's own daily trading records (median, 10th to 90th percentile, lowest and highest, number of records) for the newest few days, per kilogram, with the volume traded, the markets included and the official source and licence. A record is the average price of one variety at one market on one day. How fresh: daily, trading days only (a closed market publishes nothing). These are wholesale prices between traders, not what a shopper pays and not what a farmer receives. Do not use for supermarket or shop prices, for the price one farm received, for flowers, meat or fish, for futures prices, or for other countries.
| Argument | Type | Description |
|---|---|---|
| market | string | One wholesale market, only where the source publishes by market (for example a city name). Leave out for all markets together. TW: optional wholesale market: taipei, banqiao, sanchong, yilan, taoyuan, taichung, fengyuan, xihu, xiluo, chiayi, dongshi, kaohsiung, fengshan, pingtung, taitung, hualien, tainan, changhua (or the Taiwanese name such as 西螺). Leave out for all markets together. Not every market trades every product. |
| country* | string | TW = Taiwan (daily trading averages at the wholesale vegetable and fruit markets) |
| product* | string | The vegetable or fruit in plain words, e.g. 'cabbage', 'tomato', 'banana', 'pineapple'. The local-language name also works. The full list is in the tool notes. TW: required. Vegetable or fruit by English name or Taiwanese name, in NT$ per kg: cabbage, chinese cabbage, pak choi, water spinach, celery, cauliflower, broccoli, cucumber, luffa, bitter gourd, wax gourd, eggplant, tomato, cherry tomato, bell pepper, chili, green beans, peas, corn, radish, carrot, onion, spring onion, sweet potato, potato, taro, bean sprouts, gai lan, banana, pineapple, ponkan, orange, lemon, grapefruit, pomelo, watermelon, melon, papaya, guava, wax apple, grapes, apple, pear, persimmon, dragon fruit, avocado, kiwi, sugar apple, passion fruit, coconut. Imported produce is left out unless fewer than 5 domestic records exist. |
Use this when a user asks how wholesale electricity prices have changed over recent days or weeks in a country, or whether power is getting cheaper. Returns the daily median and typical range of hourly day-ahead prices in euro per MWh, with the change over the period, from our daily snapshots of official data. Do not use for household bills. After 10 free calls a day per caller this tool costs USD 0.02 per answered call, paid with x402 (USDC); a 402 reply lists how. Nothing is charged for "not enough records" or errors.
| Argument | Type | Description |
|---|---|---|
| days | integer | How many recent days to include. Default 30. |
| zone | string | Bidding zone, only where a country has more than one: DK = DK1 (west, default) or DK2 (east). IT answers northern Italy (IT-North), NO south-west Norway (NO2); other countries have one zone. |
| market | string | Which wholesale market. Only day-ahead (the next-day hourly auction) is available. AU: spot only (AEMO's five-minute regional price), not day-ahead; leave it out. DE: day-ahead only (the hourly auction held the day before delivery). ES/PT: day-ahead only (the auction held the day before delivery). AT/BE/DK/FR/IT/NL/NO/PL: day-ahead only (the auction held the day before delivery). GB: the half-hourly spot market index (traded prices); the day-ahead option is not used. Prices are in pounds, not euro. |
| months | integer | Instead of days: how many whole months of monthly history to return, where a source has loaded long history. |
| region |
Use this when a user asks what electricity costs on the wholesale (day-ahead power exchange) market in Australia, Germany, Spain and Portugal, Austria, Belgium, Denmark, France, northern Italy, the Netherlands, south-west Norway and Poland or Great Britain: the recent median, the typical range across hours, the cheapest and dearest hour, the latest hour and how many hours had negative prices. Prices are in euro per MWh (1 MWh = 1000 kWh; the answer also gives cents per kWh). Built from the hourly auction prices of the recent days, with the official source and licence. How fresh: Australia: AEMO publishes one price file per trading day (04:00 to 04:00 NEM time) early the next morning; ProofPrice reads the files of the last days on each request (cached up to 30 minutes); Germany: hourly prices, published the day before delivery (around 13:00 Central European Time); ProofPrice reads them on each request (cached up to 30 minutes); Spain and Portugal and Austria, Belgium, Denmark, France, northern Italy, the Netherlands, south-west Norway and Poland: prices are published the day before delivery (around 13:00 Central European Time); ProofPrice reads them on each request (cached up to 30 minutes); Great Britain: half-hourly prices appear within hours of each trading period and are read on each request (cached up to 30 minutes). Wholesale prices are not what households or businesses pay on their bills. Do not use for retail tariffs, for petrol and diesel, or for other countries.
| Argument | Type | Description |
|---|---|---|
| zone | string | Bidding zone, only where a country has more than one: DK = DK1 (west, default) or DK2 (east). IT answers northern Italy (IT-North), NO south-west Norway (NO2); other countries have one zone. |
| market | string | Which wholesale market. Only day-ahead (the next-day hourly auction) is available. AU: spot only (AEMO's five-minute regional price), not day-ahead; leave it out. DE: day-ahead only (the hourly auction held the day before delivery). ES/PT: day-ahead only (the auction held the day before delivery). AT/BE/DK/FR/IT/NL/NO/PL: day-ahead only (the auction held the day before delivery). GB: the half-hourly spot market index (traded prices); the day-ahead option is not used. Prices are in pounds, not euro. |
| months | integer | How many recent months of auctions to include. Default 12. CA: rounded to the nearest of 6, 12 or 24. |
| country* | string | CA = Canada (Government of Canada surplus sold through GCSurplus); FR = France; US = United States |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country",
"what"
],
"properties": {
"what": {
"type": "string",
"minLength": 2,
"description": "Lot type: a group name or words from the lot title, such as 'vehicles', 'heavy equipment', 'office furniture' or 'forklift'. CA: one of vehicles, heavy-equipment, electronics, office-furniture, boats, tools-machinery, or a word such as 'truck', 'laptop', 'forklift', 'desk'. FR: 'cars', 'vans', 'motorbikes', 'bicycles', 'computers', 'furniture', 'jewellery', 'wine', or words from the brand, model or description ('renault clio')."
},
"state": {
"type": "string",
"description": "Optional region to narrow to, see the country notes below. CA: province or territory, name or two-letter code ('ON', 'Quebec'). Omit for all of Canada. FR: the auction house city (CAV) such as 'Lyon', 'Marseille' or 'Toulouse'. The data is the 2024 file of French state auctions (seized, impounded and court sales). US: two-letter state or territory code ('TX'). The auctions are US federal surplus and seized goods."
},
"months": {
"type": "integer",
"maximum": 24,
"minimum": 1,
"description": "How many recent months of auctions to include. Default 12. CA: rounded to the nearest of 6, 12 or 24."
},
"country": {
"enum": [
"CA",
"FR",
"US"
],
"type": "string",
"description": "CA = Canada (Government of Canada surplus sold through GCSurplus); FR = France; US = United States"
}
}
}| partner | string | Optional partner country (ISO code such as 'DE' or 'US', or its name): where the goods came from (imports) or went to (exports). Leave out for all partners. GB: optional partner country, as an ISO code (DE, US, CN, FR, NL, IE ...) or HMRC's country name. |
| product* | string | The goods: an everyday word such as 'wheat', 'diesel', 'cheese', 'timber', 'steel', 'whisky', or a customs commodity code (HS/CN) of 4 to 8 digits such as '1001' or '271019'. GB: an everyday word (diesel, petrol, crude oil, wheat, barley, maize, rice, sugar, coffee, tea, cocoa, apples and more) or a customs commodity code of 4 to 8 digits (HS/CN, e.g. 1001 wheat, 2710 19 diesel, 0406 cheese). A code groups different products, so the average depends on the mix. |
| direction | string | Goods coming in (imports, default) or going out (exports). GB: imports (default) or exports, as the UK reports them (EU and non-EU trade combined). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country",
"product"
],
"properties": {
"months": {
"type": "integer",
"maximum": 12,
"minimum": 1,
"description": "How many months to include, ending with the period. Default 1. More months smooth out lumpy shipments. GB: months to include, 1 to 12 (default 1)."
},
"period": {
"type": "string",
"description": "Optional last month to include, as YYYY-MM. Default: the newest month the customs authority has published. GB: the last month to include (YYYY-MM). HMRC publishes about six weeks after the month ends; default is the newest published month."
},
"country": {
"enum": [
"GB"
],
"type": "string",
"description": "GB = United Kingdom (HMRC Overseas Trade Statistics: customs value per kilogram of goods imported or exported, by customs commodity code and partner country, monthly)"
},
"partner": {
"type": "string",
"description": "Optional partner country (ISO code such as 'DE' or 'US', or its name): where the goods came from (imports) or went to (exports). Leave out for all partners. GB: optional partner country, as an ISO code (DE, US, CN, FR, NL, IE ...) or HMRC's country name."
},
"product": {
"type": "string",
"description": "The goods: an everyday word such as 'wheat', 'diesel', 'cheese', 'timber', 'steel', 'whisky', or a customs commodity code (HS/CN) of 4 to 8 digits such as '1001' or '271019'. GB: an everyday word (diesel, petrol, crude oil, wheat, barley, maize, rice, sugar, coffee, tea, cocoa, apples and more) or a customs commodity code of 4 to 8 digits (HS/CN, e.g. 1001 wheat, 2710 19 diesel, 0406 cheese). A code groups different products, so the average depends on the mix."
},
"direction": {
"enum": [
"imports",
"exports"
],
"type": "string",
"description": "Goods coming in (imports, default) or going out (exports). GB: imports (default) or exports, as the UK reports them (EU and non-EU trade combined)."
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country"
],
"properties": {
"offer": {
"type": "string",
"description": "Which standard offer. Friendly names such as fixed_100_200 (fixed internet 100-200 Mbps, the default), fixed_30_100, fixed_1gbps, mobile_10gb, mobile_unlimited, or a publisher code. The country notes list them. EU, Eurostat: the cheapest posted offer of the largest operators, PPP euro per month. Names: fixed_lt12 (FI_MBPS_LT12), fixed_30_100 (FI_MBPS30-100), fixed_100_200 (FI_MBPS100-200), fixed_200_999 (FI_MBPS200-999), fixed_1gbps (FI_GBPS_GE1), fixed_100_200_phone (FI_MBPS100-200_P), fixed_100_200_phone_tv (FI_MBPS100-200_PTV), mobile_1gb (MI_GB1_NC), mobile_2gb (MI_GB2_NC), mobile_5gb (MI_GB5_NC), mobile_10gb (MI_GB10_NC), mobile_20gb (MI_GB20_NC), mobile_50gb (MI_GB50_NC), mobile_unlimited (MI_NLTD_NC). Any Eurostat offer code also works, e.g. FI_MBPS30-100_PTV (fixed 30-100 Mbps with phone and TV). Default fixed_100_200."
},
"country": {
"enum": [
"AT",
"BE",
"BG",
"HR",
"CY",
"CZ",
"DK",
"EE",
"FI",
"FR",
"DE",
"GR",
"HU",
"IE",
"IT",
"LV",
"LT",
"LU",
"MT",
"NL",
"PL",
"PT",
"RO",
"SK",
"SI",
"ES",
"SE"
],
"type": "string",
"description": "EU member states as ISO codes (GR for Greece): AT = Austria, BE = Belgium, BG = Bulgaria, HR = Croatia, CY = Cyprus, CZ = Czechia, DK = Denmark, EE = Estonia, FI = Finland, FR = France, DE = Germany, GR = Greece, HU = Hungary, IE = Ireland, IT = Italy, LV = Latvia, LT = Lithuania, LU = Luxembourg, MT = Malta, NL = Netherlands, PL = Poland, PT = Portugal, RO = Romania, SK = Slovakia, SI = Slovenia, ES = Spain, SE = Sweden"
}
}
}| cpv | string | number | Parameter of the category (same name and meaning as in its own tool). contracts: Optional official product code, to be exact, where the source uses one (the country notes say which code system), e.g. the CPV code 30213100 for portable computers; a prefix such as 3021 covers the wh |
| tax | string | number | Parameter of the category (same name and meaning as in its own tool). fuel: EU Weekly Oil Bulletin countries only: 'with' (default) = the pump price with all duties and taxes; 'without' = the Commission's price net of duties and taxes (VAT and excise removed), the basis many |
| area | string | number | Parameter of the category (same name and meaning as in its own tool). childcare: Place: a county, a region, a local authority, or a state or city where the source says so (examples: 'Cook County, IL', 'London', 'Dublin'). Leave out for the whole country, where the source has a nat | construction: State or region, where the publisher splits by place (the country notes say how). Leave out for the national figure. BR: state name or two-letter code ('São Paulo', 'SP', 'Bahia', 'RJ'); leave out for | fuel: Wider area when no postcode. AU (Queensland only): 'Brisbane' (postcodes 4000 to 4179) or 'QLD' (the whole state). A suburb name also works. BR: state as a two-letter code or name ('SP', 'Minas Gerais | health-insurance: Region (see the country notes), e.g. a canton code such as 'ZH'. Leave out for the whole country. CH: a canton code (AG, AI, AR, BE, BL, BS, FR, GE, GL, GR, JU, LU, NE, NW, OW, SG, SH, SO, SZ, TG, TI, | home-upgrades: Place, only where the publisher splits by place (the country notes say how). Leave out for the national figure. GB: national figures only; an area is ignored and the answer says so. IE: a county (Kerr | hotels: Region, province or city inside the country, in plain words (for example 'Madrid', 'Andalucia', 'Benidorm'). Leave out for the national average. ES: optional. A region ('Andalucia', 'Cataluña', 'Madri | insurance: Place: a 5-digit ZIP code or a state code, depending on the country notes (examples: '32935', 'TX'). Required. US: required. A 5-digit ZIP code ('32935') or a 2-letter state or territory code ('TX', ' |
| from | string | number | Parameter of the category (same name and meaning as in its own tool). flights: Where the flight starts: an airport code (JFK, LAX) or a city (Chicago, 'Portland, OR'). Required. AU: city or airport code (Sydney, SYD, 'Gold Coast', OOL). Required, and AU also needs 'to'. US: airp |
| fuel | string | number | Parameter of the category (same name and meaning as in its own tool). fuel: petrol95 = unleaded 95; methane = CNG (priced per kg). Queensland: diesel, petrol95 (= standard Unleaded, 91 RON), petrol98, e10, e85 or lpg. Brazil: petrol95 = regular petrol (gasolina comum, not RON |
| item | string | number | Parameter of the category (same name and meaning as in its own tool). groceries: Everyday item in plain words, e.g. 'milk', 'white bread', 'eggs', 'butter', 'coffee', 'bananas', 'beer'. Each country measures its own standard pack or cut; the answer names it and lists other definit |
| town | string | number | Parameter of the category (same name and meaning as in its own tool). commercial-property: Town or city. FR: town, e.g. 'Bordeaux', or use postcode. TW: a city or county in English or Chinese ('Taipei', 'New Taipei', 'Taichung', 'Kaohsiung', '臺北市'), or a district with its city ("Zhongshan, | fuel: Town name. AU (Queensland only): suburb name, e.g. 'Mount Gravatt'. Small suburbs may have fewer than 5 stations. BR: municipality, e.g. 'São Paulo' or 'Curitiba'; add area when the name exists in sev | home-sales: Town or city. AT: a municipality among the 100 largest ('Wien' / 'Vienna', 'Graz', 'Linz', 'Salzburg', 'Innsbruck'), a district ('Wien 2' for Leopoldstadt, 'Bezirk Baden', 'Kitzbühel'), or a Bundeslan | rent: Town, city or local area. AU: use 'NSW' for the whole state; otherwise give a postcode (NSW rents are published by postcode). AU (Queensland): give a four-digit postcode; the RTA publishes by postcode |
| unit | string | What the price is per, for example 'per month', 'per litre', 'per home'. Defaults to the evidence unit. A different unit gives cannot_judge. |
| what | string | number | Parameter of the category (same name and meaning as in its own tool). contracts: What was bought, in plain words: 'laptops', 'school meals', 'road resurfacing', 'office cleaning', 'electricity', 'ambulances', 'waste collection'. Common purchases are matched to official product cod | surplus-auctions: Lot type: a group name or words from the lot title, such as 'vehicles', 'heavy equipment', 'office furniture' or 'forklift'. CA: one of vehicles, heavy-equipment, electronics, office-furniture, boats, |
| year | string | number | Parameter of the category (same name and meaning as in its own tool). diet-costs: Year of the estimate (2017 onwards). Leave out for the newest year the World Bank holds. World Bank: 2017 to the newest year held (2025 at the last check). Leave out for the newest year. |
| zone | string | number | Parameter of the category (same name and meaning as in its own tool). wholesale-power: Bidding zone, only where a country has more than one: DK = DK1 (west, default) or DK2 (east). IT answers northern Italy (IT-North), NO south-west Norway (NO2); other countries have one zone. |
| cycle | string | number | Parameter of the category (same name and meaning as in its own tool). tuition: Degree level: first = bachelor's (first cycle, the default), second = master's (second cycle). Also accepts bachelor, master, undergraduate, postgraduate. Canada, Statistics Canada: first = undergradu |
| hours | string | number | Parameter of the category (same name and meaning as in its own tool). childcare: Full-time or part-time care, where a source publishes both. Most sources publish one basis only and say which. GB: ignored; fees are per hour, with no full-time or part-time split. IE: ignored; the ta |
| level | string | number | Parameter of the category (same name and meaning as in its own tool). wholesale-fresh-food: Malaysia fish only: ex_vessel (the price fishers get at first sale at landing; default), wholesale or retail. |
| model | string | number | Parameter of the category (same name and meaning as in its own tool). health-insurance: standard = free choice of doctor (default); alternative = family-doctor, telemedicine or HMO models with a restricted choice. |
| offer | string | number | Parameter of the category (same name and meaning as in its own tool). broadband: Which standard offer. Friendly names such as fixed_100_200 (fixed internet 100-200 Mbps, the default), fixed_30_100, fixed_1gbps, mobile_10gb, mobile_unlimited, or a publisher code. The country notes |
| price* | number | The price to check, as a number above zero (for example 2400 or 1.95), in the unit and currency below. |
| rooms | string | number | Parameter of the category (same name and meaning as in its own tool). rent: NO only: number of rooms (living rooms plus bedrooms), 1 to 5 (5 means five or more). Required for Norway. |
| spend | string | number | Parameter of the category (same name and meaning as in its own tool). price-levels: What kind of spending: leave out for all household consumption, or give 'food', 'meat', 'dairy', 'bread and cereals', 'fruit', 'vegetables', 'alcohol', 'tobacco', 'clothing', 'housing' (rent, water, e |
| stars | string | number | Parameter of the category (same name and meaning as in its own tool). hotels: Hotel star category (1 to 5), for sources that publish it. Only national figures are split by stars; do not combine with area. ES: optional, 1 to 5 hotel stars. INE publishes star categories for Spain |
| state | string | number | Parameter of the category (same name and meaning as in its own tool). energy: US only: the state, by name or postal code ('Texas', 'TX', 'DC'). Leave out for the U.S. average. Gas: EIA publishes no figure for a few states in recent months, then the newest published month is ret | home-sales: US only: 'CT' (Connecticut), 'NY' (New York City) or 'IL' (Cook County). Usually inferred from the place; set it when a name exists in two of them. | medical: A state or territory, where the source publishes one (the country notes say how to write it). Leave out for the national average. Singapore: the ward class, because Singapore has no states: c = public | surplus-auctions: Optional region to narrow to, see the country notes below. CA: province or territory, name or two-letter code ('ON', 'Quebec'). Omit for all of Canada. FR: the auction house city (CAV) such as 'Lyon', |
| taxes | string | number | Parameter of the category (same name and meaning as in its own tool). energy: Tax level of the price. 'all' = all taxes and levies included (what a household pays, default); 'excl_vat' = excluding VAT and other recoverable taxes; 'none' = excluding all taxes and levies. BR: not |
| canton | string | number | Parameter of the category (same name and meaning as in its own tool). energy: CH only: canton by two-letter code, for example 'ZH', 'GE', 'VD', 'TI'. Leave out for Switzerland as a whole. |
| county | string | number | Parameter of the category (same name and meaning as in its own tool). home-sales: IE only: same as town; a county such as 'Dublin' or 'Cork'. |
| energy | string | number | Parameter of the category (same name and meaning as in its own tool). energy: electricity or gas (natural gas). BR: electricity only (no gas). The figure is the regulated residential tariff (TE energy + TUSD network) before taxes and flag surcharges, as a posted price. CH: elec |
| market | string | number | Parameter of the category (same name and meaning as in its own tool). wholesale-fresh-food: CA only: one wholesale centre (Calgary, Edmonton, Vancouver or Winnipeg). Leave out for all centres together. AAFC does not quote every centre every week (the latest file has only Calgary and Winnipeg | wholesale-markets: One wholesale market, only where the source publishes by market (for example a city name). Leave out for all markets together. TW: optional wholesale market: taipei, banqiao, sanchong, yilan, taoyuan, | wholesale-power: Which wholesale market. Only day-ahead (the next-day hourly auction) is available. AU: spot only (AEMO's five-minute regional price), not day-ahead; leave it out. DE: day-ahead only (the hourly auctio |
| months | string | number | Parameter of the category (same name and meaning as in its own tool). border-prices: How many months to include, ending with the period. Default 1. More months smooth out lumpy shipments. GB: months to include, 1 to 12 (default 1). | cars: How many recent months to include. Default 12. | commercial-property: How many recent months to include. Default 24. TW: 12 or 24 whole calendar months; up to 18 gives 12 (24 if a place has too few sales in 12), more gives 24. | contracts: How many recent months of awards to include. Default 24. AU: not used; the newest 21 days of notices are read. CA: not used; each figure covers the newest 24 months of awards. CO: not used; each figur | home-sales: How many recent months to include. Default 12. AT: ignored; STATISTIK AUSTRIA publishes one figure per calendar year (the latest is returned). AU: not used; the ABS publishes one mean price per quarte | rent: How many recent months to include, for sources that hold individual rents. Ignored by sources that publish one figure per quarter or month. AU: 3 or 12 (anything up to 4 uses the latest 3 months, long | surplus-auctions: How many recent months of auctions to include. Default 12. CA: rounded to the nearest of 6, 12 or 24. |
| period | string | number | Parameter of the category (same name and meaning as in its own tool). border-prices: Optional last month to include, as YYYY-MM. Default: the newest month the customs authority has published. GB: the last month to include (YYYY-MM). HMRC publishes about six weeks after the month ends; |
| region | string | number | Parameter of the category (same name and meaning as in its own tool). energy: NZ only: electricity network region, for example 'Auckland', 'Wellington', 'Christchurch', 'Dunedin'. Leave out for the unweighted median across all regions. | farm-gate-prices: Region inside the country, as the statistics office publishes it (for example a province or state). Some countries publish no national figure, so the answer then asks for a region. Canada: a province | groceries: Region inside the country, only where the statistics office publishes regional averages. Leave out for the national average. Canada: leave out for the Canada average, or give a province (Ontario, BC, | land-prices: Optional region code for a regional figure, where the source publishes one (the country notes say which codes). Leave out for the whole country. EU/NO, optional. A NUTS region code (Eurostat's regiona | wholesale-power: AU only: NEM region NSW1 (New South Wales incl. ACT, default), QLD1, SA1, TAS1 or VIC1; short names like NSW, VIC or Queensland also work. |
| season | string | number | Parameter of the category (same name and meaning as in its own tool). energy: TW only: 'non_summer' (default) or 'summer' rates (Taipower charges more in summer). |
| sector | string | number | Parameter of the category (same name and meaning as in its own tool). energy: Whose price: 'household' (default: what homes pay) or 'business' (non-household consumers: what companies, shops, offices and factories pay; official average by annual-consumption band). Leave out for |
| country* | string | ISO country code of the place (for example IE, GB, FR). Which countries a category covers: see pricepaid_coverage. |
| faculty | string | number | Parameter of the category (same name and meaning as in its own tool). tuition: Taiwan only: faculty group (medicine, dentistry, medical_college, engineering, science_agri, business, humanities_law, other). Default humanities_law. Words like law, business, engineering, medicine, |
| measure | string | number | Parameter of the category (same name and meaning as in its own tool). home-upgrades: The upgrade: heat_pump, solar_pv, attic_insulation, wall_insulation, windows, or renovation (any home renovation works, where the publisher does not split by type). Plain words such as 'heat pump' or | land-prices: price = what agricultural land sells for per hectare; rent = what it costs to rent per hectare for one year. EU/NO: price = average sale price of agricultural land per hectare (Eurostat apri_lprc); re |
| partner | string | number | Parameter of the category (same name and meaning as in its own tool). border-prices: Optional partner country (ISO code such as 'DE' or 'US', or its name): where the goods came from (imports) or went to (exports). Leave out for all partners. GB: optional partner country, as an ISO cod |
| product | string | number | Parameter of the category (same name and meaning as in its own tool). border-prices: The goods: an everyday word such as 'wheat', 'diesel', 'cheese', 'timber', 'steel', 'whisky', or a customs commodity code (HS/CN) of 4 to 8 digits such as '1001' or '271019'. GB: an everyday word (die | cars: Which price. 'coe' = Certificate of Entitlement bidding results (the country notes say where it exists). Default 'coe'. SG: 'coe'. | farm-gate-prices: The crop or animal product, e.g. 'wheat', 'barley', 'oats', 'canola', 'soybeans', 'corn', 'potatoes', 'cattle', 'hogs', 'lambs', 'chickens', 'milk', 'eggs'. The full list is in the tool notes. Canada: | farm-prices: The product, e.g. 'wheat', 'barley', 'beef', 'pig', 'lamb', 'chicken', 'eggs', 'milk', 'butter', 'olive oil', 'tomatoes', 'apples'. The full list is in the tool notes. EU: required. The product, by na | producer-prices: The crop or animal product, e.g. 'wheat', 'maize', 'rice', 'soybeans', 'potatoes', 'tomatoes', 'apples', 'bananas', 'beef', 'pork', 'chicken', 'eggs', 'milk', 'coffee', 'cotton'. US, CA, BR, MX, AU, N | wholesale-fresh-food: The food in plain words, e.g. 'live pig', 'chicken', 'eggs', 'grass carp', 'tomato'. The list for each country is in the tool notes. Australia: cattle or sheep in everyday words, e.g. cattle, western | wholesale-markets: The vegetable or fruit in plain words, e.g. 'cabbage', 'tomato', 'banana', 'pineapple'. The local-language name also works. The full list is in the tool notes. TW: required. Vegetable or fruit by Engl |
| service | string | number | Parameter of the category (same name and meaning as in its own tool). fuel: Self-service or attended service, where a country prices them differently. Ontario: not used (the survey does not split self and full service). Canada: self only. Full-service prices stopped in 2013. | medical: The medical service: plain words ('office visit', 'MRI lower back', 'knee replacement'), a billing code or a hospital-stay group code, as the country notes list them. Required. Singapore: a medical co |
| setting | string | number | Parameter of the category (same name and meaning as in its own tool). medical: office = a doctor's office (whole service); facility = hospital outpatient or surgery centre (doctor's fee only); inpatient = a hospital stay. Leave out to use the usual setting for the service. Singa |
| size_kw | string | number | Parameter of the category (same name and meaning as in its own tool). home-upgrades: GB solar_pv: system size in kW; picks the DESNZ size band (0-4, 4-10 or 10-50 kW). Default: the 0-4 kW band. |
| tenancy | string | number | Parameter of the category (same name and meaning as in its own tool). rent: FR only: all leases (default), new = leases signed in the last year (what a new tenant faces), existing = leases of one year or more. New leases are published per dwelling type, not per size. |
| accident | string | number | Parameter of the category (same name and meaning as in its own tool). health-insurance: Whether accident cover is included in the premium. Default: without for adults and young adults, with for children. |
| bedrooms | string | number | Parameter of the category (same name and meaning as in its own tool). rent: Number of bedrooms (0 = studio). Leave out for all sizes. AU: 0 (studio), 1, 2, 3 or 4 (4 means four or more). AU (Queensland): flats 1-3, houses 2-4, townhouses 2-3. With no type and no bedrooms the |
| category* | string | Which kind of price: border-prices, broadband, cars, childcare, commercial-property, construction, contracts, diet-costs, energy, farm-gate-prices, farm-prices, flights, fuel, groceries, health-insurance, home-sales, home-upgrades, hotels, insurance, land-prices, medical, medicines, price-levels, producer-prices, rent, surplus-auctions, tuition, wholesale-fresh-food, wholesale-markets and wholesale-power (the REST path or the tool name also works). |
| currency | string | ISO 4217 currency code of the price (for example EUR). Defaults to the evidence currency. A different currency gives cannot_judge: ProofPrice never converts. |
| district | string | number | Parameter of the category (same name and meaning as in its own tool). home-sales: GB only: local authority (council area or London borough) as the Land Registry records it, e.g. 'Camden', 'City of Bristol', 'South Gloucestershire'. Use it instead of town for a London borough or whe |
| includes | string | What the price includes or excludes, as free text (for example 'VAT included, delivery excluded'). Echoed back as a caution; it is not used to adjust the figure. |
| medicine | string | number | Parameter of the category (same name and meaning as in its own tool). medicines: Medicine brand or active-substance name, e.g. 'doliprane' or 'paracetamol'. Only the first word is used. ES: Spanish active-ingredient or brand name, first word used ('paracetamol', 'ibuprofeno', 'ome |
| postcode | string | number | Parameter of the category (same name and meaning as in its own tool). commercial-property: Postcode, for a precise area. FR: 5-digit postcode, e.g. '33000'; use instead of town for a precise area. TW: not supported (the register has no postcodes); give the city, county or district as town. | fuel: Postcode of the place. AU (Queensland only): 4-digit postcode starting with 4, e.g. '4122'. Most single postcodes have fewer than 5 stations of one fuel; use area 'Brisbane' or 'QLD' then. BR: not use | home-sales: Postcode, for a precise area. AT: only Vienna postcodes (1010 to 1230) are matched, to the Vienna district; elsewhere give the town or district as town. AU: a 4-digit postcode ('2150'), answered with | rent: Postcode, for a precise area. AU: a four-digit NSW postcode, e.g. 2000 (Sydney CBD), 2150 (Parramatta), 2500 (Wollongong). AU (Queensland): a four-digit postcode, e.g. 4000 (Brisbane city), 4217 (Surf |
| province | string | number | Parameter of the category (same name and meaning as in its own tool). tuition: Canada only: a province (Ontario, Quebec, BC, Alberta ...) or leave out for the Canada average. Yukon is mostly not published; the other territories are not in the table. |
| quarters | string | number | Parameter of the category (same name and meaning as in its own tool). flights: How many recent quarters to include in the trend (default 4, at most 20). The headline figure is always the latest quarter. AU: the range covers this many quarters of monthly fares (default 4 = 12 mon |
| age_group | string | number | Parameter of the category (same name and meaning as in its own tool). childcare: Age of the child: infant (under 2), toddler (2), preschool (3 to 4 or until school), school-age. Each source says how it defines them. Leave out for the source's default (see the answer). GB: infant ( | health-insurance: Age group: adult (26+, default), young_adult (19-25) or child (0-18). |
| care_type | string | number | Parameter of the category (same name and meaning as in its own tool). childcare: centre = nursery, daycare or group-based setting; home-based (also childminder) = a registered provider caring in their own home. Leave out for centres or for all providers, as the source says. GB: ce |
| community | string | number | Parameter of the category (same name and meaning as in its own tool). tuition: BE only: the higher-education system, because Belgium has three with different fees: fr (French Community), nl (Flemish Community) or de (German-speaking Community). |
| component | string | number | Parameter of the category (same name and meaning as in its own tool). construction: Which part of the cost: total (default), material (building materials) or labour (wages). BR: total (default) = average cost per m2; material = materials part; labour = labour part. All in BRL per m2, |
| direction | string | number | Parameter of the category (same name and meaning as in its own tool). border-prices: Goods coming in (imports, default) or going out (exports). GB: imports (default) or exports, as the UK reports them (EU and non-EU trade combined). |
| flat_type | string | number | Parameter of the category (same name and meaning as in its own tool). home-sales: SG only: HDB flat type. | rent: SG only: HDB flat type, one of 1-ROOM, 2-ROOM, 3-ROOM, 4-ROOM, 5-ROOM, EXECUTIVE ('4 ROOM' also works). Leave out for all types. |
| franchise | string | number | Parameter of the category (same name and meaning as in its own tool). health-insurance: Annual deductible in local currency; the values available depend on the country notes. Default: the lowest one for the age group. CH: adults and young adults 300, 500, 1000, 1500, 2000 or 2500 CHF; ch |
| gb_region | string | number | Parameter of the category (same name and meaning as in its own tool). energy: GB only: Ofgem region (North Western England, North Eastern England, Yorkshire, Northern Scotland, Southern England, Southern Scotland, Merseyside and Northern Wales, London, South Eastern England, Ea |
| land_type | string | number | Parameter of the category (same name and meaning as in its own tool). land-prices: Land type, e.g. 'arable', 'permanent grassland', 'arable or grassland' (rent only), 'irrigable arable' (price only). Leave out for the usual one. EU/NO, optional. For price: "arable" = Arable land; "p |
| new_build | string | number | Parameter of the category (same name and meaning as in its own tool). rent: SE only: true = rents of newly built rented flats (built from 2022) instead of the all-flats rent survey. |
| ownership | string | number | Parameter of the category (same name and meaning as in its own tool). tuition: Taiwan only: public or private institutions (default both). |
| buyer_area | string | number | Parameter of the category (same name and meaning as in its own tool). contracts: Optional region or city to narrow to, see the country notes below. AU: part of a federal agency's name ('Defence', 'Health', 'Parliamentary Services'); contracts have no delivery place. CA: not used; |
| compare_to | string | number | Parameter of the category (same name and meaning as in its own tool). price-levels: What the index is measured against, as a short name of a comparison area. Leave out for the default; the allowed values are listed in the notes for the country. OECD: 'OECD' (default, OECD average = 1 |
| flat_class | string | number | Parameter of the category (same name and meaning as in its own tool). rent: HK only: RVD flat class by saleable area, A (under 40 m²), B (40–69.9), C (70–99.9), D (100–159.9) or E (160 and over). Default B. |
| food_group | string | number | Parameter of the category (same name and meaning as in its own tool). diet-costs: Which part of the healthy diet: leave out for the whole diet, or give 'fruit', 'vegetables', 'animal foods', 'legumes and nuts', 'oils and fats' or 'starchy staples'. The World Bank leaves some group |
| house_type | string | number | Parameter of the category (same name and meaning as in its own tool). rent: Kind of house, for sources that publish houses by type (needed with property_type house there). CA: not used (houses are not published). DE: not used. GB: detached, semi-detached or terraced; required |
| settlement | string | number | Parameter of the category (same name and meaning as in its own tool). home-sales: HU only: type of settlement inside a region: all (default), county_seat, towns or villages. Budapest has one figure. |
| study_mode | string | number | Parameter of the category (same name and meaning as in its own tool). tuition: full-time (the default) or part-time. Canada: full-time only (the default). Europe, Eurydice: full-time (default) or part-time. Taiwan: full-time day programmes only (the default). |
| technology | string | number | Parameter of the category (same name and meaning as in its own tool). home-upgrades: GB heat_pump: air_to_water (default), ground_source or biomass_boiler. |
| distributor | string | number | Parameter of the category (same name and meaning as in its own tool). energy: BR only: the electricity distributor by ANEEL short name, for example 'CEMIG-D', 'ENEL SP', 'LIGHT', 'COPEL-DIS'. Leave out for the median of all distributors. |
| school_type | string | number | Parameter of the category (same name and meaning as in its own tool). tuition: Taiwan only: university (general universities) or technical (technical and vocational colleges); default both. |
| dwelling_type | string | number | Parameter of the category (same name and meaning as in its own tool). home-upgrades: Type of dwelling or job, only where the publisher splits by it (the country notes say which values). Leave out for the publisher's main figure. GB solar_pv: leave out for all small installations (medi |
| lookback_days | string | number | Parameter of the category (same name and meaning as in its own tool). wholesale-power: How many recent days of hourly prices to include. Default 7, at most 14. AU: 1 to 7 trading days of five-minute prices (default 3); each five-minute interval counts as one record. Prices are in Austra |
| property_type | string | number | Parameter of the category (same name and meaning as in its own tool). commercial-property: commercial = shops, offices, workshops and other commercial or industrial premises (default); land = building plots and other non-farm land sold without a building. FR: commercial (default) or land. A | home-sales: Kind of home. Default 'any'. AT: house or apartment (flats). The figure is the price per m² of living area. With no type given the headline is the flat figure and both medians are in extra.by_type. Th | rent: Kind of home: apartment (same as flat), house or room. Default 'any'. AU: apartment (flat or unit), house (includes terraces, townhouses and semi-detached) or any. Rooms are not published. AU (Queensl |
| student_group | string | number | Parameter of the category (same name and meaning as in its own tool). tuition: Who pays: home (nationals and EU students who pay home fees, the default), international (students from outside the EU/EEA), non-state-subsidised (self-financed places), specific-discipline (for examp |
| vehicle_class | string | number | Parameter of the category (same name and meaning as in its own tool). cars: SG only: COE category. A = cars up to 1600cc (default), B = cars above 1600cc, C = goods vehicles/buses, D = motorcycles, E = open. |
| gasoline_grade | string | number | Parameter of the category (same name and meaning as in its own tool). fuel: US only: the gasoline grade EIA publishes. Overrides the grade implied by fuel (petrol95 = regular, petrol98 = premium); use midgrade here with fuel=petrol95. Not for diesel. |
| payment_method | string | number | Parameter of the category (same name and meaning as in its own tool). energy: GB only: direct_debit (default), standard_credit (pay on receipt of the bill) or prepayment (prepayment meter). |
| consumption_band | string | number | Parameter of the category (same name and meaning as in its own tool). energy: Standard consumption band (household bands, or the business bands when sector=business), by letter or by the publisher's code (the country notes list them). Leave out for the standard band. BR: not us |
| postcode_district | string | number | Parameter of the category (same name and meaning as in its own tool). home-sales: GB only: postcode district such as 'BS8' to narrow the area. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"category",
"country",
"price"
],
"properties": {
"to": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). flights: Where it ends: an airport code or a city. Leave out to get the average fare over the busiest routes out of the 'from' city. AU: city or airport code. Required for AU (the answer is for one route, eith"
},
"cpv": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). contracts: Optional official product code, to be exact, where the source uses one (the country notes say which code system), e.g. the CPV code 30213100 for portable computers; a prefix such as 3021 covers the wh"
},
"tax": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). fuel: EU Weekly Oil Bulletin countries only: 'with' (default) = the pump price with all duties and taxes; 'without' = the Commission's price net of duties and taxes (VAT and excise removed), the basis many "
},
"area": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). childcare: Place: a county, a region, a local authority, or a state or city where the source says so (examples: 'Cook County, IL', 'London', 'Dublin'). Leave out for the whole country, where the source has a nat | construction: State or region, where the publisher splits by place (the country notes say how). Leave out for the national figure. BR: state name or two-letter code ('São Paulo', 'SP', 'Bahia', 'RJ'); leave out for | fuel: Wider area when no postcode. AU (Queensland only): 'Brisbane' (postcodes 4000 to 4179) or 'QLD' (the whole state). A suburb name also works. BR: state as a two-letter code or name ('SP', 'Minas Gerais | health-insurance: Region (see the country notes), e.g. a canton code such as 'ZH'. Leave out for the whole country. CH: a canton code (AG, AI, AR, BE, BL, BS, FR, GE, GL, GR, JU, LU, NE, NW, OW, SG, SH, SO, SZ, TG, TI, | home-upgrades: Place, only where the publisher splits by place (the country notes say how). Leave out for the national figure. GB: national figures only; an area is ignored and the answer says so. IE: a county (Kerr | hotels: Region, province or city inside the country, in plain words (for example 'Madrid', 'Andalucia', 'Benidorm'). Leave out for the national average. ES: optional. A region ('Andalucia', 'Cataluña', 'Madri | insurance: Place: a 5-digit ZIP code or a state code, depending on the country notes (examples: '32935', 'TX'). Required. US: required. A 5-digit ZIP code ('32935') or a 2-letter state or territory code ('TX', '"
},
"from": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). flights: Where the flight starts: an airport code (JFK, LAX) or a city (Chicago, 'Portland, OR'). Required. AU: city or airport code (Sydney, SYD, 'Gold Coast', OOL). Required, and AU also needs 'to'. US: airp"
},
"fuel": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). fuel: petrol95 = unleaded 95; methane = CNG (priced per kg). Queensland: diesel, petrol95 (= standard Unleaded, 91 RON), petrol98, e10, e85 or lpg. Brazil: petrol95 = regular petrol (gasolina comum, not RON"
},
"item": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). groceries: Everyday item in plain words, e.g. 'milk', 'white bread', 'eggs', 'butter', 'coffee', 'bananas', 'beer'. Each country measures its own standard pack or cut; the answer names it and lists other definit"
},
"town": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). commercial-property: Town or city. FR: town, e.g. 'Bordeaux', or use postcode. TW: a city or county in English or Chinese ('Taipei', 'New Taipei', 'Taichung', 'Kaohsiung', '臺北市'), or a district with its city (\"Zhongshan, | fuel: Town name. AU (Queensland only): suburb name, e.g. 'Mount Gravatt'. Small suburbs may have fewer than 5 stations. BR: municipality, e.g. 'São Paulo' or 'Curitiba'; add area when the name exists in sev | home-sales: Town or city. AT: a municipality among the 100 largest ('Wien' / 'Vienna', 'Graz', 'Linz', 'Salzburg', 'Innsbruck'), a district ('Wien 2' for Leopoldstadt, 'Bezirk Baden', 'Kitzbühel'), or a Bundeslan | rent: Town, city or local area. AU: use 'NSW' for the whole state; otherwise give a postcode (NSW rents are published by postcode). AU (Queensland): give a four-digit postcode; the RTA publishes by postcode"
},
"unit": {
"type": "string",
"description": "What the price is per, for example 'per month', 'per litre', 'per home'. Defaults to the evidence unit. A different unit gives cannot_judge."
},
"what": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). contracts: What was bought, in plain words: 'laptops', 'school meals', 'road resurfacing', 'office cleaning', 'electricity', 'ambulances', 'waste collection'. Common purchases are matched to official product cod | surplus-auctions: Lot type: a group name or words from the lot title, such as 'vehicles', 'heavy equipment', 'office furniture' or 'forklift'. CA: one of vehicles, heavy-equipment, electronics, office-furniture, boats,"
},
"year": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). diet-costs: Year of the estimate (2017 onwards). Leave out for the newest year the World Bank holds. World Bank: 2017 to the newest year held (2025 at the last check). Leave out for the newest year."
},
"zone": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). wholesale-power: Bidding zone, only where a country has more than one: DK = DK1 (west, default) or DK2 (east). IT answers northern Italy (IT-North), NO south-west Norway (NO2); other countries have one zone."
},
"cycle": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). tuition: Degree level: first = bachelor's (first cycle, the default), second = master's (second cycle). Also accepts bachelor, master, undergraduate, postgraduate. Canada, Statistics Canada: first = undergradu"
},
"hours": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). childcare: Full-time or part-time care, where a source publishes both. Most sources publish one basis only and say which. GB: ignored; fees are per hour, with no full-time or part-time split. IE: ignored; the ta"
},
"level": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). wholesale-fresh-food: Malaysia fish only: ex_vessel (the price fishers get at first sale at landing; default), wholesale or retail."
},
"model": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). health-insurance: standard = free choice of doctor (default); alternative = family-doctor, telemedicine or HMO models with a restricted choice."
},
"offer": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). broadband: Which standard offer. Friendly names such as fixed_100_200 (fixed internet 100-200 Mbps, the default), fixed_30_100, fixed_1gbps, mobile_10gb, mobile_unlimited, or a publisher code. The country notes "
},
"price": {
"type": "number",
"description": "The price to check, as a number above zero (for example 2400 or 1.95), in the unit and currency below.",
"exclusiveMinimum": 0
},
"rooms": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). rent: NO only: number of rooms (living rooms plus bedrooms), 1 to 5 (5 means five or more). Required for Norway."
},
"spend": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). price-levels: What kind of spending: leave out for all household consumption, or give 'food', 'meat', 'dairy', 'bread and cereals', 'fruit', 'vegetables', 'alcohol', 'tobacco', 'clothing', 'housing' (rent, water, e"
},
"stars": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). hotels: Hotel star category (1 to 5), for sources that publish it. Only national figures are split by stars; do not combine with area. ES: optional, 1 to 5 hotel stars. INE publishes star categories for Spain"
},
"state": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). energy: US only: the state, by name or postal code ('Texas', 'TX', 'DC'). Leave out for the U.S. average. Gas: EIA publishes no figure for a few states in recent months, then the newest published month is ret | home-sales: US only: 'CT' (Connecticut), 'NY' (New York City) or 'IL' (Cook County). Usually inferred from the place; set it when a name exists in two of them. | medical: A state or territory, where the source publishes one (the country notes say how to write it). Leave out for the national average. Singapore: the ward class, because Singapore has no states: c = public | surplus-auctions: Optional region to narrow to, see the country notes below. CA: province or territory, name or two-letter code ('ON', 'Quebec'). Omit for all of Canada. FR: the auction house city (CAV) such as 'Lyon',"
},
"taxes": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). energy: Tax level of the price. 'all' = all taxes and levies included (what a household pays, default); 'excl_vat' = excluding VAT and other recoverable taxes; 'none' = excluding all taxes and levies. BR: not"
},
"canton": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). energy: CH only: canton by two-letter code, for example 'ZH', 'GE', 'VD', 'TI'. Leave out for Switzerland as a whole."
},
"county": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). home-sales: IE only: same as town; a county such as 'Dublin' or 'Cork'."
},
"energy": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). energy: electricity or gas (natural gas). BR: electricity only (no gas). The figure is the regulated residential tariff (TE energy + TUSD network) before taxes and flag surcharges, as a posted price. CH: elec"
},
"market": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). wholesale-fresh-food: CA only: one wholesale centre (Calgary, Edmonton, Vancouver or Winnipeg). Leave out for all centres together. AAFC does not quote every centre every week (the latest file has only Calgary and Winnipeg | wholesale-markets: One wholesale market, only where the source publishes by market (for example a city name). Leave out for all markets together. TW: optional wholesale market: taipei, banqiao, sanchong, yilan, taoyuan, | wholesale-power: Which wholesale market. Only day-ahead (the next-day hourly auction) is available. AU: spot only (AEMO's five-minute regional price), not day-ahead; leave it out. DE: day-ahead only (the hourly auctio"
},
"months": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). border-prices: How many months to include, ending with the period. Default 1. More months smooth out lumpy shipments. GB: months to include, 1 to 12 (default 1). | cars: How many recent months to include. Default 12. | commercial-property: How many recent months to include. Default 24. TW: 12 or 24 whole calendar months; up to 18 gives 12 (24 if a place has too few sales in 12), more gives 24. | contracts: How many recent months of awards to include. Default 24. AU: not used; the newest 21 days of notices are read. CA: not used; each figure covers the newest 24 months of awards. CO: not used; each figur | home-sales: How many recent months to include. Default 12. AT: ignored; STATISTIK AUSTRIA publishes one figure per calendar year (the latest is returned). AU: not used; the ABS publishes one mean price per quarte | rent: How many recent months to include, for sources that hold individual rents. Ignored by sources that publish one figure per quarter or month. AU: 3 or 12 (anything up to 4 uses the latest 3 months, long | surplus-auctions: How many recent months of auctions to include. Default 12. CA: rounded to the nearest of 6, 12 or 24."
},
"period": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). border-prices: Optional last month to include, as YYYY-MM. Default: the newest month the customs authority has published. GB: the last month to include (YYYY-MM). HMRC publishes about six weeks after the month ends;"
},
"region": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). energy: NZ only: electricity network region, for example 'Auckland', 'Wellington', 'Christchurch', 'Dunedin'. Leave out for the unweighted median across all regions. | farm-gate-prices: Region inside the country, as the statistics office publishes it (for example a province or state). Some countries publish no national figure, so the answer then asks for a region. Canada: a province | groceries: Region inside the country, only where the statistics office publishes regional averages. Leave out for the national average. Canada: leave out for the Canada average, or give a province (Ontario, BC, | land-prices: Optional region code for a regional figure, where the source publishes one (the country notes say which codes). Leave out for the whole country. EU/NO, optional. A NUTS region code (Eurostat's regiona | wholesale-power: AU only: NEM region NSW1 (New South Wales incl. ACT, default), QLD1, SA1, TAS1 or VIC1; short names like NSW, VIC or Queensland also work."
},
"season": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). energy: TW only: 'non_summer' (default) or 'summer' rates (Taipower charges more in summer)."
},
"sector": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). energy: Whose price: 'household' (default: what homes pay) or 'business' (non-household consumers: what companies, shops, offices and factories pay; official average by annual-consumption band). Leave out for"
},
"country": {
"type": "string",
"description": "ISO country code of the place (for example IE, GB, FR). Which countries a category covers: see pricepaid_coverage."
},
"faculty": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). tuition: Taiwan only: faculty group (medicine, dentistry, medical_college, engineering, science_agri, business, humanities_law, other). Default humanities_law. Words like law, business, engineering, medicine, "
},
"measure": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). home-upgrades: The upgrade: heat_pump, solar_pv, attic_insulation, wall_insulation, windows, or renovation (any home renovation works, where the publisher does not split by type). Plain words such as 'heat pump' or | land-prices: price = what agricultural land sells for per hectare; rent = what it costs to rent per hectare for one year. EU/NO: price = average sale price of agricultural land per hectare (Eurostat apri_lprc); re"
},
"partner": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). border-prices: Optional partner country (ISO code such as 'DE' or 'US', or its name): where the goods came from (imports) or went to (exports). Leave out for all partners. GB: optional partner country, as an ISO cod"
},
"product": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). border-prices: The goods: an everyday word such as 'wheat', 'diesel', 'cheese', 'timber', 'steel', 'whisky', or a customs commodity code (HS/CN) of 4 to 8 digits such as '1001' or '271019'. GB: an everyday word (die | cars: Which price. 'coe' = Certificate of Entitlement bidding results (the country notes say where it exists). Default 'coe'. SG: 'coe'. | farm-gate-prices: The crop or animal product, e.g. 'wheat', 'barley', 'oats', 'canola', 'soybeans', 'corn', 'potatoes', 'cattle', 'hogs', 'lambs', 'chickens', 'milk', 'eggs'. The full list is in the tool notes. Canada: | farm-prices: The product, e.g. 'wheat', 'barley', 'beef', 'pig', 'lamb', 'chicken', 'eggs', 'milk', 'butter', 'olive oil', 'tomatoes', 'apples'. The full list is in the tool notes. EU: required. The product, by na | producer-prices: The crop or animal product, e.g. 'wheat', 'maize', 'rice', 'soybeans', 'potatoes', 'tomatoes', 'apples', 'bananas', 'beef', 'pork', 'chicken', 'eggs', 'milk', 'coffee', 'cotton'. US, CA, BR, MX, AU, N | wholesale-fresh-food: The food in plain words, e.g. 'live pig', 'chicken', 'eggs', 'grass carp', 'tomato'. The list for each country is in the tool notes. Australia: cattle or sheep in everyday words, e.g. cattle, western | wholesale-markets: The vegetable or fruit in plain words, e.g. 'cabbage', 'tomato', 'banana', 'pineapple'. The local-language name also works. The full list is in the tool notes. TW: required. Vegetable or fruit by Engl"
},
"service": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). fuel: Self-service or attended service, where a country prices them differently. Ontario: not used (the survey does not split self and full service). Canada: self only. Full-service prices stopped in 2013. | medical: The medical service: plain words ('office visit', 'MRI lower back', 'knee replacement'), a billing code or a hospital-stay group code, as the country notes list them. Required. Singapore: a medical co"
},
"setting": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). medical: office = a doctor's office (whole service); facility = hospital outpatient or surgery centre (doctor's fee only); inpatient = a hospital stay. Leave out to use the usual setting for the service. Singa"
},
"size_kw": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). home-upgrades: GB solar_pv: system size in kW; picks the DESNZ size band (0-4, 4-10 or 10-50 kW). Default: the 0-4 kW band."
},
"tenancy": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). rent: FR only: all leases (default), new = leases signed in the last year (what a new tenant faces), existing = leases of one year or more. New leases are published per dwelling type, not per size."
},
"accident": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). health-insurance: Whether accident cover is included in the premium. Default: without for adults and young adults, with for children."
},
"bedrooms": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). rent: Number of bedrooms (0 = studio). Leave out for all sizes. AU: 0 (studio), 1, 2, 3 or 4 (4 means four or more). AU (Queensland): flats 1-3, houses 2-4, townhouses 2-3. With no type and no bedrooms the "
},
"category": {
"type": "string",
"description": "Which kind of price: border-prices, broadband, cars, childcare, commercial-property, construction, contracts, diet-costs, energy, farm-gate-prices, farm-prices, flights, fuel, groceries, health-insurance, home-sales, home-upgrades, hotels, insurance, land-prices, medical, medicines, price-levels, producer-prices, rent, surplus-auctions, tuition, wholesale-fresh-food, wholesale-markets and wholesale-power (the REST path or the tool name also works)."
},
"currency": {
"type": "string",
"description": "ISO 4217 currency code of the price (for example EUR). Defaults to the evidence currency. A different currency gives cannot_judge: ProofPrice never converts."
},
"district": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). home-sales: GB only: local authority (council area or London borough) as the Land Registry records it, e.g. 'Camden', 'City of Bristol', 'South Gloucestershire'. Use it instead of town for a London borough or whe"
},
"includes": {
"type": "string",
"description": "What the price includes or excludes, as free text (for example 'VAT included, delivery excluded'). Echoed back as a caution; it is not used to adjust the figure."
},
"medicine": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). medicines: Medicine brand or active-substance name, e.g. 'doliprane' or 'paracetamol'. Only the first word is used. ES: Spanish active-ingredient or brand name, first word used ('paracetamol', 'ibuprofeno', 'ome"
},
"postcode": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). commercial-property: Postcode, for a precise area. FR: 5-digit postcode, e.g. '33000'; use instead of town for a precise area. TW: not supported (the register has no postcodes); give the city, county or district as town. | fuel: Postcode of the place. AU (Queensland only): 4-digit postcode starting with 4, e.g. '4122'. Most single postcodes have fewer than 5 stations of one fuel; use area 'Brisbane' or 'QLD' then. BR: not use | home-sales: Postcode, for a precise area. AT: only Vienna postcodes (1010 to 1230) are matched, to the Vienna district; elsewhere give the town or district as town. AU: a 4-digit postcode ('2150'), answered with | rent: Postcode, for a precise area. AU: a four-digit NSW postcode, e.g. 2000 (Sydney CBD), 2150 (Parramatta), 2500 (Wollongong). AU (Queensland): a four-digit postcode, e.g. 4000 (Brisbane city), 4217 (Surf"
},
"province": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). tuition: Canada only: a province (Ontario, Quebec, BC, Alberta ...) or leave out for the Canada average. Yukon is mostly not published; the other territories are not in the table."
},
"quarters": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). flights: How many recent quarters to include in the trend (default 4, at most 20). The headline figure is always the latest quarter. AU: the range covers this many quarters of monthly fares (default 4 = 12 mon"
},
"age_group": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). childcare: Age of the child: infant (under 2), toddler (2), preschool (3 to 4 or until school), school-age. Each source says how it defines them. Leave out for the source's default (see the answer). GB: infant ( | health-insurance: Age group: adult (26+, default), young_adult (19-25) or child (0-18)."
},
"care_type": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). childcare: centre = nursery, daycare or group-based setting; home-based (also childminder) = a registered provider caring in their own home. Leave out for centres or for all providers, as the source says. GB: ce"
},
"community": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). tuition: BE only: the higher-education system, because Belgium has three with different fees: fr (French Community), nl (Flemish Community) or de (German-speaking Community)."
},
"component": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). construction: Which part of the cost: total (default), material (building materials) or labour (wages). BR: total (default) = average cost per m2; material = materials part; labour = labour part. All in BRL per m2,"
},
"direction": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). border-prices: Goods coming in (imports, default) or going out (exports). GB: imports (default) or exports, as the UK reports them (EU and non-EU trade combined)."
},
"flat_type": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). home-sales: SG only: HDB flat type. | rent: SG only: HDB flat type, one of 1-ROOM, 2-ROOM, 3-ROOM, 4-ROOM, 5-ROOM, EXECUTIVE ('4 ROOM' also works). Leave out for all types."
},
"franchise": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). health-insurance: Annual deductible in local currency; the values available depend on the country notes. Default: the lowest one for the age group. CH: adults and young adults 300, 500, 1000, 1500, 2000 or 2500 CHF; ch"
},
"gb_region": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). energy: GB only: Ofgem region (North Western England, North Eastern England, Yorkshire, Northern Scotland, Southern England, Southern Scotland, Merseyside and Northern Wales, London, South Eastern England, Ea"
},
"land_type": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). land-prices: Land type, e.g. 'arable', 'permanent grassland', 'arable or grassland' (rent only), 'irrigable arable' (price only). Leave out for the usual one. EU/NO, optional. For price: \"arable\" = Arable land; \"p"
},
"new_build": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). rent: SE only: true = rents of newly built rented flats (built from 2022) instead of the all-flats rent survey."
},
"ownership": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). tuition: Taiwan only: public or private institutions (default both)."
},
"buyer_area": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). contracts: Optional region or city to narrow to, see the country notes below. AU: part of a federal agency's name ('Defence', 'Health', 'Parliamentary Services'); contracts have no delivery place. CA: not used; "
},
"compare_to": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). price-levels: What the index is measured against, as a short name of a comparison area. Leave out for the default; the allowed values are listed in the notes for the country. OECD: 'OECD' (default, OECD average = 1"
},
"flat_class": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). rent: HK only: RVD flat class by saleable area, A (under 40 m²), B (40–69.9), C (70–99.9), D (100–159.9) or E (160 and over). Default B."
},
"food_group": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). diet-costs: Which part of the healthy diet: leave out for the whole diet, or give 'fruit', 'vegetables', 'animal foods', 'legumes and nuts', 'oils and fats' or 'starchy staples'. The World Bank leaves some group "
},
"house_type": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). rent: Kind of house, for sources that publish houses by type (needed with property_type house there). CA: not used (houses are not published). DE: not used. GB: detached, semi-detached or terraced; required"
},
"settlement": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). home-sales: HU only: type of settlement inside a region: all (default), county_seat, towns or villages. Budapest has one figure."
},
"study_mode": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). tuition: full-time (the default) or part-time. Canada: full-time only (the default). Europe, Eurydice: full-time (default) or part-time. Taiwan: full-time day programmes only (the default)."
},
"technology": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). home-upgrades: GB heat_pump: air_to_water (default), ground_source or biomass_boiler."
},
"distributor": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). energy: BR only: the electricity distributor by ANEEL short name, for example 'CEMIG-D', 'ENEL SP', 'LIGHT', 'COPEL-DIS'. Leave out for the median of all distributors."
},
"school_type": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). tuition: Taiwan only: university (general universities) or technical (technical and vocational colleges); default both."
},
"dwelling_type": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). home-upgrades: Type of dwelling or job, only where the publisher splits by it (the country notes say which values). Leave out for the publisher's main figure. GB solar_pv: leave out for all small installations (medi"
},
"lookback_days": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). wholesale-power: How many recent days of hourly prices to include. Default 7, at most 14. AU: 1 to 7 trading days of five-minute prices (default 3); each five-minute interval counts as one record. Prices are in Austra"
},
"property_type": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). commercial-property: commercial = shops, offices, workshops and other commercial or industrial premises (default); land = building plots and other non-farm land sold without a building. FR: commercial (default) or land. A | home-sales: Kind of home. Default 'any'. AT: house or apartment (flats). The figure is the price per m² of living area. With no type given the headline is the flat figure and both medians are in extra.by_type. Th | rent: Kind of home: apartment (same as flat), house or room. Default 'any'. AU: apartment (flat or unit), house (includes terraces, townhouses and semi-detached) or any. Rooms are not published. AU (Queensl"
},
"student_group": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). tuition: Who pays: home (nationals and EU students who pay home fees, the default), international (students from outside the EU/EEA), non-state-subsidised (self-financed places), specific-discipline (for examp"
},
"vehicle_class": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). cars: SG only: COE category. A = cars up to 1600cc (default), B = cars above 1600cc, C = goods vehicles/buses, D = motorcycles, E = open."
},
"gasoline_grade": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). fuel: US only: the gasoline grade EIA publishes. Overrides the grade implied by fuel (petrol95 = regular, petrol98 = premium); use midgrade here with fuel=petrol95. Not for diesel."
},
"payment_method": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). energy: GB only: direct_debit (default), standard_credit (pay on receipt of the bill) or prepayment (prepayment meter)."
},
"consumption_band": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). energy: Standard consumption band (household bands, or the business bands when sector=business), by letter or by the publisher's code (the country notes list them). Leave out for the standard band. BR: not us"
},
"postcode_district": {
"type": [
"string",
"number"
],
"description": "Parameter of the category (same name and meaning as in its own tool). home-sales: GB only: postcode district such as 'BS8' to narrow the area."
}
}
}| hours | string | Full-time or part-time care, where a source publishes both. Most sources publish one basis only and say which. GB: ignored; fees are per hour, with no full-time or part-time split. IE: ignored; the table averages part-time and full-time use. NO: ignored; the table gives one monthly average. US: full-time only (weekly prices); part-time is not published. |
| country* | string | GB = England only (DfE provider survey; Scotland, Wales and Northern Ireland are not covered); IE = Ireland (CSO survey of what households pay for childcare, 2016, by region); NO = Norway (Statistics Norway average kindergarten fees by municipality, January); US = United States (Department of Labor county childcare prices, 2022) |
| age_group | string | Age of the child: infant (under 2), toddler (2), preschool (3 to 4 or until school), school-age. Each source says how it defines them. Leave out for the source's default (see the answer). GB: infant (under 2), toddler (2), preschool (3 and 4; default) or school-age (regions only). IE: only 'pre-school' (infant, toddler and preschool all give the pre-school children figure) or school-age (primary school children); leave out for all children aged 0 to 12. NO: ignored; the table averages all kindergarten children. US: infant (under 2), toddler (2), preschool (3 years old to school age) or school-age. Default infant. |
| care_type | string | centre = nursery, daycare or group-based setting; home-based (also childminder) = a registered provider caring in their own home. Leave out for centres or for all providers, as the source says. GB: centre (shown as private group-based providers) or home-based (childminders); England as a whole only. Leave out for all providers. IE: ignored; the table averages all paid childcare. NO: ignored; the table averages all kindergartens. US: centre (child care centre; default) or home-based (family childcare in the provider's home; also written childminder). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country"
],
"properties": {
"area": {
"type": "string",
"minLength": 2,
"description": "Place: a county, a region, a local authority, or a state or city where the source says so (examples: 'Cook County, IL', 'London', 'Dublin'). Leave out for the whole country, where the source has a national figure. GB: England (leave out), a region (London, North West ...) or a local authority (Manchester, Leeds, Camden ...). Local authorities are published for 2 year olds and 3 and 4 year olds only. IE: a county, city or region such as Dublin, Cork, Galway or Mid-West; the answer is for the CSO region it belongs to. Leave out for the whole State. NO: a municipality such as Oslo, Bergen, Trondheim, Stavanger or Tromso (Norwegian spellings work). Leave out for the whole country. US: required. A county, for example 'Cook County, IL' or 'Harris County, Texas' (add the state when the name is not unique). Cities, ZIP codes and states are not published; use the county."
},
"hours": {
"enum": [
"full-time",
"part-time"
],
"type": "string",
"description": "Full-time or part-time care, where a source publishes both. Most sources publish one basis only and say which. GB: ignored; fees are per hour, with no full-time or part-time split. IE: ignored; the table averages part-time and full-time use. NO: ignored; the table gives one monthly average. US: full-time only (weekly prices); part-time is not published."
},
"country": {
"enum": [
"GB",
"IE",
"NO",
"US"
],
"type": "string",
"description": "GB = England only (DfE provider survey; Scotland, Wales and Northern Ireland are not covered); IE = Ireland (CSO survey of what households pay for childcare, 2016, by region); NO = Norway (Statistics Norway average kindergarten fees by municipality, January); US = United States (Department of Labor county childcare prices, 2022)"
},
"age_group": {
"enum": [
"infant",
"toddler",
"preschool",
"school-age"
],
"type": "string",
"description": "Age of the child: infant (under 2), toddler (2), preschool (3 to 4 or until school), school-age. Each source says how it defines them. Leave out for the source's default (see the answer). GB: infant (under 2), toddler (2), preschool (3 and 4; default) or school-age (regions only). IE: only 'pre-school' (infant, toddler and preschool all give the pre-school children figure) or school-age (primary school children); leave out for all children aged 0 to 12. NO: ignored; the table averages all kindergarten children. US: infant (under 2), toddler (2), preschool (3 years old to school age) or school-age. Default infant."
},
"care_type": {
"enum": [
"centre",
"home-based",
"childminder"
],
"type": "string",
"description": "centre = nursery, daycare or group-based setting; home-based (also childminder) = a registered provider caring in their own home. Leave out for centres or for all providers, as the source says. GB: centre (shown as private group-based providers) or home-based (childminders); England as a whole only. Leave out for all providers. IE: ignored; the table averages all paid childcare. NO: ignored; the table averages all kindergartens. US: centre (child care centre; default) or home-based (family childcare in the provider's home; also written childminder)."
}
}
}| property_type | string | commercial = shops, offices, workshops and other commercial or industrial premises (default); land = building plots and other non-farm land sold without a building. FR: commercial (default) or land. Alsace-Moselle and Mayotte are not covered. TW: commercial (default; shops, offices, factories, per m² of building) or land (building plots without a building, per m² of land). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country"
],
"properties": {
"town": {
"type": "string",
"minLength": 2,
"description": "Town or city. FR: town, e.g. 'Bordeaux', or use postcode. TW: a city or county in English or Chinese ('Taipei', 'New Taipei', 'Taichung', 'Kaohsiung', '臺北市'), or a district with its city (\"Zhongshan, Taipei\", '臺北市中山區'). Omit for all of Taiwan."
},
"months": {
"type": "integer",
"maximum": 36,
"minimum": 1,
"description": "How many recent months to include. Default 24. TW: 12 or 24 whole calendar months; up to 18 gives 12 (24 if a place has too few sales in 12), more gives 24."
},
"country": {
"enum": [
"FR",
"TW"
],
"type": "string",
"description": "FR = France (DVF); TW = Taiwan"
},
"postcode": {
"type": "string",
"description": "Postcode, for a precise area. FR: 5-digit postcode, e.g. '33000'; use instead of town for a precise area. TW: not supported (the register has no postcodes); give the city, county or district as town."
},
"property_type": {
"enum": [
"commercial",
"land"
],
"type": "string",
"description": "commercial = shops, offices, workshops and other commercial or industrial premises (default); land = building plots and other non-farm land sold without a building. FR: commercial (default) or land. Alsace-Moselle and Mayotte are not covered. TW: commercial (default; shops, offices, factories, per m² of building) or land (building plots without a building, per m² of land)."
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country"
],
"properties": {
"area": {
"type": "string",
"description": "State or region, where the publisher splits by place (the country notes say how). Leave out for the national figure. BR: state name or two-letter code ('São Paulo', 'SP', 'Bahia', 'RJ'); leave out for the national figure (Brasil). States: RO = Rondônia, AC = Acre, AM = Amazonas, RR = Roraima, PA = Pará, AP = Amapá, TO = Tocantins, MA = Maranhão, PI = Piauí, CE = Ceará, RN = Rio Grande do Norte, PB = Paraíba, PE = Pernambuco, AL = Alagoas, SE = Sergipe, BA = Bahia, MG = Minas Gerais, ES = Espírito Santo, RJ = Rio de Janeiro, SP = São Paulo, PR = Paraná, SC = Santa Catarina, RS = Rio Grande do Sul, MS = Mato Grosso do Sul, MT = Mato Grosso, GO = Goiás, DF = Distrito Federal."
},
"country": {
"enum": [
"BR"
],
"type": "string",
"description": "BR = Brazil (all 27 states plus the national figure; IBGE SINAPI average cost per m2)"
},
"component": {
"enum": [
"total",
"material",
"labour"
],
"type": "string",
"description": "Which part of the cost: total (default), material (building materials) or labour (wages). BR: total (default) = average cost per m2; material = materials part; labour = labour part. All in BRL per m2, monthly."
}
}
}| Type |
|---|
| Description |
|---|
| cpv | string | Optional official product code, to be exact, where the source uses one (the country notes say which code system), e.g. the CPV code 30213100 for portable computers; a prefix such as 3021 covers the whole group. AU: a UNSPSC code or prefix of 2 to 8 digits (43211503 = notebook computers, 4321 = computers), not a CPV code. CA: not used. CO: not used. EU and EEA: an 8-digit CPV code (30213100) or a shorter prefix (3021) for a whole group; a lot counts when its own main product code is in that group. FR: a CPV code of 2 digits (a division) or 4 to 8 digits (read as the 4-digit group, e.g. 3021); used instead of the words in what. GB: a full 8-digit CPV code (45233142) instead of the keyword; only notices that list the code themselves are used. NZ: not used (New Zealand notices carry no CPV codes). SG: not used (Singapore tenders carry no CPV codes). US: a product or service code (PSC, e.g. 7010 or psc:7010) or a NAICS code (e.g. 334111 or naics:334111) instead of the keyword; there are no CPV codes in the US. ZA: not used. |
| what* | string | What was bought, in plain words: 'laptops', 'school meals', 'road resurfacing', 'office cleaning', 'electricity', 'ambulances', 'waste collection'. Common purchases are matched to official product codes; anything else is searched as free text in the award notices. AU: a word or phrase searched in the contract title and description (common purchases such as 'laptops' or 'catering' also use their UNSPSC code). Federal agencies only. CA: a common purchase in plain words ('translation services', 'legal services', 'catering', 'consultancy', 'IT services', 'laptops', 'security guards'). Recognised from the words in the notice title; other wording is not searched. CO: a common purchase in plain words ('catering', 'security guard services', 'office cleaning', 'laptops', 'ambulances', 'printers', 'photocopiers'). Recognised from the Spanish words in the contract description; other wording is not searched. EU and EEA: common purchases are matched to CPV product codes (laptops, desktop computers, school meals, road resurfacing, office cleaning, electricity, natural gas, ambulances, waste collection and about 30 more, in English and the main EU languages); anything else is a free-text search of the award notices, best in the buyer country's language. FR: a common purchase in plain words, in French or English ('ordinateurs portables', 'laptops', 'restauration scolaire', 'road resurfacing', 'office cleaning', 'ambulances'). Recognised from the contract's CPV product code. GB: a keyword or phrase searched in the award notices (common purchases such as 'laptops' or 'road resurfacing' use a tuned keyword). Several words are searched as an exact phrase, so shorter is better. NZ: optional (left out = all awards); a common purchase in plain words ('buses', 'laptops', 'cleaning', 'road resurfacing'; a purchase with fewer than 5 awards in 24 months gets no figure) or 'all'; read from the price library, not searched live. SG: a word or phrase searched in the tender description ('cleaning', 'laptops', 'security services'); common purchases use a tuned keyword. US: a phrase searched in the federal award descriptions (common purchases such as 'laptops' use a tuned keyword; 'road resurfacing' uses the road-repair product code Z2LB). Several words must appear together, so shorter is better. ZA: a common purchase in plain words ('security guard services', 'building cleaning', 'catering', 'laptops', 'office furniture', 'photocopiers'). Recognised from the words in the contract description; other wording is not searched. |
| months | integer | How many recent months of awards to include. Default 24. AU: not used; the newest 21 days of notices are read. CA: not used; each figure covers the newest 24 months of awards. CO: not used; each figure covers the newest 12 months of signed contracts. EU and EEA: up to 60; only the newest 1,000 matching notices are read, so a very common purchase covers a shorter period than asked (the answer says so). FR: not used; each figure covers contracts notified in the newest 12 months. GB: 1 to 60 months, by award date. NZ: not used; the newest 24 months of awards are always shown. SG: 1 to 60 months by award date; the dataset covers FY2021 onwards and is updated about yearly. US: 1 to 60 months of new awards, read in up to 12 slices. ZA: not used; each figure covers the newest 24 months of signed contracts. |
| country* | string | AU = Australia (AusTender federal contract notices); CA = Canada (federal award notices on CanadaBuys); CO = Colombia (signed public contracts in SECOP II); EU and EEA states, by the country of the public buyer, as ISO codes: AT = Austria, BE = Belgium, BG = Bulgaria, HR = Croatia, CY = Cyprus, CZ = Czechia, DK = Denmark, EE = Estonia, FI = Finland, FR = France, DE = Germany, GR = Greece, HU = Hungary, IE = Ireland, IT = Italy, LV = Latvia, LT = Lithuania, LU = Luxembourg, MT = Malta, NL = the Netherlands, PL = Poland, PT = Portugal, RO = Romania, SK = Slovakia, SI = Slovenia, ES = Spain, SE = Sweden, IS = Iceland, LI = Liechtenstein, NO = Norway. Award notices above the EU procurement thresholds from TED.; FR = France (awarded public contracts, DECP); GB = United Kingdom (Contracts Finder awarded contracts); NZ = New Zealand (GETS contract award notices); SG = Singapore (GeBIZ tenders); US = United States, federal agencies' contracts only (not state or local governments); ZA = South Africa (signed public contracts on the National Treasury eTenders portal) |
| buyer_area | string | Optional region or city to narrow to, see the country notes below. AU: part of a federal agency's name ('Defence', 'Health', 'Parliamentary Services'); contracts have no delivery place. CA: not used; all federal buyers are summarised together. CO: not used; all public buyers are summarised together. EU and EEA: the buyer's city, as written on the notice (e.g. 'Lyon', 'München'). FR: not used; all French public buyers are summarised together. GB: a region ('London', 'North West', 'Scotland', 'Wales', 'Yorkshire and The Humber' ...); nationwide contracts that list the region are included. NZ: part of the posting agency's name ('Auckland Council', 'Waka Kotahi', 'Health'); needs at least 5 awards. SG: part of an agency name ('National Library Board', 'Health Sciences Authority'). US: a state name or code ('Virginia', 'VA'); filters by where the work is done. ZA: not used; all public buyers are summarised together. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country",
"what"
],
"properties": {
"cpv": {
"type": "string",
"description": "Optional official product code, to be exact, where the source uses one (the country notes say which code system), e.g. the CPV code 30213100 for portable computers; a prefix such as 3021 covers the whole group. AU: a UNSPSC code or prefix of 2 to 8 digits (43211503 = notebook computers, 4321 = computers), not a CPV code. CA: not used. CO: not used. EU and EEA: an 8-digit CPV code (30213100) or a shorter prefix (3021) for a whole group; a lot counts when its own main product code is in that group. FR: a CPV code of 2 digits (a division) or 4 to 8 digits (read as the 4-digit group, e.g. 3021); used instead of the words in what. GB: a full 8-digit CPV code (45233142) instead of the keyword; only notices that list the code themselves are used. NZ: not used (New Zealand notices carry no CPV codes). SG: not used (Singapore tenders carry no CPV codes). US: a product or service code (PSC, e.g. 7010 or psc:7010) or a NAICS code (e.g. 334111 or naics:334111) instead of the keyword; there are no CPV codes in the US. ZA: not used."
},
"what": {
"type": "string",
"minLength": 2,
"description": "What was bought, in plain words: 'laptops', 'school meals', 'road resurfacing', 'office cleaning', 'electricity', 'ambulances', 'waste collection'. Common purchases are matched to official product codes; anything else is searched as free text in the award notices. AU: a word or phrase searched in the contract title and description (common purchases such as 'laptops' or 'catering' also use their UNSPSC code). Federal agencies only. CA: a common purchase in plain words ('translation services', 'legal services', 'catering', 'consultancy', 'IT services', 'laptops', 'security guards'). Recognised from the words in the notice title; other wording is not searched. CO: a common purchase in plain words ('catering', 'security guard services', 'office cleaning', 'laptops', 'ambulances', 'printers', 'photocopiers'). Recognised from the Spanish words in the contract description; other wording is not searched. EU and EEA: common purchases are matched to CPV product codes (laptops, desktop computers, school meals, road resurfacing, office cleaning, electricity, natural gas, ambulances, waste collection and about 30 more, in English and the main EU languages); anything else is a free-text search of the award notices, best in the buyer country's language. FR: a common purchase in plain words, in French or English ('ordinateurs portables', 'laptops', 'restauration scolaire', 'road resurfacing', 'office cleaning', 'ambulances'). Recognised from the contract's CPV product code. GB: a keyword or phrase searched in the award notices (common purchases such as 'laptops' or 'road resurfacing' use a tuned keyword). Several words are searched as an exact phrase, so shorter is better. NZ: optional (left out = all awards); a common purchase in plain words ('buses', 'laptops', 'cleaning', 'road resurfacing'; a purchase with fewer than 5 awards in 24 months gets no figure) or 'all'; read from the price library, not searched live. SG: a word or phrase searched in the tender description ('cleaning', 'laptops', 'security services'); common purchases use a tuned keyword. US: a phrase searched in the federal award descriptions (common purchases such as 'laptops' use a tuned keyword; 'road resurfacing' uses the road-repair product code Z2LB). Several words must appear together, so shorter is better. ZA: a common purchase in plain words ('security guard services', 'building cleaning', 'catering', 'laptops', 'office furniture', 'photocopiers'). Recognised from the words in the contract description; other wording is not searched."
},
"months": {
"type": "integer",
"maximum": 60,
"minimum": 1,
"description": "How many recent months of awards to include. Default 24. AU: not used; the newest 21 days of notices are read. CA: not used; each figure covers the newest 24 months of awards. CO: not used; each figure covers the newest 12 months of signed contracts. EU and EEA: up to 60; only the newest 1,000 matching notices are read, so a very common purchase covers a shorter period than asked (the answer says so). FR: not used; each figure covers contracts notified in the newest 12 months. GB: 1 to 60 months, by award date. NZ: not used; the newest 24 months of awards are always shown. SG: 1 to 60 months by award date; the dataset covers FY2021 onwards and is updated about yearly. US: 1 to 60 months of new awards, read in up to 12 slices. ZA: not used; each figure covers the newest 24 months of signed contracts."
},
"country": {
"enum": [
"AU",
"CA",
"CO",
"AT",
"BE",
"BG",
"HR",
"CY",
"CZ",
"DK",
"EE",
"FI",
"FR",
"DE",
"GR",
"HU",
"IE",
"IT",
"LV",
"LT",
"LU",
"MT",
"NL",
"PL",
"PT",
"RO",
"SK",
"SI",
"ES",
"SE",
"IS",
"LI",
"NO",
"GB",
"NZ",
"SG",
"US",
"ZA"
],
"type": "string",
"description": "AU = Australia (AusTender federal contract notices); CA = Canada (federal award notices on CanadaBuys); CO = Colombia (signed public contracts in SECOP II); EU and EEA states, by the country of the public buyer, as ISO codes: AT = Austria, BE = Belgium, BG = Bulgaria, HR = Croatia, CY = Cyprus, CZ = Czechia, DK = Denmark, EE = Estonia, FI = Finland, FR = France, DE = Germany, GR = Greece, HU = Hungary, IE = Ireland, IT = Italy, LV = Latvia, LT = Lithuania, LU = Luxembourg, MT = Malta, NL = the Netherlands, PL = Poland, PT = Portugal, RO = Romania, SK = Slovakia, SI = Slovenia, ES = Spain, SE = Sweden, IS = Iceland, LI = Liechtenstein, NO = Norway. Award notices above the EU procurement thresholds from TED.; FR = France (awarded public contracts, DECP); GB = United Kingdom (Contracts Finder awarded contracts); NZ = New Zealand (GETS contract award notices); SG = Singapore (GeBIZ tenders); US = United States, federal agencies' contracts only (not state or local governments); ZA = South Africa (signed public contracts on the National Treasury eTenders portal)"
},
"buyer_area": {
"type": "string",
"description": "Optional region or city to narrow to, see the country notes below. AU: part of a federal agency's name ('Defence', 'Health', 'Parliamentary Services'); contracts have no delivery place. CA: not used; all federal buyers are summarised together. CO: not used; all public buyers are summarised together. EU and EEA: the buyer's city, as written on the notice (e.g. 'Lyon', 'München'). FR: not used; all French public buyers are summarised together. GB: a region ('London', 'North West', 'Scotland', 'Wales', 'Yorkshire and The Humber' ...); nationwide contracts that list the region are included. NZ: part of the posting agency's name ('Auckland Council', 'Waka Kotahi', 'Health'); needs at least 5 awards. SG: part of an agency name ('National Library Board', 'Health Sciences Authority'). US: a state name or code ('Virginia', 'VA'); filters by where the work is done. ZA: not used; all public buyers are summarised together."
}
}
}| Argument | Type | Description |
|---|---|---|
| year | integer | Year of the estimate (2017 onwards). Leave out for the newest year the World Bank holds. World Bank: 2017 to the newest year held (2025 at the last check). Leave out for the newest year. |
| country* | string | Countries as ISO codes: IE = Ireland, GB = United Kingdom, FR = France, ES = Spain, PT = Portugal, IT = Italy, DE = Germany, NL = Netherlands, BE = Belgium, AT = Austria, PL = Poland, DK = Denmark, SE = Sweden, NO = Norway, FI = Finland, GR = Greece, LU = Luxembourg, CH = Switzerland, IS = Iceland, CZ = Czechia, HU = Hungary, RO = Romania, SK = Slovakia, SI = Slovenia, EE = Estonia, LV = Latvia, LT = Lithuania, CY = Cyprus, MT = Malta, TR = Turkey, UA = Ukraine, US = United States, CA = Canada, MX = Mexico, BR = Brazil, AR = Argentina, CL = Chile, CO = Colombia, PE = Peru, AU = Australia, NZ = New Zealand, SG = Singapore, JP = Japan, KR = South Korea, TW = Taiwan, HK = Hong Kong, CN = China, IN = India, ID = Indonesia, TH = Thailand, VN = Vietnam, MY = Malaysia, PH = Philippines, PK = Pakistan, BD = Bangladesh, LK = Sri Lanka, AE = United Arab Emirates, SA = Saudi Arabia, IL = Israel, EG = Egypt, MA = Morocco, ZA = South Africa, NG = Nigeria, KE = Kenya, GH = Ghana, TZ = Tanzania, UG = Uganda, ET = Ethiopia. World Bank estimate for the whole country, one figure per year (2017 onwards). |
| food_group | string | Which part of the healthy diet: leave out for the whole diet, or give 'fruit', 'vegetables', 'animal foods', 'legumes and nuts', 'oils and fats' or 'starchy staples'. The World Bank leaves some group figures blank. World Bank: food_group is one of 'fruit', 'vegetables', 'animal foods' (meat, dairy, fish, eggs), 'legumes and nuts', 'oils and fats' or 'starchy staples' (grains, bread, rice, potatoes); leave out for the whole healthy diet. The figure is in the country's own currency per person per day, with international (PPP) dollars in the answer. Blank for some countries and years. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country"
],
"properties": {
"year": {
"type": "integer",
"maximum": 2100,
"minimum": 2017,
"description": "Year of the estimate (2017 onwards). Leave out for the newest year the World Bank holds. World Bank: 2017 to the newest year held (2025 at the last check). Leave out for the newest year."
},
"country": {
"enum": [
"IE",
"GB",
"FR",
"ES",
"PT",
"IT",
"DE",
"NL",
"BE",
"AT",
"PL",
"DK",
"SE",
"NO",
"FI",
"GR",
"LU",
"CH",
"IS",
"CZ",
"HU",
"RO",
"SK",
"SI",
"EE",
"LV",
"LT",
"CY",
"MT",
"TR",
"UA",
"US",
"CA",
"MX",
"BR",
"AR",
"CL",
"CO",
"PE",
"AU",
"NZ",
"SG",
"JP",
"KR",
"TW",
"HK",
"CN",
"IN",
"ID",
"TH",
"VN",
"MY",
"PH",
"PK",
"BD",
"LK",
"AE",
"SA",
"IL",
"EG",
"MA",
"ZA",
"NG",
"KE",
"GH",
"TZ",
"UG",
"ET"
],
"type": "string",
"description": "Countries as ISO codes: IE = Ireland, GB = United Kingdom, FR = France, ES = Spain, PT = Portugal, IT = Italy, DE = Germany, NL = Netherlands, BE = Belgium, AT = Austria, PL = Poland, DK = Denmark, SE = Sweden, NO = Norway, FI = Finland, GR = Greece, LU = Luxembourg, CH = Switzerland, IS = Iceland, CZ = Czechia, HU = Hungary, RO = Romania, SK = Slovakia, SI = Slovenia, EE = Estonia, LV = Latvia, LT = Lithuania, CY = Cyprus, MT = Malta, TR = Turkey, UA = Ukraine, US = United States, CA = Canada, MX = Mexico, BR = Brazil, AR = Argentina, CL = Chile, CO = Colombia, PE = Peru, AU = Australia, NZ = New Zealand, SG = Singapore, JP = Japan, KR = South Korea, TW = Taiwan, HK = Hong Kong, CN = China, IN = India, ID = Indonesia, TH = Thailand, VN = Vietnam, MY = Malaysia, PH = Philippines, PK = Pakistan, BD = Bangladesh, LK = Sri Lanka, AE = United Arab Emirates, SA = Saudi Arabia, IL = Israel, EG = Egypt, MA = Morocco, ZA = South Africa, NG = Nigeria, KE = Kenya, GH = Ghana, TZ = Tanzania, UG = Uganda, ET = Ethiopia. World Bank estimate for the whole country, one figure per year (2017 onwards)."
},
"food_group": {
"type": "string",
"description": "Which part of the healthy diet: leave out for the whole diet, or give 'fruit', 'vegetables', 'animal foods', 'legumes and nuts', 'oils and fats' or 'starchy staples'. The World Bank leaves some group figures blank. World Bank: food_group is one of 'fruit', 'vegetables', 'animal foods' (meat, dairy, fish, eggs), 'legumes and nuts', 'oils and fats' or 'starchy staples' (grains, bread, rice, potatoes); leave out for the whole healthy diet. The figure is in the country's own currency per person per day, with international (PPP) dollars in the answer. Blank for some countries and years."
}
}
}| Argument | Type | Description |
|---|---|---|
| state | string | US only: the state, by name or postal code ('Texas', 'TX', 'DC'). Leave out for the U.S. average. Gas: EIA publishes no figure for a few states in recent months, then the newest published month is returned and the answer says so. |
| taxes | string | Tax level of the price. 'all' = all taxes and levies included (what a household pays, default); 'excl_vat' = excluding VAT and other recoverable taxes; 'none' = excluding all taxes and levies. BR: not used. ANEEL tariffs are always before taxes (ICMS, PIS/COFINS) and flag surcharges. CH: one published total (energy + grid use + charges + federal aid fee); leave taxes out. Business, EU/NO/IS/candidates: default 'excl_vat' (excluding VAT and other recoverable taxes and levies: what a business really bears); 'all' = all taxes and levies including VAT; 'none' = excluding all taxes and levies. Business GB: DESNZ prices never include VAT. Default 'excl_vat' = excluding VAT, including the Climate Change Levy (table 3.4.2); 'none' = also excluding the Climate Change Levy (table 3.4.1); 'all' gives the same figure as 'excl_vat' and the answer says so. GB: not used. Gas figures include 5% VAT; electricity has no VAT from 1 October 2026 to 31 March 2027 (Ofgem's own wording). Netherlands: all = CBS's price with VAT and taxes (default); excl_vat = without VAT, taxes in; none = without VAT and taxes. All three are published by CBS. NZ: prices always include GST (15%); only 'all' (or leaving it out) works. Sweden: all = SCB's total with electricity tax and VAT (default); excl_vat and none are calculated by ProofPrice from SCB's published parts. SG: not used; the figure excludes GST. TW: not used; the figure is the published tariff before any tax or surcharge. US: not used (EIA publishes one average per state). Business US: not used (EIA publishes one average per state). |
| canton | string | CH only: canton by two-letter code, for example 'ZH', 'GE', 'VD', 'TI'. Leave out for Switzerland as a whole. |
| energy* | string | electricity or gas (natural gas). BR: electricity only (no gas). The figure is the regulated residential tariff (TE energy + TUSD network) before taxes and flag surcharges, as a posted price. CH: electricity only (no gas). A published regulated tariff, shown as a posted price. EU/NO/IS: Eurostat currently has no recent household gas price for CY, FI, IS, MT or NO (status no_matches). Business, EU/NO/IS/candidates: Eurostat's latest half-year may be missing for some countries or bands (status no_matches); try another band. Business GB: electricity or gas, pence per kWh converted to pounds per kWh. GB: electricity (single-rate) and gas, in GBP per kWh with the standing charge in extra. The Ofgem cap is a regulated maximum on default tariffs, not a price paid. Netherlands: electricity (euro per kWh) and gas (euro per m3, with a calculated euro per kWh in extra); national averages. NZ: electricity only (no gas). A modelled average from retail tariffs, shown as an official statistic. Sweden: electricity only (SCB publishes no household gas price); SEK per kWh, a national average. SG: electricity only (no gas). TW: electricity only (no gas). US: electricity = average residential price in US cents per kWh (Electric Power Monthly); gas = average residential natural gas price in US dollars per thousand cubic feet (Natural Gas Monthly). EIA gives gas per Mcf, not per kWh, so the two cannot be compared directly. Business US: electricity = average commercial-sector price (answered in US dollars per kWh, also in cents; the industrial-sector price is in the extras); gas = average commercial natural gas price in US dollars per thousand cubic feet (Mcf). EIA gives gas per Mcf, not per kWh, so the two cannot be compared directly. |
| region | string | NZ only: electricity network region, for example 'Auckland', 'Wellington', 'Christchurch', 'Dunedin'. Leave out for the unweighted median across all regions. |
| season | string | TW only: 'non_summer' (default) or 'summer' rates (Taipower charges more in summer). |
| sector | string | Whose price: 'household' (default: what homes pay) or 'business' (non-household consumers: what companies, shops, offices and factories pay; official average by annual-consumption band). Leave out for household. Use 'business' whenever the user asks about commercial, industrial, SME, company or non-domestic electricity or gas prices. Business figures exist only for the countries listed with 'business' below; for business the default taxes level is 'excl_vat' (businesses reclaim VAT). EU/NO/IS/candidate countries (Eurostat nrg_pc_205 and nrg_pc_203): sector=business is available; household prices come from the household source. GB: sector=business gives the DESNZ non-domestic prices; leave sector out for household (Ofgem price cap). US: sector=business gives the EIA commercial-sector average (shops, offices, hospitals, schools and other service businesses); household prices are the default. |
| country* | string | BR = Brazil (ANEEL: regulated residential electricity tariff per distributor, R$ per kWh before taxes); CH = Switzerland (ElCom: published household electricity tariff per kWh, CHF, Switzerland or one canton); EU member states plus NO and IS, as ISO codes (GR for Greece): AT = Austria, BE = Belgium, BG = Bulgaria, HR = Croatia, CY = Cyprus, CZ = Czechia, DK = Denmark, EE = Estonia, FI = Finland, FR = France, DE = Germany, GR = Greece, HU = Hungary, IE = Ireland, IT = Italy, LV = Latvia, LT = Lithuania, LU = Luxembourg, MT = Malta, NL = Netherlands, PL = Poland, PT = Portugal, RO = Romania, SK = Slovakia, SI = Slovenia, ES = Spain, SE = Sweden, NO = Norway, IS = Iceland; With sector=business, official average prices paid by businesses (Eurostat) for the EU member states, NO, IS and the EU candidate countries, as ISO codes (GR for Greece): AT, BE, BG, HR, CY, CZ, DK, EE, FI, FR, DE, GR, HU, IE, IT, LV, LT, LU, MT, NL, PL, PT, RO, SK, SI, ES, SE, NO, IS, AL, BA, GE, MD, ME, MK, RS, TR, UA; With sector=business, GB = United Kingdom (DESNZ: official average prices paid by non-domestic consumers, pence per kWh by size band, quarterly; household GB comes from Ofgem); GB = Great Britain (Ofgem energy price cap: maximum unit rate in pence per kWh and daily standing charge for default tariffs, by region and payment method, quarterly, a regulated posted price); NL = Netherlands (Statistics Netherlands CBS: average household electricity price in euro per kWh and gas price in euro per m3 by consumption class, half-yearly, official statistic); NZ = New Zealand (Electricity Authority: modelled average household electricity price per kWh incl. GST, by network region, NZD); SE = Sweden (Statistics Sweden SCB: average household electricity price in SEK per kWh by consumption band, half-yearly, official statistic); SG = Singapore (SP Group's published annual electricity tariff for domestic supplies, SGD per kWh excluding GST, a posted tariff); TW = Taiwan (Taipower's published residential electricity tariff: average price per kWh for a month's use, TWD, a posted tariff); US = United States (U.S. Energy Information Administration: average residential electricity price in cents per kWh and residential natural gas price in US$ per thousand cubic feet, by state, monthly); With sector=business, US = United States (EIA: average commercial-sector electricity price in cents per kWh and commercial natural gas price in US$ per thousand cubic feet, by state, monthly) |
| gb_region | string | GB only: Ofgem region (North Western England, North Eastern England, Yorkshire, Northern Scotland, Southern England, Southern Scotland, Merseyside and Northern Wales, London, South Eastern England, Eastern England, East Midlands, West Midlands, South Western England, Southern Wales) or a well-known town such as Manchester, Glasgow, Cardiff or London. Leave out for the Great Britain average. |
| distributor | string | BR only: the electricity distributor by ANEEL short name, for example 'CEMIG-D', 'ENEL SP', 'LIGHT', 'COPEL-DIS'. Leave out for the median of all distributors. |
| payment_method | string | GB only: direct_debit (default), standard_credit (pay on receipt of the bill) or prepayment (prepayment meter). |
| consumption_band | string | Standard consumption band (household bands, or the business bands when sector=business), by letter or by the publisher's code (the country notes list them). Leave out for the standard band. BR: not used (one residential tariff per distributor). CH: ElCom household profile H1 to H8 (default H4 = typical 5-room apartment with electric stove and dryer, about 4,500 kWh a year). The other profiles are listed in the answer. EU/NO/IS, annual consumption. Electricity: ALL = all consumption bands together; DA = under 1,000 kWh a year; DB = 1,000 to 2,499 kWh a year; DC = 2,500 to 4,999 kWh a year; DD = 5,000 to 14,999 kWh a year; DE = 15,000 kWh a year or more; default DC. Gas: ALL = all consumption bands together; D1 = under 20 GJ a year (under about 5,600 kWh); D2 = 20 to 199 GJ a year (about 5,600 to 55,000 kWh); D3 = 200 GJ a year or more (about 55,600 kWh and over); default D2. ALL = all bands together. Eurostat codes such as KWH2500-4999 or GJ20-199 also work. Business, EU/NO/IS/candidates, annual consumption of the business. Electricity: ALL = all consumption bands together; IA = under 20 MWh a year; IB = 20 to 499 MWh a year; IC = 500 to 1,999 MWh a year; ID = 2,000 to 19,999 MWh a year; IE = 20,000 to 69,999 MWh a year; IF = 70,000 to 149,999 MWh a year; IG = 150,000 MWh a year or more; default IC (Eurostat's reference band for medium-sized business consumers). Gas: I1 = under 1,000 GJ a year (under about 278 MWh); I2 = 1,000 to 9,999 GJ a year (about 278 to 2,777 MWh); I3 = 10,000 to 99,999 GJ a year (about 2,778 to 27,777 MWh); I4 = 100,000 to 999,999 GJ a year (about 27,778 to 277,777 MWh); I5 = 1,000,000 to 3,999,999 GJ a year (about 277,778 to 1,111,111 MWh); I6 = 4,000,000 GJ a year or more (about 1,111,112 MWh and over); default I3. Gas has no all-bands total; ALL works for electricity only. Eurostat codes such as MWH500-1999 or GJ10000-99999 also work. A small shop or office is typically IA or IB (electricity) and I1 (gas); a factory IC to IE. Business GB, annual consumption of the business, by DESNZ size band name or by the matching Eurostat letter. Electricity: Very Small (IA) = under 20 MWh a year; Small (IB) = 20 to 499 MWh a year; Small/Medium (IC) = 500 to 1,999 MWh a year; Medium (ID) = 2,000 to 19,999 MWh a year; Large (IE) = 20,000 to 69,999 MWh a year; Very Large (IF) = 70,000 to 150,000 MWh a year; Extra Large (IG) = over 150,000 MWh a year. Gas: Very Small (I1) = under 278 MWh a year; Small (I2) = 278 to 2,777 MWh a year; Medium (I3) = 2,778 to 27,777 MWh a year; Large (I4) = 27,778 to 277,777 MWh a year; Very Large (I5) = 277,778 to 1,111,112 MWh a year (no band above Very Large, so Eurostat I6 has no UK figure). Average = all bands together. Default: Small/Medium for electricity (= Eurostat IC) and Medium for gas (= I3). GB: not used (the cap is a unit rate and a standing charge, not a price by consumption band). Netherlands, annual consumption. Electricity: DA = under 1 MWh (1,000 kWh) a year; DB = 1 to 2.5 MWh (1,000 to 2,499 kWh) a year; DC = 2.5 to 5 MWh (2,500 to 4,999 kWh) a year; most households; DD = 5 to 15 MWh (5,000 to 14,999 kWh) a year; DE = 15 MWh (15,000 kWh) a year or more; default DC. Gas: D1 = under 569 m3 (under 20 GJ) a year; D2 = 569 to 5,687 m3 (20 to 200 GJ) a year; most households; D3 = 5,687 m3 (200 GJ) a year or more; default D2. NZ: 'standard' (default, standard household user) or 'low' (low user). Sweden, annual consumption: DA = under 1,000 kWh a year; DB = 1,000 to 2,499 kWh a year; DC = 2,500 to 4,999 kWh a year; DD = 5,000 to 14,999 kWh a year; DE = 15,000 kWh a year or more; default DC. SG: one flat domestic tariff; leave out. TW: monthly use: 'standard' (default, 330 kWh), 'low' (120 kWh), 'high' (700 kWh) or a number of kWh a month (1 to 5000). US: not used (EIA publishes one average for all residential customers in a state). Business US: not used (EIA publishes one commercial average per state, no consumption bands). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country",
"energy"
],
"properties": {
"state": {
"type": "string",
"description": "US only: the state, by name or postal code ('Texas', 'TX', 'DC'). Leave out for the U.S. average. Gas: EIA publishes no figure for a few states in recent months, then the newest published month is returned and the answer says so."
},
"taxes": {
"enum": [
"all",
"excl_vat",
"none"
],
"type": "string",
"description": "Tax level of the price. 'all' = all taxes and levies included (what a household pays, default); 'excl_vat' = excluding VAT and other recoverable taxes; 'none' = excluding all taxes and levies. BR: not used. ANEEL tariffs are always before taxes (ICMS, PIS/COFINS) and flag surcharges. CH: one published total (energy + grid use + charges + federal aid fee); leave taxes out. Business, EU/NO/IS/candidates: default 'excl_vat' (excluding VAT and other recoverable taxes and levies: what a business really bears); 'all' = all taxes and levies including VAT; 'none' = excluding all taxes and levies. Business GB: DESNZ prices never include VAT. Default 'excl_vat' = excluding VAT, including the Climate Change Levy (table 3.4.2); 'none' = also excluding the Climate Change Levy (table 3.4.1); 'all' gives the same figure as 'excl_vat' and the answer says so. GB: not used. Gas figures include 5% VAT; electricity has no VAT from 1 October 2026 to 31 March 2027 (Ofgem's own wording). Netherlands: all = CBS's price with VAT and taxes (default); excl_vat = without VAT, taxes in; none = without VAT and taxes. All three are published by CBS. NZ: prices always include GST (15%); only 'all' (or leaving it out) works. Sweden: all = SCB's total with electricity tax and VAT (default); excl_vat and none are calculated by ProofPrice from SCB's published parts. SG: not used; the figure excludes GST. TW: not used; the figure is the published tariff before any tax or surcharge. US: not used (EIA publishes one average per state). Business US: not used (EIA publishes one average per state)."
},
"canton": {
"type": "string",
"description": "CH only: canton by two-letter code, for example 'ZH', 'GE', 'VD', 'TI'. Leave out for Switzerland as a whole."
},
"energy": {
"enum": [
"electricity",
"gas"
],
"type": "string",
"description": "electricity or gas (natural gas). BR: electricity only (no gas). The figure is the regulated residential tariff (TE energy + TUSD network) before taxes and flag surcharges, as a posted price. CH: electricity only (no gas). A published regulated tariff, shown as a posted price. EU/NO/IS: Eurostat currently has no recent household gas price for CY, FI, IS, MT or NO (status no_matches). Business, EU/NO/IS/candidates: Eurostat's latest half-year may be missing for some countries or bands (status no_matches); try another band. Business GB: electricity or gas, pence per kWh converted to pounds per kWh. GB: electricity (single-rate) and gas, in GBP per kWh with the standing charge in extra. The Ofgem cap is a regulated maximum on default tariffs, not a price paid. Netherlands: electricity (euro per kWh) and gas (euro per m3, with a calculated euro per kWh in extra); national averages. NZ: electricity only (no gas). A modelled average from retail tariffs, shown as an official statistic. Sweden: electricity only (SCB publishes no household gas price); SEK per kWh, a national average. SG: electricity only (no gas). TW: electricity only (no gas). US: electricity = average residential price in US cents per kWh (Electric Power Monthly); gas = average residential natural gas price in US dollars per thousand cubic feet (Natural Gas Monthly). EIA gives gas per Mcf, not per kWh, so the two cannot be compared directly. Business US: electricity = average commercial-sector price (answered in US dollars per kWh, also in cents; the industrial-sector price is in the extras); gas = average commercial natural gas price in US dollars per thousand cubic feet (Mcf). EIA gives gas per Mcf, not per kWh, so the two cannot be compared directly."
},
"region": {
"type": "string",
"description": "NZ only: electricity network region, for example 'Auckland', 'Wellington', 'Christchurch', 'Dunedin'. Leave out for the unweighted median across all regions."
},
"season": {
"type": "string",
"description": "TW only: 'non_summer' (default) or 'summer' rates (Taipower charges more in summer)."
},
"sector": {
"enum": [
"household",
"business"
],
"type": "string",
"description": "Whose price: 'household' (default: what homes pay) or 'business' (non-household consumers: what companies, shops, offices and factories pay; official average by annual-consumption band). Leave out for household. Use 'business' whenever the user asks about commercial, industrial, SME, company or non-domestic electricity or gas prices. Business figures exist only for the countries listed with 'business' below; for business the default taxes level is 'excl_vat' (businesses reclaim VAT). EU/NO/IS/candidate countries (Eurostat nrg_pc_205 and nrg_pc_203): sector=business is available; household prices come from the household source. GB: sector=business gives the DESNZ non-domestic prices; leave sector out for household (Ofgem price cap). US: sector=business gives the EIA commercial-sector average (shops, offices, hospitals, schools and other service businesses); household prices are the default."
},
"country": {
"enum": [
"BR",
"CH",
"AT",
"BE",
"BG",
"HR",
"CY",
"CZ",
"DK",
"EE",
"FI",
"FR",
"DE",
"GR",
"HU",
"IE",
"IT",
"LV",
"LT",
"LU",
"MT",
"NL",
"PL",
"PT",
"RO",
"SK",
"SI",
"ES",
"SE",
"NO",
"IS",
"AL",
"BA",
"GE",
"MD",
"ME",
"MK",
"RS",
"TR",
"UA",
"GB",
"NZ",
"SG",
"TW",
"US"
],
"type": "string",
"description": "BR = Brazil (ANEEL: regulated residential electricity tariff per distributor, R$ per kWh before taxes); CH = Switzerland (ElCom: published household electricity tariff per kWh, CHF, Switzerland or one canton); EU member states plus NO and IS, as ISO codes (GR for Greece): AT = Austria, BE = Belgium, BG = Bulgaria, HR = Croatia, CY = Cyprus, CZ = Czechia, DK = Denmark, EE = Estonia, FI = Finland, FR = France, DE = Germany, GR = Greece, HU = Hungary, IE = Ireland, IT = Italy, LV = Latvia, LT = Lithuania, LU = Luxembourg, MT = Malta, NL = Netherlands, PL = Poland, PT = Portugal, RO = Romania, SK = Slovakia, SI = Slovenia, ES = Spain, SE = Sweden, NO = Norway, IS = Iceland; With sector=business, official average prices paid by businesses (Eurostat) for the EU member states, NO, IS and the EU candidate countries, as ISO codes (GR for Greece): AT, BE, BG, HR, CY, CZ, DK, EE, FI, FR, DE, GR, HU, IE, IT, LV, LT, LU, MT, NL, PL, PT, RO, SK, SI, ES, SE, NO, IS, AL, BA, GE, MD, ME, MK, RS, TR, UA; With sector=business, GB = United Kingdom (DESNZ: official average prices paid by non-domestic consumers, pence per kWh by size band, quarterly; household GB comes from Ofgem); GB = Great Britain (Ofgem energy price cap: maximum unit rate in pence per kWh and daily standing charge for default tariffs, by region and payment method, quarterly, a regulated posted price); NL = Netherlands (Statistics Netherlands CBS: average household electricity price in euro per kWh and gas price in euro per m3 by consumption class, half-yearly, official statistic); NZ = New Zealand (Electricity Authority: modelled average household electricity price per kWh incl. GST, by network region, NZD); SE = Sweden (Statistics Sweden SCB: average household electricity price in SEK per kWh by consumption band, half-yearly, official statistic); SG = Singapore (SP Group's published annual electricity tariff for domestic supplies, SGD per kWh excluding GST, a posted tariff); TW = Taiwan (Taipower's published residential electricity tariff: average price per kWh for a month's use, TWD, a posted tariff); US = United States (U.S. Energy Information Administration: average residential electricity price in cents per kWh and residential natural gas price in US$ per thousand cubic feet, by state, monthly); With sector=business, US = United States (EIA: average commercial-sector electricity price in cents per kWh and commercial natural gas price in US$ per thousand cubic feet, by state, monthly)"
},
"gb_region": {
"type": "string",
"description": "GB only: Ofgem region (North Western England, North Eastern England, Yorkshire, Northern Scotland, Southern England, Southern Scotland, Merseyside and Northern Wales, London, South Eastern England, Eastern England, East Midlands, West Midlands, South Western England, Southern Wales) or a well-known town such as Manchester, Glasgow, Cardiff or London. Leave out for the Great Britain average."
},
"distributor": {
"type": "string",
"description": "BR only: the electricity distributor by ANEEL short name, for example 'CEMIG-D', 'ENEL SP', 'LIGHT', 'COPEL-DIS'. Leave out for the median of all distributors."
},
"payment_method": {
"type": "string",
"description": "GB only: direct_debit (default), standard_credit (pay on receipt of the bill) or prepayment (prepayment meter)."
},
"consumption_band": {
"type": "string",
"description": "Standard consumption band (household bands, or the business bands when sector=business), by letter or by the publisher's code (the country notes list them). Leave out for the standard band. BR: not used (one residential tariff per distributor). CH: ElCom household profile H1 to H8 (default H4 = typical 5-room apartment with electric stove and dryer, about 4,500 kWh a year). The other profiles are listed in the answer. EU/NO/IS, annual consumption. Electricity: ALL = all consumption bands together; DA = under 1,000 kWh a year; DB = 1,000 to 2,499 kWh a year; DC = 2,500 to 4,999 kWh a year; DD = 5,000 to 14,999 kWh a year; DE = 15,000 kWh a year or more; default DC. Gas: ALL = all consumption bands together; D1 = under 20 GJ a year (under about 5,600 kWh); D2 = 20 to 199 GJ a year (about 5,600 to 55,000 kWh); D3 = 200 GJ a year or more (about 55,600 kWh and over); default D2. ALL = all bands together. Eurostat codes such as KWH2500-4999 or GJ20-199 also work. Business, EU/NO/IS/candidates, annual consumption of the business. Electricity: ALL = all consumption bands together; IA = under 20 MWh a year; IB = 20 to 499 MWh a year; IC = 500 to 1,999 MWh a year; ID = 2,000 to 19,999 MWh a year; IE = 20,000 to 69,999 MWh a year; IF = 70,000 to 149,999 MWh a year; IG = 150,000 MWh a year or more; default IC (Eurostat's reference band for medium-sized business consumers). Gas: I1 = under 1,000 GJ a year (under about 278 MWh); I2 = 1,000 to 9,999 GJ a year (about 278 to 2,777 MWh); I3 = 10,000 to 99,999 GJ a year (about 2,778 to 27,777 MWh); I4 = 100,000 to 999,999 GJ a year (about 27,778 to 277,777 MWh); I5 = 1,000,000 to 3,999,999 GJ a year (about 277,778 to 1,111,111 MWh); I6 = 4,000,000 GJ a year or more (about 1,111,112 MWh and over); default I3. Gas has no all-bands total; ALL works for electricity only. Eurostat codes such as MWH500-1999 or GJ10000-99999 also work. A small shop or office is typically IA or IB (electricity) and I1 (gas); a factory IC to IE. Business GB, annual consumption of the business, by DESNZ size band name or by the matching Eurostat letter. Electricity: Very Small (IA) = under 20 MWh a year; Small (IB) = 20 to 499 MWh a year; Small/Medium (IC) = 500 to 1,999 MWh a year; Medium (ID) = 2,000 to 19,999 MWh a year; Large (IE) = 20,000 to 69,999 MWh a year; Very Large (IF) = 70,000 to 150,000 MWh a year; Extra Large (IG) = over 150,000 MWh a year. Gas: Very Small (I1) = under 278 MWh a year; Small (I2) = 278 to 2,777 MWh a year; Medium (I3) = 2,778 to 27,777 MWh a year; Large (I4) = 27,778 to 277,777 MWh a year; Very Large (I5) = 277,778 to 1,111,112 MWh a year (no band above Very Large, so Eurostat I6 has no UK figure). Average = all bands together. Default: Small/Medium for electricity (= Eurostat IC) and Medium for gas (= I3). GB: not used (the cap is a unit rate and a standing charge, not a price by consumption band). Netherlands, annual consumption. Electricity: DA = under 1 MWh (1,000 kWh) a year; DB = 1 to 2.5 MWh (1,000 to 2,499 kWh) a year; DC = 2.5 to 5 MWh (2,500 to 4,999 kWh) a year; most households; DD = 5 to 15 MWh (5,000 to 14,999 kWh) a year; DE = 15 MWh (15,000 kWh) a year or more; default DC. Gas: D1 = under 569 m3 (under 20 GJ) a year; D2 = 569 to 5,687 m3 (20 to 200 GJ) a year; most households; D3 = 5,687 m3 (200 GJ) a year or more; default D2. NZ: 'standard' (default, standard household user) or 'low' (low user). Sweden, annual consumption: DA = under 1,000 kWh a year; DB = 1,000 to 2,499 kWh a year; DC = 2,500 to 4,999 kWh a year; DD = 5,000 to 14,999 kWh a year; DE = 15,000 kWh a year or more; default DC. SG: one flat domestic tariff; leave out. TW: monthly use: 'standard' (default, 330 kWh), 'low' (120 kWh), 'high' (700 kWh) or a number of kWh a month (1 to 5000). US: not used (EIA publishes one average for all residential customers in a state). Business US: not used (EIA publishes one commercial average per state, no consumption bands)."
}
}
}| product* | string | The crop or animal product, e.g. 'wheat', 'barley', 'oats', 'canola', 'soybeans', 'corn', 'potatoes', 'cattle', 'hogs', 'lambs', 'chickens', 'milk', 'eggs'. The full list is in the tool notes. Canada: a crop or animal product in everyday words, e.g. wheat, milling wheat, feed wheat, durum, oats, barley, feed barley, malt barley, soybeans, corn, flaxseed, canola, rye, lentils, dry peas, canary seed, potatoes, seed potatoes, table potatoes, processing potatoes, cattle, cows, steers, heifers, calves, lambs, feeder cattle, feeder steers, feeder heifers, feeder calves. Prices are in Canadian dollars in Statistics Canada's own unit for each series (per metric tonne for grains and oilseeds, per hundredweight for cattle, hogs and potatoes, per kilolitre for milk, per dozen for eggs); the answer names the unit. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country",
"product"
],
"properties": {
"region": {
"type": "string",
"description": "Region inside the country, as the statistics office publishes it (for example a province or state). Some countries publish no national figure, so the answer then asks for a region. Canada: a province is required (Ontario, Quebec, Saskatchewan, Alberta, Manitoba, British Columbia, Nova Scotia, New Brunswick, Prince Edward Island, Newfoundland and Labrador). Statistics Canada publishes no Canada total in this table. A city such as Saskatoon is answered with its province. Not every product is published for every province."
},
"country": {
"enum": [
"CA"
],
"type": "string",
"description": "CA = Canada (Statistics Canada: monthly average prices received by farmers, by province, official statistic, not a live price)"
},
"product": {
"type": "string",
"description": "The crop or animal product, e.g. 'wheat', 'barley', 'oats', 'canola', 'soybeans', 'corn', 'potatoes', 'cattle', 'hogs', 'lambs', 'chickens', 'milk', 'eggs'. The full list is in the tool notes. Canada: a crop or animal product in everyday words, e.g. wheat, milling wheat, feed wheat, durum, oats, barley, feed barley, malt barley, soybeans, corn, flaxseed, canola, rye, lentils, dry peas, canary seed, potatoes, seed potatoes, table potatoes, processing potatoes, cattle, cows, steers, heifers, calves, lambs, feeder cattle, feeder steers, feeder heifers, feeder calves. Prices are in Canadian dollars in Statistics Canada's own unit for each series (per metric tonne for grains and oilseeds, per hundredweight for cattle, hogs and potatoes, per kilolitre for milk, per dozen for eggs); the answer names the unit."
}
}
}| product* | string | The product, e.g. 'wheat', 'barley', 'beef', 'pig', 'lamb', 'chicken', 'eggs', 'milk', 'butter', 'olive oil', 'tomatoes', 'apples'. The full list is in the tool notes. EU: required. The product, by name; aliases such as 'pork', 'corn', 'tomato' are understood. Prices are weekly (raw milk monthly), per tonne for cereals and per 100 kg otherwise (piglets per head), each answer also gives the price per kg. Cereals (per tonne): wheat, milling wheat, feed wheat, durum wheat, barley, malting barley, maize, rye, oats, triticale. Beef (per 100 kg of carcass): beef, young bull, steer, heifer, cow, calf. Pigs, lamb and poultry meat (per 100 kg; piglets per head): pig, piglet, lamb, heavy lamb, light lamb, chicken, chicken breast, chicken legs. Eggs (per 100 kg): eggs, barn eggs, cage eggs, free range eggs, organic eggs. Milk and dairy (per 100 kg): milk, organic milk, butter, skimmed milk powder, whole milk powder, cheddar, gouda, edam, emmental, whey powder, cream, drinking milk. Olive oil (per 100 kg): olive oil, extra virgin olive oil, virgin olive oil, lampante olive oil. Fruit and vegetables (per 100 kg): apples, pears, peaches, nectarines, apricots, cherries, plums, strawberries, oranges, lemons, mandarins, clementines, bananas, table grapes, kiwis, melons, water melons, tomatoes, cucumbers, courgettes, peppers, egg plants, lettuces, cauliflowers, carrots, onions, cabbage, leeks, garlic, mushrooms, beans, asparagus, avocados. Products with several series (wheat: milling then feed; pig: class E; beef: adult male cattle indicative price) show the usual one and list the others in extra.other_series. Fruit and vegetables are only quoted in season. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country",
"product"
],
"properties": {
"country": {
"enum": [
"AT",
"BE",
"BG",
"HR",
"CY",
"CZ",
"DK",
"EE",
"FI",
"FR",
"DE",
"GR",
"HU",
"IE",
"IT",
"LV",
"LT",
"MT",
"NL",
"PL",
"PT",
"RO",
"SK",
"SI",
"ES",
"SE"
],
"type": "string",
"description": "EU member states, as ISO codes (GR for Greece): AT = Austria, BE = Belgium, BG = Bulgaria, HR = Croatia, CY = Cyprus, CZ = Czechia, DK = Denmark, EE = Estonia, FI = Finland, FR = France, DE = Germany, GR = Greece, HU = Hungary, IE = Ireland, IT = Italy, LV = Latvia, LT = Lithuania, MT = Malta, NL = Netherlands, PL = Poland, PT = Portugal, RO = Romania, SK = Slovakia, SI = Slovenia, ES = Spain, SE = Sweden. Not covered: LU (the portal holds no Luxembourg prices) and countries outside the EU such as GB and NO. Not every country reports every product (olive oil: ES, IT, PT, GR and HR only; dairy products about 16 countries); the answer says when a product is missing."
},
"product": {
"type": "string",
"description": "The product, e.g. 'wheat', 'barley', 'beef', 'pig', 'lamb', 'chicken', 'eggs', 'milk', 'butter', 'olive oil', 'tomatoes', 'apples'. The full list is in the tool notes. EU: required. The product, by name; aliases such as 'pork', 'corn', 'tomato' are understood. Prices are weekly (raw milk monthly), per tonne for cereals and per 100 kg otherwise (piglets per head), each answer also gives the price per kg. Cereals (per tonne): wheat, milling wheat, feed wheat, durum wheat, barley, malting barley, maize, rye, oats, triticale. Beef (per 100 kg of carcass): beef, young bull, steer, heifer, cow, calf. Pigs, lamb and poultry meat (per 100 kg; piglets per head): pig, piglet, lamb, heavy lamb, light lamb, chicken, chicken breast, chicken legs. Eggs (per 100 kg): eggs, barn eggs, cage eggs, free range eggs, organic eggs. Milk and dairy (per 100 kg): milk, organic milk, butter, skimmed milk powder, whole milk powder, cheddar, gouda, edam, emmental, whey powder, cream, drinking milk. Olive oil (per 100 kg): olive oil, extra virgin olive oil, virgin olive oil, lampante olive oil. Fruit and vegetables (per 100 kg): apples, pears, peaches, nectarines, apricots, cherries, plums, strawberries, oranges, lemons, mandarins, clementines, bananas, table grapes, kiwis, melons, water melons, tomatoes, cucumbers, courgettes, peppers, egg plants, lettuces, cauliflowers, carrots, onions, cabbage, leeks, garlic, mushrooms, beans, asparagus, avocados. Products with several series (wheat: milling then feed; pig: class E; beef: adult male cattle indicative price) show the usual one and list the others in extra.other_series. Fruit and vegetables are only quoted in season."
}
}
}| days | integer | How many recent days to include. Default 30. |
| fuel* | string | petrol95 = unleaded 95; methane = CNG (priced per kg). Queensland: diesel, petrol95 (= standard Unleaded, 91 RON), petrol98, e10, e85 or lpg. Brazil: petrol95 = regular petrol (gasolina comum, not RON 95) or diesel (= diesel S10). Other fuels are not covered. Ontario: petrol95 = regular unleaded, petrol98 = premium unleaded, diesel, propane, methane = compressed natural gas (per litre of gasoline equivalent). E10, E85, LPG and heating oil are not published. Canada: petrol95 = regular unleaded gasoline (87 AKI, about 91 RON), petrol98 = premium unleaded, diesel; self-service stations. E10, E85, LPG and CNG are not published. EU Weekly Oil Bulletin countries: petrol95 (Euro-super 95), diesel (automotive gas oil) or lpg, as a national average per litre in euro with all taxes; heating gas oil is in the extra fields. Other fuels are not published. France: petrol95 means SP95 only (about a quarter of French 95-octane stations, and the dearer fuel). Most stations sell E10 instead, which is a separate item and already available: ask for fuel=e10 for the common 95-octane petrol. Also diesel, petrol98 (SP98), e85 and lpg. GB: petrol95 (unleaded petrol, ULSP) or diesel (ULSD) only, as a national average in pounds per litre; other fuels are not published. Italy: diesel, petrol95, lpg, methane only. Mexico: petrol95 = regular petrol (gasolina regular, Magna), petrol98 = premium petrol, or diesel. Mexican grades are not 95 or 98 RON. MY: diesel, petrol95 (RON95, unsubsidised rate) or petrol98 (answered with RON97). Subsidised BUDI95/SKPS/SKDS prices are in extra.subsidised_myr_per_litre. Netherlands: petrol95 (Euro95), diesel or lpg, as a national daily average per litre in euro with VAT and excise. Premium petrol, E10, E85 and natural gas are not published. Norway: petrol95 (95-octane unleaded) or diesel, as a national monthly average per litre in NOK with taxes. Premium petrol, E10, E85, LPG and CNG are not published. NZ: diesel, or petrol95 (MBIE's Premium Petrol 95R; petrol98 gets the same series). Regular petrol 91 is returned in extra.other_fuels. TW: diesel (premium diesel), petrol95 (95 unleaded) or petrol98 (98 unleaded), in NT$ per litre with VAT and excise. 92 unleaded and 95E3 gasohol are in the extra fields. US: petrol95 = regular gasoline, petrol98 = premium gasoline, diesel = on-highway diesel (all types). For midgrade gasoline use petrol95 with gasoline_grade=midgrade. Prices are weekly averages in US dollars per gallon, taxes included (US$ per litre is in extra). EIA publishes no E10, E85, LPG or CNG prices. US heating: heating_oil = residential No. 2 heating oil, propane = residential propane, as a national weekly average in US dollars per gallon (per litre in extra). Collected only October to March, so in summer the newest week is from March. For gasoline and diesel use petrol95 or diesel. Uruguay: petrol95 (Super 95) or diesel (gasoil 10-S), as the regulated maximum price per litre in Uruguayan pesos with IVA; premium 97 and gasoil 50-S are in the extra fields. Other fuels are not published. |
| town | string | Town name. AU (Queensland only): suburb name, e.g. 'Mount Gravatt'. Small suburbs may have fewer than 5 stations. BR: municipality, e.g. 'São Paulo' or 'Curitiba'; add area when the name exists in several states. Ontario: one of Windsor, London, Peterborough, St. Catharines, Sudbury, Sault Ste. Marie, North Bay, Timmins, Kenora, Parry Sound, Toronto East, Toronto West, or Ontario / Southern Ontario / Northern Ontario for the averages. Ottawa, Thunder Bay and Toronto (city) are answered from Statistics Canada. Canada: one of the 18 cities Statistics Canada tracks (St. John's, Charlottetown and Summerside, Halifax, Saint John, Québec, Montréal, Ottawa-Gatineau, Toronto, Thunder Bay, Winnipeg, Regina, Saskatoon, Edmonton, Calgary, Vancouver, Victoria, Whitehorse, Yellowknife), or 'Canada' for the national average (regular unleaded only). Leave town and area out for the national average. ES: town name, e.g. 'Valencia'. EU Weekly Oil Bulletin countries: not used (national average only). GB: not used (national average only). IT: comune name, e.g. 'Bologna'. MX: not used for cities; a state name given here works like area. MY: not used. One national price per week; any place is answered with the Malaysia price and the answer says so. Netherlands: not used (national average only). Norway: not used (national average only). NZ: not used. MBIE publishes one national price per week; any place is answered with the New Zealand average and the answer says so. TW: not used. CPC posts one island-wide price; any place is answered with the Taiwan price and the answer says so. US: one of the ten cities EIA publishes (Boston, Chicago, Cleveland, Denver, Houston, Los Angeles, Miami, New York City, San Francisco, Seattle), gasoline only; otherwise the national average is returned and the answer says so. US heating oil and propane: not used (national average only). Uruguay: not used (national maximum price only). |
| months | integer | Instead of days: how many whole months of monthly history to return, where a source has loaded long history. |
| country* | string | AU = Australia, Queensland only (monthly station prices reported to the Queensland Government); BR = Brazil (ANP weekly survey: regular petrol and diesel S10); CA = Canada (Ontario markets only here: Ministry of Energy weekly average pump price in CAD per litre; other Canadian places come from Statistics Canada); CA = Canada (Statistics Canada: monthly average retail price by city, official statistic, not a live pump price); ES = Spain; EU Weekly Oil Bulletin, national average pump prices: IE = Ireland, AT = Austria, DE = Germany, NL = the Netherlands, BE = Belgium, PT = Portugal, PL = Poland, DK = Denmark, SE = Sweden, FI = Finland, LU = Luxembourg, GR = Greece, CZ = Czechia, SK = Slovakia, SI = Slovenia, HR = Croatia, HU = Hungary, RO = Romania, BG = Bulgaria, EE = Estonia, LV = Latvia, LT = Lithuania, CY = Cyprus, MT = Malta; FR = France; GB = United Kingdom (DESNZ weekly national average pump prices of unleaded petrol and diesel); IT = Italy; MX = Mexico (by state); MY = Malaysia (weekly government-set national price; an official published price, not a station price); NL = Netherlands (CBS: daily national average pump price, official statistic, a few days behind); NO = Norway (Statistics Norway: monthly national average pump price, official statistic, not a live pump price); NZ = New Zealand (MBIE weekly national average retail price; an official statistic, not a station price); TW = Taiwan (posted island-wide list price of CPC Corporation; a posted price, not a station price); US = United States (U.S. Energy Information Administration: weekly average retail gasoline and diesel prices in US$ per gallon for the nation, PADD regions, 9 states and 10 cities); US = United States (EIA: weekly national average residential heating oil and propane prices in US$ per gallon, October to March); UY = Uruguay (ANCAP: monthly maximum pump price set by decree, national, IVA included; not a station price) |
| service | string | Self-service or attended service, where a country prices them differently. Ontario: not used (the survey does not split self and full service). Canada: self only. Full-service prices stopped in 2013. EU Weekly Oil Bulletin countries: not used. GB: not used. IT: self-service (default) or attended service, which costs more. MY: not used. Netherlands: not used. Norway: not used. NZ: not used. TW: not used. US: not used. US heating oil and propane: not used. Uruguay: not used. |
| postcode | string | Postcode of the place. AU (Queensland only): 4-digit postcode starting with 4, e.g. '4122'. Most single postcodes have fewer than 5 stations of one fuel; use area 'Brisbane' or 'QLD' then. BR: not used (the survey is published by state and municipality). Ontario: not used. Canada: not used. ES: 5-digit postcode, e.g. '28001'. EU Weekly Oil Bulletin countries: not used; the bulletin publishes one national average per country, so the national figure is returned and says so. FR: 5-digit postcode, e.g. '75015'. GB: not used; DESNZ publishes one UK average, so the national figure is returned and says so. MX: not used. MY: not used (national price only). Netherlands: not used; CBS publishes one national average, so the national figure is returned and says so. Norway: not used; SSB publishes one national average, so the national figure is returned and says so. NZ: not used (national price only). TW: not used (island-wide price only). US: not used (EIA publishes no ZIP-code prices). US heating oil and propane: not used (national average only). Uruguay: not used; ANCAP publishes one national price, so the national figure is returned and says so. |
| gasoline_grade | string | US only: the gasoline grade EIA publishes. Overrides the grade implied by fuel (petrol95 = regular, petrol98 = premium); use midgrade here with fuel=petrol95. Not for diesel. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country",
"fuel"
],
"properties": {
"tax": {
"enum": [
"with",
"without"
],
"type": "string",
"description": "EU Weekly Oil Bulletin countries only: 'with' (default) = the pump price with all duties and taxes; 'without' = the Commission's price net of duties and taxes (VAT and excise removed), the basis many fuel-surcharge indices use. The answer states which. Other countries refuse it with a 400 (they publish pump prices with taxes only)."
},
"area": {
"type": "string",
"description": "Wider area when no postcode. AU (Queensland only): 'Brisbane' (postcodes 4000 to 4179) or 'QLD' (the whole state). A suburb name also works. BR: state as a two-letter code or name ('SP', 'Minas Gerais'); leave empty for all Brazil. Ontario: same as town (a market, or Ontario / Southern Ontario / Northern Ontario). Canada: same as town (a city, or 'Canada'). Provinces are not published. ES: province code ('28' = Madrid). EU Weekly Oil Bulletin countries: not used (national average only). FR: department ('69', '2A'). GB: not used (national average only). IT: province ('MI', 'RM'). MX: state name or code ('Ciudad de México', 'CDMX', 'Jalisco', 'NLE'); leave empty for all Mexico. Only states are available. MY: not used (national price only). Netherlands: not used (national average only). Norway: not used (national average only). NZ: not used (national price only). TW: not used (island-wide price only). US: a state ('TX', 'California') or PADD region ('Gulf Coast', 'PADD 1B', 'West Coast'); leave empty for the national average. EIA publishes gasoline for CA, CO, FL, MA, MN, NY, OH, TX and WA, diesel only for California plus the nation and PADD regions. Any other place gets the national average, and the answer says so (with its region as context). US heating oil and propane: not used (national average only). Uruguay: not used (national maximum price only)."
},
"days": {
"type": "integer",
"maximum": 366,
"minimum": 2,
"description": "How many recent days to include. Default 30."
},
"fuel": {
"enum": [
"diesel",
"petrol95",
"petrol98",
"e10",
"e85",
"lpg",
"methane",
"heating_oil",
"propane"
],
"type": "string",
"description": "petrol95 = unleaded 95; methane = CNG (priced per kg). Queensland: diesel, petrol95 (= standard Unleaded, 91 RON), petrol98, e10, e85 or lpg. Brazil: petrol95 = regular petrol (gasolina comum, not RON 95) or diesel (= diesel S10). Other fuels are not covered. Ontario: petrol95 = regular unleaded, petrol98 = premium unleaded, diesel, propane, methane = compressed natural gas (per litre of gasoline equivalent). E10, E85, LPG and heating oil are not published. Canada: petrol95 = regular unleaded gasoline (87 AKI, about 91 RON), petrol98 = premium unleaded, diesel; self-service stations. E10, E85, LPG and CNG are not published. EU Weekly Oil Bulletin countries: petrol95 (Euro-super 95), diesel (automotive gas oil) or lpg, as a national average per litre in euro with all taxes; heating gas oil is in the extra fields. Other fuels are not published. France: petrol95 means SP95 only (about a quarter of French 95-octane stations, and the dearer fuel). Most stations sell E10 instead, which is a separate item and already available: ask for fuel=e10 for the common 95-octane petrol. Also diesel, petrol98 (SP98), e85 and lpg. GB: petrol95 (unleaded petrol, ULSP) or diesel (ULSD) only, as a national average in pounds per litre; other fuels are not published. Italy: diesel, petrol95, lpg, methane only. Mexico: petrol95 = regular petrol (gasolina regular, Magna), petrol98 = premium petrol, or diesel. Mexican grades are not 95 or 98 RON. MY: diesel, petrol95 (RON95, unsubsidised rate) or petrol98 (answered with RON97). Subsidised BUDI95/SKPS/SKDS prices are in extra.subsidised_myr_per_litre. Netherlands: petrol95 (Euro95), diesel or lpg, as a national daily average per litre in euro with VAT and excise. Premium petrol, E10, E85 and natural gas are not published. Norway: petrol95 (95-octane unleaded) or diesel, as a national monthly average per litre in NOK with taxes. Premium petrol, E10, E85, LPG and CNG are not published. NZ: diesel, or petrol95 (MBIE's Premium Petrol 95R; petrol98 gets the same series). Regular petrol 91 is returned in extra.other_fuels. TW: diesel (premium diesel), petrol95 (95 unleaded) or petrol98 (98 unleaded), in NT$ per litre with VAT and excise. 92 unleaded and 95E3 gasohol are in the extra fields. US: petrol95 = regular gasoline, petrol98 = premium gasoline, diesel = on-highway diesel (all types). For midgrade gasoline use petrol95 with gasoline_grade=midgrade. Prices are weekly averages in US dollars per gallon, taxes included (US$ per litre is in extra). EIA publishes no E10, E85, LPG or CNG prices. US heating: heating_oil = residential No. 2 heating oil, propane = residential propane, as a national weekly average in US dollars per gallon (per litre in extra). Collected only October to March, so in summer the newest week is from March. For gasoline and diesel use petrol95 or diesel. Uruguay: petrol95 (Super 95) or diesel (gasoil 10-S), as the regulated maximum price per litre in Uruguayan pesos with IVA; premium 97 and gasoil 50-S are in the extra fields. Other fuels are not published."
},
"town": {
"type": "string",
"description": "Town name. AU (Queensland only): suburb name, e.g. 'Mount Gravatt'. Small suburbs may have fewer than 5 stations. BR: municipality, e.g. 'São Paulo' or 'Curitiba'; add area when the name exists in several states. Ontario: one of Windsor, London, Peterborough, St. Catharines, Sudbury, Sault Ste. Marie, North Bay, Timmins, Kenora, Parry Sound, Toronto East, Toronto West, or Ontario / Southern Ontario / Northern Ontario for the averages. Ottawa, Thunder Bay and Toronto (city) are answered from Statistics Canada. Canada: one of the 18 cities Statistics Canada tracks (St. John's, Charlottetown and Summerside, Halifax, Saint John, Québec, Montréal, Ottawa-Gatineau, Toronto, Thunder Bay, Winnipeg, Regina, Saskatoon, Edmonton, Calgary, Vancouver, Victoria, Whitehorse, Yellowknife), or 'Canada' for the national average (regular unleaded only). Leave town and area out for the national average. ES: town name, e.g. 'Valencia'. EU Weekly Oil Bulletin countries: not used (national average only). GB: not used (national average only). IT: comune name, e.g. 'Bologna'. MX: not used for cities; a state name given here works like area. MY: not used. One national price per week; any place is answered with the Malaysia price and the answer says so. Netherlands: not used (national average only). Norway: not used (national average only). NZ: not used. MBIE publishes one national price per week; any place is answered with the New Zealand average and the answer says so. TW: not used. CPC posts one island-wide price; any place is answered with the Taiwan price and the answer says so. US: one of the ten cities EIA publishes (Boston, Chicago, Cleveland, Denver, Houston, Los Angeles, Miami, New York City, San Francisco, Seattle), gasoline only; otherwise the national average is returned and the answer says so. US heating oil and propane: not used (national average only). Uruguay: not used (national maximum price only)."
},
"months": {
"type": "integer",
"maximum": 360,
"minimum": 2,
"description": "Instead of days: how many whole months of monthly history to return, where a source has loaded long history."
},
"country": {
"enum": [
"AU",
"BR",
"CA",
"ES",
"IE",
"AT",
"DE",
"NL",
"BE",
"PT",
"PL",
"DK",
"SE",
"FI",
"LU",
"GR",
"CZ",
"SK",
"SI",
"HR",
"HU",
"RO",
"BG",
"EE",
"LV",
"LT",
"CY",
"MT",
"FR",
"GB",
"IT",
"MX",
"MY",
"NO",
"NZ",
"TW",
"US",
"UY"
],
"type": "string",
"description": "AU = Australia, Queensland only (monthly station prices reported to the Queensland Government); BR = Brazil (ANP weekly survey: regular petrol and diesel S10); CA = Canada (Ontario markets only here: Ministry of Energy weekly average pump price in CAD per litre; other Canadian places come from Statistics Canada); CA = Canada (Statistics Canada: monthly average retail price by city, official statistic, not a live pump price); ES = Spain; EU Weekly Oil Bulletin, national average pump prices: IE = Ireland, AT = Austria, DE = Germany, NL = the Netherlands, BE = Belgium, PT = Portugal, PL = Poland, DK = Denmark, SE = Sweden, FI = Finland, LU = Luxembourg, GR = Greece, CZ = Czechia, SK = Slovakia, SI = Slovenia, HR = Croatia, HU = Hungary, RO = Romania, BG = Bulgaria, EE = Estonia, LV = Latvia, LT = Lithuania, CY = Cyprus, MT = Malta; FR = France; GB = United Kingdom (DESNZ weekly national average pump prices of unleaded petrol and diesel); IT = Italy; MX = Mexico (by state); MY = Malaysia (weekly government-set national price; an official published price, not a station price); NL = Netherlands (CBS: daily national average pump price, official statistic, a few days behind); NO = Norway (Statistics Norway: monthly national average pump price, official statistic, not a live pump price); NZ = New Zealand (MBIE weekly national average retail price; an official statistic, not a station price); TW = Taiwan (posted island-wide list price of CPC Corporation; a posted price, not a station price); US = United States (U.S. Energy Information Administration: weekly average retail gasoline and diesel prices in US$ per gallon for the nation, PADD regions, 9 states and 10 cities); US = United States (EIA: weekly national average residential heating oil and propane prices in US$ per gallon, October to March); UY = Uruguay (ANCAP: monthly maximum pump price set by decree, national, IVA included; not a station price)"
},
"service": {
"enum": [
"self",
"served"
],
"type": "string",
"description": "Self-service or attended service, where a country prices them differently. Ontario: not used (the survey does not split self and full service). Canada: self only. Full-service prices stopped in 2013. EU Weekly Oil Bulletin countries: not used. GB: not used. IT: self-service (default) or attended service, which costs more. MY: not used. Netherlands: not used. Norway: not used. NZ: not used. TW: not used. US: not used. US heating oil and propane: not used. Uruguay: not used."
},
"postcode": {
"type": "string",
"description": "Postcode of the place. AU (Queensland only): 4-digit postcode starting with 4, e.g. '4122'. Most single postcodes have fewer than 5 stations of one fuel; use area 'Brisbane' or 'QLD' then. BR: not used (the survey is published by state and municipality). Ontario: not used. Canada: not used. ES: 5-digit postcode, e.g. '28001'. EU Weekly Oil Bulletin countries: not used; the bulletin publishes one national average per country, so the national figure is returned and says so. FR: 5-digit postcode, e.g. '75015'. GB: not used; DESNZ publishes one UK average, so the national figure is returned and says so. MX: not used. MY: not used (national price only). Netherlands: not used; CBS publishes one national average, so the national figure is returned and says so. Norway: not used; SSB publishes one national average, so the national figure is returned and says so. NZ: not used (national price only). TW: not used (island-wide price only). US: not used (EIA publishes no ZIP-code prices). US heating oil and propane: not used (national average only). Uruguay: not used; ANCAP publishes one national price, so the national figure is returned and says so."
},
"gasoline_grade": {
"enum": [
"regular",
"midgrade",
"premium"
],
"type": "string",
"description": "US only: the gasoline grade EIA publishes. Overrides the grade implied by fuel (petrol95 = regular, petrol98 = premium); use midgrade here with fuel=petrol95. Not for diesel."
}
}
}| Argument | Type | Description |
|---|---|---|
| tax | string | EU Weekly Oil Bulletin countries only: 'with' (default) = the pump price with all duties and taxes; 'without' = the Commission's price net of duties and taxes (VAT and excise removed), the basis many fuel-surcharge indices use. The answer states which. Other countries refuse it with a 400 (they publish pump prices with taxes only). |
| area | string | Wider area when no postcode. AU (Queensland only): 'Brisbane' (postcodes 4000 to 4179) or 'QLD' (the whole state). A suburb name also works. BR: state as a two-letter code or name ('SP', 'Minas Gerais'); leave empty for all Brazil. Ontario: same as town (a market, or Ontario / Southern Ontario / Northern Ontario). Canada: same as town (a city, or 'Canada'). Provinces are not published. ES: province code ('28' = Madrid). EU Weekly Oil Bulletin countries: not used (national average only). FR: department ('69', '2A'). GB: not used (national average only). IT: province ('MI', 'RM'). MX: state name or code ('Ciudad de México', 'CDMX', 'Jalisco', 'NLE'); leave empty for all Mexico. Only states are available. MY: not used (national price only). Netherlands: not used (national average only). Norway: not used (national average only). NZ: not used (national price only). TW: not used (island-wide price only). US: a state ('TX', 'California') or PADD region ('Gulf Coast', 'PADD 1B', 'West Coast'); leave empty for the national average. EIA publishes gasoline for CA, CO, FL, MA, MN, NY, OH, TX and WA, diesel only for California plus the nation and PADD regions. Any other place gets the national average, and the answer says so (with its region as context). US heating oil and propane: not used (national average only). Uruguay: not used (national maximum price only). |
| fuel* | string | petrol95 = unleaded 95; methane = CNG (priced per kg). Queensland: diesel, petrol95 (= standard Unleaded, 91 RON), petrol98, e10, e85 or lpg. Brazil: petrol95 = regular petrol (gasolina comum, not RON 95) or diesel (= diesel S10). Other fuels are not covered. Ontario: petrol95 = regular unleaded, petrol98 = premium unleaded, diesel, propane, methane = compressed natural gas (per litre of gasoline equivalent). E10, E85, LPG and heating oil are not published. Canada: petrol95 = regular unleaded gasoline (87 AKI, about 91 RON), petrol98 = premium unleaded, diesel; self-service stations. E10, E85, LPG and CNG are not published. EU Weekly Oil Bulletin countries: petrol95 (Euro-super 95), diesel (automotive gas oil) or lpg, as a national average per litre in euro with all taxes; heating gas oil is in the extra fields. Other fuels are not published. France: petrol95 means SP95 only (about a quarter of French 95-octane stations, and the dearer fuel). Most stations sell E10 instead, which is a separate item and already available: ask for fuel=e10 for the common 95-octane petrol. Also diesel, petrol98 (SP98), e85 and lpg. GB: petrol95 (unleaded petrol, ULSP) or diesel (ULSD) only, as a national average in pounds per litre; other fuels are not published. Italy: diesel, petrol95, lpg, methane only. Mexico: petrol95 = regular petrol (gasolina regular, Magna), petrol98 = premium petrol, or diesel. Mexican grades are not 95 or 98 RON. MY: diesel, petrol95 (RON95, unsubsidised rate) or petrol98 (answered with RON97). Subsidised BUDI95/SKPS/SKDS prices are in extra.subsidised_myr_per_litre. Netherlands: petrol95 (Euro95), diesel or lpg, as a national daily average per litre in euro with VAT and excise. Premium petrol, E10, E85 and natural gas are not published. Norway: petrol95 (95-octane unleaded) or diesel, as a national monthly average per litre in NOK with taxes. Premium petrol, E10, E85, LPG and CNG are not published. NZ: diesel, or petrol95 (MBIE's Premium Petrol 95R; petrol98 gets the same series). Regular petrol 91 is returned in extra.other_fuels. TW: diesel (premium diesel), petrol95 (95 unleaded) or petrol98 (98 unleaded), in NT$ per litre with VAT and excise. 92 unleaded and 95E3 gasohol are in the extra fields. US: petrol95 = regular gasoline, petrol98 = premium gasoline, diesel = on-highway diesel (all types). For midgrade gasoline use petrol95 with gasoline_grade=midgrade. Prices are weekly averages in US dollars per gallon, taxes included (US$ per litre is in extra). EIA publishes no E10, E85, LPG or CNG prices. US heating: heating_oil = residential No. 2 heating oil, propane = residential propane, as a national weekly average in US dollars per gallon (per litre in extra). Collected only October to March, so in summer the newest week is from March. For gasoline and diesel use petrol95 or diesel. Uruguay: petrol95 (Super 95) or diesel (gasoil 10-S), as the regulated maximum price per litre in Uruguayan pesos with IVA; premium 97 and gasoil 50-S are in the extra fields. Other fuels are not published. |
| town | string | Town name. AU (Queensland only): suburb name, e.g. 'Mount Gravatt'. Small suburbs may have fewer than 5 stations. BR: municipality, e.g. 'São Paulo' or 'Curitiba'; add area when the name exists in several states. Ontario: one of Windsor, London, Peterborough, St. Catharines, Sudbury, Sault Ste. Marie, North Bay, Timmins, Kenora, Parry Sound, Toronto East, Toronto West, or Ontario / Southern Ontario / Northern Ontario for the averages. Ottawa, Thunder Bay and Toronto (city) are answered from Statistics Canada. Canada: one of the 18 cities Statistics Canada tracks (St. John's, Charlottetown and Summerside, Halifax, Saint John, Québec, Montréal, Ottawa-Gatineau, Toronto, Thunder Bay, Winnipeg, Regina, Saskatoon, Edmonton, Calgary, Vancouver, Victoria, Whitehorse, Yellowknife), or 'Canada' for the national average (regular unleaded only). Leave town and area out for the national average. ES: town name, e.g. 'Valencia'. EU Weekly Oil Bulletin countries: not used (national average only). GB: not used (national average only). IT: comune name, e.g. 'Bologna'. MX: not used for cities; a state name given here works like area. MY: not used. One national price per week; any place is answered with the Malaysia price and the answer says so. Netherlands: not used (national average only). Norway: not used (national average only). NZ: not used. MBIE publishes one national price per week; any place is answered with the New Zealand average and the answer says so. TW: not used. CPC posts one island-wide price; any place is answered with the Taiwan price and the answer says so. US: one of the ten cities EIA publishes (Boston, Chicago, Cleveland, Denver, Houston, Los Angeles, Miami, New York City, San Francisco, Seattle), gasoline only; otherwise the national average is returned and the answer says so. US heating oil and propane: not used (national average only). Uruguay: not used (national maximum price only). |
| country* | string | AU = Australia, Queensland only (monthly station prices reported to the Queensland Government); BR = Brazil (ANP weekly survey: regular petrol and diesel S10); CA = Canada (Ontario markets only here: Ministry of Energy weekly average pump price in CAD per litre; other Canadian places come from Statistics Canada); CA = Canada (Statistics Canada: monthly average retail price by city, official statistic, not a live pump price); ES = Spain; EU Weekly Oil Bulletin, national average pump prices: IE = Ireland, AT = Austria, DE = Germany, NL = the Netherlands, BE = Belgium, PT = Portugal, PL = Poland, DK = Denmark, SE = Sweden, FI = Finland, LU = Luxembourg, GR = Greece, CZ = Czechia, SK = Slovakia, SI = Slovenia, HR = Croatia, HU = Hungary, RO = Romania, BG = Bulgaria, EE = Estonia, LV = Latvia, LT = Lithuania, CY = Cyprus, MT = Malta; FR = France; GB = United Kingdom (DESNZ weekly national average pump prices of unleaded petrol and diesel); IT = Italy; MX = Mexico (by state); MY = Malaysia (weekly government-set national price; an official published price, not a station price); NL = Netherlands (CBS: daily national average pump price, official statistic, a few days behind); NO = Norway (Statistics Norway: monthly national average pump price, official statistic, not a live pump price); NZ = New Zealand (MBIE weekly national average retail price; an official statistic, not a station price); TW = Taiwan (posted island-wide list price of CPC Corporation; a posted price, not a station price); US = United States (U.S. Energy Information Administration: weekly average retail gasoline and diesel prices in US$ per gallon for the nation, PADD regions, 9 states and 10 cities); US = United States (EIA: weekly national average residential heating oil and propane prices in US$ per gallon, October to March); UY = Uruguay (ANCAP: monthly maximum pump price set by decree, national, IVA included; not a station price) |
| service | string | Self-service or attended service, where a country prices them differently. Ontario: not used (the survey does not split self and full service). Canada: self only. Full-service prices stopped in 2013. EU Weekly Oil Bulletin countries: not used. GB: not used. IT: self-service (default) or attended service, which costs more. MY: not used. Netherlands: not used. Norway: not used. NZ: not used. TW: not used. US: not used. US heating oil and propane: not used. Uruguay: not used. |
| postcode | string | Postcode of the place. AU (Queensland only): 4-digit postcode starting with 4, e.g. '4122'. Most single postcodes have fewer than 5 stations of one fuel; use area 'Brisbane' or 'QLD' then. BR: not used (the survey is published by state and municipality). Ontario: not used. Canada: not used. ES: 5-digit postcode, e.g. '28001'. EU Weekly Oil Bulletin countries: not used; the bulletin publishes one national average per country, so the national figure is returned and says so. FR: 5-digit postcode, e.g. '75015'. GB: not used; DESNZ publishes one UK average, so the national figure is returned and says so. MX: not used. MY: not used (national price only). Netherlands: not used; CBS publishes one national average, so the national figure is returned and says so. Norway: not used; SSB publishes one national average, so the national figure is returned and says so. NZ: not used (national price only). TW: not used (island-wide price only). US: not used (EIA publishes no ZIP-code prices). US heating oil and propane: not used (national average only). Uruguay: not used; ANCAP publishes one national price, so the national figure is returned and says so. |
| gasoline_grade | string | US only: the gasoline grade EIA publishes. Overrides the grade implied by fuel (petrol95 = regular, petrol98 = premium); use midgrade here with fuel=petrol95. Not for diesel. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country",
"fuel"
],
"properties": {
"tax": {
"enum": [
"with",
"without"
],
"type": "string",
"description": "EU Weekly Oil Bulletin countries only: 'with' (default) = the pump price with all duties and taxes; 'without' = the Commission's price net of duties and taxes (VAT and excise removed), the basis many fuel-surcharge indices use. The answer states which. Other countries refuse it with a 400 (they publish pump prices with taxes only)."
},
"area": {
"type": "string",
"description": "Wider area when no postcode. AU (Queensland only): 'Brisbane' (postcodes 4000 to 4179) or 'QLD' (the whole state). A suburb name also works. BR: state as a two-letter code or name ('SP', 'Minas Gerais'); leave empty for all Brazil. Ontario: same as town (a market, or Ontario / Southern Ontario / Northern Ontario). Canada: same as town (a city, or 'Canada'). Provinces are not published. ES: province code ('28' = Madrid). EU Weekly Oil Bulletin countries: not used (national average only). FR: department ('69', '2A'). GB: not used (national average only). IT: province ('MI', 'RM'). MX: state name or code ('Ciudad de México', 'CDMX', 'Jalisco', 'NLE'); leave empty for all Mexico. Only states are available. MY: not used (national price only). Netherlands: not used (national average only). Norway: not used (national average only). NZ: not used (national price only). TW: not used (island-wide price only). US: a state ('TX', 'California') or PADD region ('Gulf Coast', 'PADD 1B', 'West Coast'); leave empty for the national average. EIA publishes gasoline for CA, CO, FL, MA, MN, NY, OH, TX and WA, diesel only for California plus the nation and PADD regions. Any other place gets the national average, and the answer says so (with its region as context). US heating oil and propane: not used (national average only). Uruguay: not used (national maximum price only)."
},
"fuel": {
"enum": [
"diesel",
"petrol95",
"petrol98",
"e10",
"e85",
"lpg",
"methane",
"heating_oil",
"propane"
],
"type": "string",
"description": "petrol95 = unleaded 95; methane = CNG (priced per kg). Queensland: diesel, petrol95 (= standard Unleaded, 91 RON), petrol98, e10, e85 or lpg. Brazil: petrol95 = regular petrol (gasolina comum, not RON 95) or diesel (= diesel S10). Other fuels are not covered. Ontario: petrol95 = regular unleaded, petrol98 = premium unleaded, diesel, propane, methane = compressed natural gas (per litre of gasoline equivalent). E10, E85, LPG and heating oil are not published. Canada: petrol95 = regular unleaded gasoline (87 AKI, about 91 RON), petrol98 = premium unleaded, diesel; self-service stations. E10, E85, LPG and CNG are not published. EU Weekly Oil Bulletin countries: petrol95 (Euro-super 95), diesel (automotive gas oil) or lpg, as a national average per litre in euro with all taxes; heating gas oil is in the extra fields. Other fuels are not published. France: petrol95 means SP95 only (about a quarter of French 95-octane stations, and the dearer fuel). Most stations sell E10 instead, which is a separate item and already available: ask for fuel=e10 for the common 95-octane petrol. Also diesel, petrol98 (SP98), e85 and lpg. GB: petrol95 (unleaded petrol, ULSP) or diesel (ULSD) only, as a national average in pounds per litre; other fuels are not published. Italy: diesel, petrol95, lpg, methane only. Mexico: petrol95 = regular petrol (gasolina regular, Magna), petrol98 = premium petrol, or diesel. Mexican grades are not 95 or 98 RON. MY: diesel, petrol95 (RON95, unsubsidised rate) or petrol98 (answered with RON97). Subsidised BUDI95/SKPS/SKDS prices are in extra.subsidised_myr_per_litre. Netherlands: petrol95 (Euro95), diesel or lpg, as a national daily average per litre in euro with VAT and excise. Premium petrol, E10, E85 and natural gas are not published. Norway: petrol95 (95-octane unleaded) or diesel, as a national monthly average per litre in NOK with taxes. Premium petrol, E10, E85, LPG and CNG are not published. NZ: diesel, or petrol95 (MBIE's Premium Petrol 95R; petrol98 gets the same series). Regular petrol 91 is returned in extra.other_fuels. TW: diesel (premium diesel), petrol95 (95 unleaded) or petrol98 (98 unleaded), in NT$ per litre with VAT and excise. 92 unleaded and 95E3 gasohol are in the extra fields. US: petrol95 = regular gasoline, petrol98 = premium gasoline, diesel = on-highway diesel (all types). For midgrade gasoline use petrol95 with gasoline_grade=midgrade. Prices are weekly averages in US dollars per gallon, taxes included (US$ per litre is in extra). EIA publishes no E10, E85, LPG or CNG prices. US heating: heating_oil = residential No. 2 heating oil, propane = residential propane, as a national weekly average in US dollars per gallon (per litre in extra). Collected only October to March, so in summer the newest week is from March. For gasoline and diesel use petrol95 or diesel. Uruguay: petrol95 (Super 95) or diesel (gasoil 10-S), as the regulated maximum price per litre in Uruguayan pesos with IVA; premium 97 and gasoil 50-S are in the extra fields. Other fuels are not published."
},
"town": {
"type": "string",
"description": "Town name. AU (Queensland only): suburb name, e.g. 'Mount Gravatt'. Small suburbs may have fewer than 5 stations. BR: municipality, e.g. 'São Paulo' or 'Curitiba'; add area when the name exists in several states. Ontario: one of Windsor, London, Peterborough, St. Catharines, Sudbury, Sault Ste. Marie, North Bay, Timmins, Kenora, Parry Sound, Toronto East, Toronto West, or Ontario / Southern Ontario / Northern Ontario for the averages. Ottawa, Thunder Bay and Toronto (city) are answered from Statistics Canada. Canada: one of the 18 cities Statistics Canada tracks (St. John's, Charlottetown and Summerside, Halifax, Saint John, Québec, Montréal, Ottawa-Gatineau, Toronto, Thunder Bay, Winnipeg, Regina, Saskatoon, Edmonton, Calgary, Vancouver, Victoria, Whitehorse, Yellowknife), or 'Canada' for the national average (regular unleaded only). Leave town and area out for the national average. ES: town name, e.g. 'Valencia'. EU Weekly Oil Bulletin countries: not used (national average only). GB: not used (national average only). IT: comune name, e.g. 'Bologna'. MX: not used for cities; a state name given here works like area. MY: not used. One national price per week; any place is answered with the Malaysia price and the answer says so. Netherlands: not used (national average only). Norway: not used (national average only). NZ: not used. MBIE publishes one national price per week; any place is answered with the New Zealand average and the answer says so. TW: not used. CPC posts one island-wide price; any place is answered with the Taiwan price and the answer says so. US: one of the ten cities EIA publishes (Boston, Chicago, Cleveland, Denver, Houston, Los Angeles, Miami, New York City, San Francisco, Seattle), gasoline only; otherwise the national average is returned and the answer says so. US heating oil and propane: not used (national average only). Uruguay: not used (national maximum price only)."
},
"country": {
"enum": [
"AU",
"BR",
"CA",
"ES",
"IE",
"AT",
"DE",
"NL",
"BE",
"PT",
"PL",
"DK",
"SE",
"FI",
"LU",
"GR",
"CZ",
"SK",
"SI",
"HR",
"HU",
"RO",
"BG",
"EE",
"LV",
"LT",
"CY",
"MT",
"FR",
"GB",
"IT",
"MX",
"MY",
"NO",
"NZ",
"TW",
"US",
"UY"
],
"type": "string",
"description": "AU = Australia, Queensland only (monthly station prices reported to the Queensland Government); BR = Brazil (ANP weekly survey: regular petrol and diesel S10); CA = Canada (Ontario markets only here: Ministry of Energy weekly average pump price in CAD per litre; other Canadian places come from Statistics Canada); CA = Canada (Statistics Canada: monthly average retail price by city, official statistic, not a live pump price); ES = Spain; EU Weekly Oil Bulletin, national average pump prices: IE = Ireland, AT = Austria, DE = Germany, NL = the Netherlands, BE = Belgium, PT = Portugal, PL = Poland, DK = Denmark, SE = Sweden, FI = Finland, LU = Luxembourg, GR = Greece, CZ = Czechia, SK = Slovakia, SI = Slovenia, HR = Croatia, HU = Hungary, RO = Romania, BG = Bulgaria, EE = Estonia, LV = Latvia, LT = Lithuania, CY = Cyprus, MT = Malta; FR = France; GB = United Kingdom (DESNZ weekly national average pump prices of unleaded petrol and diesel); IT = Italy; MX = Mexico (by state); MY = Malaysia (weekly government-set national price; an official published price, not a station price); NL = Netherlands (CBS: daily national average pump price, official statistic, a few days behind); NO = Norway (Statistics Norway: monthly national average pump price, official statistic, not a live pump price); NZ = New Zealand (MBIE weekly national average retail price; an official statistic, not a station price); TW = Taiwan (posted island-wide list price of CPC Corporation; a posted price, not a station price); US = United States (U.S. Energy Information Administration: weekly average retail gasoline and diesel prices in US$ per gallon for the nation, PADD regions, 9 states and 10 cities); US = United States (EIA: weekly national average residential heating oil and propane prices in US$ per gallon, October to March); UY = Uruguay (ANCAP: monthly maximum pump price set by decree, national, IVA included; not a station price)"
},
"service": {
"enum": [
"self",
"served"
],
"type": "string",
"description": "Self-service or attended service, where a country prices them differently. Ontario: not used (the survey does not split self and full service). Canada: self only. Full-service prices stopped in 2013. EU Weekly Oil Bulletin countries: not used. GB: not used. IT: self-service (default) or attended service, which costs more. MY: not used. Netherlands: not used. Norway: not used. NZ: not used. TW: not used. US: not used. US heating oil and propane: not used. Uruguay: not used."
},
"postcode": {
"type": "string",
"description": "Postcode of the place. AU (Queensland only): 4-digit postcode starting with 4, e.g. '4122'. Most single postcodes have fewer than 5 stations of one fuel; use area 'Brisbane' or 'QLD' then. BR: not used (the survey is published by state and municipality). Ontario: not used. Canada: not used. ES: 5-digit postcode, e.g. '28001'. EU Weekly Oil Bulletin countries: not used; the bulletin publishes one national average per country, so the national figure is returned and says so. FR: 5-digit postcode, e.g. '75015'. GB: not used; DESNZ publishes one UK average, so the national figure is returned and says so. MX: not used. MY: not used (national price only). Netherlands: not used; CBS publishes one national average, so the national figure is returned and says so. Norway: not used; SSB publishes one national average, so the national figure is returned and says so. NZ: not used (national price only). TW: not used (island-wide price only). US: not used (EIA publishes no ZIP-code prices). US heating oil and propane: not used (national average only). Uruguay: not used; ANCAP publishes one national price, so the national figure is returned and says so."
},
"gasoline_grade": {
"enum": [
"regular",
"midgrade",
"premium"
],
"type": "string",
"description": "US only: the gasoline grade EIA publishes. Overrides the grade implied by fuel (petrol95 = regular, petrol98 = premium); use midgrade here with fuel=petrol95. Not for diesel."
}
}
}| Argument | Type | Description |
|---|---|---|
| item* | string | Everyday item in plain words, e.g. 'milk', 'white bread', 'eggs', 'butter', 'coffee', 'bananas', 'beer'. Each country measures its own standard pack or cut; the answer names it and lists other definitions. Canada: Statistics Canada's 110 standard products, each in one standard size, e.g. milk, 1 litre milk, 4 litre milk, soy milk, nut milk, cream, butter, margarine, cheese, yogurt, eggs, ground beef, steak, sirloin. Milk is published per 1, 2 and 4 litres (2 litres by default); the answer names the exact product and lists the other sizes. GB: ONS's product types, each in one pack size, e.g. eggs (free-range, pack of 12), milk (whole, 4 pints), semi-skimmed milk (2 pints), bread (sliced white, 800 g), butter (250 g), cheese (cheddar, per kg), chicken (whole, per kg), beef mince (per kg), bananas, apples, potatoes (per kg), rice, pasta, instant coffee, tea bags, sugar, lager, wine. HK: a grocery category in English ('milk', 'eggs', 'rice', 'bread', 'honey', 'peanut butter', 'instant noodles', 'cooking oil', 'beer'). The answer is the median and range of shelf prices of the products in that category (brands and pack sizes differ), per kg or per litre where the pack size is known, otherwise per pack; it names the category and lists related ones. IE: the CSO's standard items, e.g. milk (full-fat, 2 litres), white bread (800 g sliced pan), eggs (large, half dozen), butter (per lb), cheese (Irish cheddar), chicken (whole bird), bananas, potatoes, sugar, tea bags, beer (can of lager), wine (75 cl), whiskey, pint of stout or lager (bar). The CSO has no coffee, mince or cereal. LV: the CSB's standard items, e.g. milk (1 l), bread (wheat, 1 kg; also rye bread), eggs (10), butter (1 kg), cheese (1 kg), chicken (1 kg), potatoes, apples, bananas, sugar, coffee, tea bags, beer (1 l), wine (1 l), vodka. MX: an everyday product in English or Spanish ('milk', 'eggs', 'tortilla', 'rice', 'beans', 'sugar', 'cooking oil', 'leche', 'huevo', 'frijol'). Profeco names products in Spanish with a pack size, so the answer names the exact product and pack and lists related ones. The 120 products priced in the most shops are held. MY: an everyday item in English or Malay ('chicken', 'eggs', 'rice', 'cooking oil', 'sugar', 'milk', 'onion', 'cabbage', 'ayam', 'telur'). DOSM names items in Malay with the pack size, so the answer names the exact item and lists related ones. Staples (chicken, eggs, rice, oil, flour, fish, fruit, vegetables, milk) and about 40 other well-covered items are held. WFP countries: a staple food in plain words ('rice', 'wheat flour', 'maize', 'beans', 'sugar', 'cooking oil', 'milk', 'onions', 'tomatoes', 'chicken'). WFP names foods its own way, e.g. 'Rice (high quality)'; the answer names the food and lists other definitions. Add 'wholesale' for wholesale prices, otherwise retail. US: the BLS's standard items, e.g. eggs (grade A large, per dozen), milk (whole, per gallon), bread (white pan bread, per lb), butter, cheddar cheese, chicken, ground beef, steak, bacon, bananas, oranges, potatoes, tomatoes, rice, pasta, flour, sugar, coffee (ground, per lb), soft drinks, beer, wine, ice cream. BLS has no tea or apples (dropped) and publishes most items per pound. |
| region | string | Region inside the country, only where the statistics office publishes regional averages. Leave out for the national average. Canada: leave out for the Canada average, or give a province (Ontario, BC, Quebec ...), Whitehorse (or Yukon) or Yellowknife (or Northwest Territories). A city such as Toronto is answered with its province's average. The two territories start in September 2025 and lack some products. GB: leave out for the whole UK, or give an English region (North East, North West, Yorkshire and the Humber, East Midlands, West Midlands, East of England, London, South East, South West), Scotland, Wales or Northern Ireland (a big city maps to its region). ONS withholds a regional figure when fewer than ten observations stand behind it. HK: a supermarket chain ('Wellcome', 'ParknShop', 'Jasons', 'AEON'); leave out for all chains together. A chain needs 5 or more shelf prices in the category. IE: national averages only; a region is ignored and the answer says so. LV: national averages only; a region is ignored and the answer says so. MX: a state ('Jalisco', 'Nuevo Leon', 'Ciudad de Mexico', 'Yucatan', 'CDMX'); leave out for the national figure. A state needs 5 or more shops pricing the product. MY: a state ('Selangor', 'Johor', 'Sabah', 'Penang', 'Kuala Lumpur'); leave out for the national figure. A state needs 5 or more shops pricing the item. WFP countries: leave out. Figures are a spread across the country's surveyed markets. US: leave out for the U.S. city average, or give northeast, midwest, south or west (a US state maps to its region). BLS publishes no state or city averages for food. |
| country* | string | CA = Canada (Statistics Canada: monthly average retail prices of 110 selected products, national and provincial, official statistic, not a live price); GB = United Kingdom (Office for National Statistics: median shop prices of about 200 grocery and drink product types, monthly, UK and 12 regions and nations); HK = Hong Kong; IE = Ireland (Central Statistics Office: national average shop prices of about 76 standard items, monthly); LV = Latvia (Central Statistical Bureau: national average shop prices of about 130 food and drink items, monthly); MX = Mexico; MY = Malaysia; Countries as ISO codes: AF = Afghanistan, AM = Armenia, BD = Bangladesh, BF = Burkina Faso, BI = Burundi, BJ = Benin, BO = Bolivia, CD = Democratic Republic of the Congo, CF = Central African Republic, CI = Cote d'Ivoire, CM = Cameroon, DJ = Djibouti, ET = Ethiopia, GM = Gambia, GN = Guinea, GW = Guinea-Bissau, HT = Haiti, ID = Indonesia, IN = India, IQ = Iraq, JO = Jordan, KG = Kyrgyzstan, LA = Laos, LB = Lebanon, LR = Liberia, LS = Lesotho, ML = Mali, MM = Myanmar, MR = Mauritania, MW = Malawi, MZ = Mozambique, NE = Niger, NG = Nigeria, NP = Nepal, PH = Philippines, PK = Pakistan, RW = Rwanda, SD = Sudan, SL = Sierra Leone, SN = Senegal, SO = Somalia, SS = South Sudan, TD = Chad, TG = Togo, TL = Timor-Leste, TZ = Tanzania, UA = Ukraine, UG = Uganda, YE = Yemen, ZW = Zimbabwe. World Food Programme market surveys of staple foods; a country with no recent survey of 5 or more markets answers 'no matches'.; US = United States (Bureau of Labor Statistics: average retail prices of about 45 standard food and drink items, monthly, national and four regions) |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country",
"item"
],
"properties": {
"item": {
"type": "string",
"description": "Everyday item in plain words, e.g. 'milk', 'white bread', 'eggs', 'butter', 'coffee', 'bananas', 'beer'. Each country measures its own standard pack or cut; the answer names it and lists other definitions. Canada: Statistics Canada's 110 standard products, each in one standard size, e.g. milk, 1 litre milk, 4 litre milk, soy milk, nut milk, cream, butter, margarine, cheese, yogurt, eggs, ground beef, steak, sirloin. Milk is published per 1, 2 and 4 litres (2 litres by default); the answer names the exact product and lists the other sizes. GB: ONS's product types, each in one pack size, e.g. eggs (free-range, pack of 12), milk (whole, 4 pints), semi-skimmed milk (2 pints), bread (sliced white, 800 g), butter (250 g), cheese (cheddar, per kg), chicken (whole, per kg), beef mince (per kg), bananas, apples, potatoes (per kg), rice, pasta, instant coffee, tea bags, sugar, lager, wine. HK: a grocery category in English ('milk', 'eggs', 'rice', 'bread', 'honey', 'peanut butter', 'instant noodles', 'cooking oil', 'beer'). The answer is the median and range of shelf prices of the products in that category (brands and pack sizes differ), per kg or per litre where the pack size is known, otherwise per pack; it names the category and lists related ones. IE: the CSO's standard items, e.g. milk (full-fat, 2 litres), white bread (800 g sliced pan), eggs (large, half dozen), butter (per lb), cheese (Irish cheddar), chicken (whole bird), bananas, potatoes, sugar, tea bags, beer (can of lager), wine (75 cl), whiskey, pint of stout or lager (bar). The CSO has no coffee, mince or cereal. LV: the CSB's standard items, e.g. milk (1 l), bread (wheat, 1 kg; also rye bread), eggs (10), butter (1 kg), cheese (1 kg), chicken (1 kg), potatoes, apples, bananas, sugar, coffee, tea bags, beer (1 l), wine (1 l), vodka. MX: an everyday product in English or Spanish ('milk', 'eggs', 'tortilla', 'rice', 'beans', 'sugar', 'cooking oil', 'leche', 'huevo', 'frijol'). Profeco names products in Spanish with a pack size, so the answer names the exact product and pack and lists related ones. The 120 products priced in the most shops are held. MY: an everyday item in English or Malay ('chicken', 'eggs', 'rice', 'cooking oil', 'sugar', 'milk', 'onion', 'cabbage', 'ayam', 'telur'). DOSM names items in Malay with the pack size, so the answer names the exact item and lists related ones. Staples (chicken, eggs, rice, oil, flour, fish, fruit, vegetables, milk) and about 40 other well-covered items are held. WFP countries: a staple food in plain words ('rice', 'wheat flour', 'maize', 'beans', 'sugar', 'cooking oil', 'milk', 'onions', 'tomatoes', 'chicken'). WFP names foods its own way, e.g. 'Rice (high quality)'; the answer names the food and lists other definitions. Add 'wholesale' for wholesale prices, otherwise retail. US: the BLS's standard items, e.g. eggs (grade A large, per dozen), milk (whole, per gallon), bread (white pan bread, per lb), butter, cheddar cheese, chicken, ground beef, steak, bacon, bananas, oranges, potatoes, tomatoes, rice, pasta, flour, sugar, coffee (ground, per lb), soft drinks, beer, wine, ice cream. BLS has no tea or apples (dropped) and publishes most items per pound."
},
"region": {
"type": "string",
"description": "Region inside the country, only where the statistics office publishes regional averages. Leave out for the national average. Canada: leave out for the Canada average, or give a province (Ontario, BC, Quebec ...), Whitehorse (or Yukon) or Yellowknife (or Northwest Territories). A city such as Toronto is answered with its province's average. The two territories start in September 2025 and lack some products. GB: leave out for the whole UK, or give an English region (North East, North West, Yorkshire and the Humber, East Midlands, West Midlands, East of England, London, South East, South West), Scotland, Wales or Northern Ireland (a big city maps to its region). ONS withholds a regional figure when fewer than ten observations stand behind it. HK: a supermarket chain ('Wellcome', 'ParknShop', 'Jasons', 'AEON'); leave out for all chains together. A chain needs 5 or more shelf prices in the category. IE: national averages only; a region is ignored and the answer says so. LV: national averages only; a region is ignored and the answer says so. MX: a state ('Jalisco', 'Nuevo Leon', 'Ciudad de Mexico', 'Yucatan', 'CDMX'); leave out for the national figure. A state needs 5 or more shops pricing the product. MY: a state ('Selangor', 'Johor', 'Sabah', 'Penang', 'Kuala Lumpur'); leave out for the national figure. A state needs 5 or more shops pricing the item. WFP countries: leave out. Figures are a spread across the country's surveyed markets. US: leave out for the U.S. city average, or give northeast, midwest, south or west (a US state maps to its region). BLS publishes no state or city averages for food."
},
"country": {
"enum": [
"CA",
"GB",
"HK",
"IE",
"LV",
"MX",
"MY",
"AF",
"AM",
"BD",
"BF",
"BI",
"BJ",
"BO",
"CD",
"CF",
"CI",
"CM",
"DJ",
"ET",
"GM",
"GN",
"GW",
"HT",
"ID",
"IN",
"IQ",
"JO",
"KG",
"LA",
"LB",
"LR",
"LS",
"ML",
"MM",
"MR",
"MW",
"MZ",
"NE",
"NG",
"NP",
"PH",
"PK",
"RW",
"SD",
"SL",
"SN",
"SO",
"SS",
"TD",
"TG",
"TL",
"TZ",
"UA",
"UG",
"YE",
"ZW",
"US"
],
"type": "string",
"description": "CA = Canada (Statistics Canada: monthly average retail prices of 110 selected products, national and provincial, official statistic, not a live price); GB = United Kingdom (Office for National Statistics: median shop prices of about 200 grocery and drink product types, monthly, UK and 12 regions and nations); HK = Hong Kong; IE = Ireland (Central Statistics Office: national average shop prices of about 76 standard items, monthly); LV = Latvia (Central Statistical Bureau: national average shop prices of about 130 food and drink items, monthly); MX = Mexico; MY = Malaysia; Countries as ISO codes: AF = Afghanistan, AM = Armenia, BD = Bangladesh, BF = Burkina Faso, BI = Burundi, BJ = Benin, BO = Bolivia, CD = Democratic Republic of the Congo, CF = Central African Republic, CI = Cote d'Ivoire, CM = Cameroon, DJ = Djibouti, ET = Ethiopia, GM = Gambia, GN = Guinea, GW = Guinea-Bissau, HT = Haiti, ID = Indonesia, IN = India, IQ = Iraq, JO = Jordan, KG = Kyrgyzstan, LA = Laos, LB = Lebanon, LR = Liberia, LS = Lesotho, ML = Mali, MM = Myanmar, MR = Mauritania, MW = Malawi, MZ = Mozambique, NE = Niger, NG = Nigeria, NP = Nepal, PH = Philippines, PK = Pakistan, RW = Rwanda, SD = Sudan, SL = Sierra Leone, SN = Senegal, SO = Somalia, SS = South Sudan, TD = Chad, TG = Togo, TL = Timor-Leste, TZ = Tanzania, UA = Ukraine, UG = Uganda, YE = Yemen, ZW = Zimbabwe. World Food Programme market surveys of staple foods; a country with no recent survey of 5 or more markets answers 'no matches'.; US = United States (Bureau of Labor Statistics: average retail prices of about 45 standard food and drink items, monthly, national and four regions)"
}
}
}| age_group |
| string |
| Age group: adult (26+, default), young_adult (19-25) or child (0-18). |
| franchise | integer | Annual deductible in local currency; the values available depend on the country notes. Default: the lowest one for the age group. CH: adults and young adults 300, 500, 1000, 1500, 2000 or 2500 CHF; children 0, 100, 200, 300, 400, 500 or 600 CHF. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country"
],
"properties": {
"area": {
"type": "string",
"minLength": 2,
"description": "Region (see the country notes), e.g. a canton code such as 'ZH'. Leave out for the whole country. CH: a canton code (AG, AI, AR, BE, BL, BS, FR, GE, GL, GR, JU, LU, NE, NW, OW, SG, SH, SO, SZ, TG, TI, UR, VD, VS, ZG, ZH); leave out for all of Switzerland. Premium regions inside a canton are pooled."
},
"model": {
"enum": [
"standard",
"alternative"
],
"type": "string",
"description": "standard = free choice of doctor (default); alternative = family-doctor, telemedicine or HMO models with a restricted choice."
},
"country": {
"enum": [
"CH"
],
"type": "string",
"description": "CH = Switzerland (compulsory basic health insurance)"
},
"accident": {
"enum": [
"with",
"without"
],
"type": "string",
"description": "Whether accident cover is included in the premium. Default: without for adults and young adults, with for children."
},
"age_group": {
"enum": [
"adult",
"young_adult",
"child"
],
"type": "string",
"description": "Age group: adult (26+, default), young_adult (19-25) or child (0-18)."
},
"franchise": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Annual deductible in local currency; the values available depend on the country notes. Default: the lowest one for the age group. CH: adults and young adults 300, 500, 1000, 1500, 2000 or 2500 CHF; children 0, 100, 200, 300, 400, 500 or 600 CHF."
}
}
}| Argument | Type | Description |
|---|---|---|
| town | string | Town or city. AT: a municipality among the 100 largest ('Wien' / 'Vienna', 'Graz', 'Linz', 'Salzburg', 'Innsbruck'), a district ('Wien 2' for Leopoldstadt, 'Bezirk Baden', 'Kitzbühel'), or a Bundesland ('Tirol', 'Niederösterreich' / 'Lower Austria'). Omit for Austria. Official annual medians per m², not a list of sales. AU: a state or territory ('Victoria', 'NSW', 'Queensland', 'Tasmania', 'ACT'), or a city or town that lies in one ('Melbourne', 'Parramatta', 'Perth'). The ABS publishes by state and territory only, so a city is answered with its state (and the answer says so). Omit for Australia as a whole. BE: a municipality in Dutch, French or English ('Antwerpen' / 'Antwerp' / 'Anvers', 'Gent' / 'Ghent', 'Brussel' / 'Bruxelles' / 'Brussels', 'Liège'), or a province ('province of Namur') or region ('Flanders', 'Wallonia', 'Brussels Capital Region'). Omit for Belgium. Official Statbel medians, not a list of sales. CA (British Columbia): a municipality, rural area or regional district, e.g. Kelowna, Victoria, Surrey, 'Prince George', 'Quesnel Rural', 'Greater Vancouver'. Omit for the whole province. Other provinces are not covered. DK: a municipality or town ('København' or 'Copenhagen', 'Aarhus' or 'Århus', 'Odense', 'Aalborg'), a province ('Fyn', 'Østjylland', 'Nordsjælland') or a region ('Hovedstaden', 'Syddanmark'), with or without æ ø å. Statistics Denmark publishes by province, so a municipality is answered with the province it lies in (and the answer says which). Omit for Denmark as a whole. BG HR CY CZ DE EE ES HU IS IT LV LT LU MT PL RO SI SK: ignored; Eurostat publishes one national index per country (PL: a town is answered by the Polish price register instead). The answer is an index (2015 = 100), not a price in euros. FI: a municipality ('Helsinki' or 'Helsingfors', 'Espoo', 'Tampere', 'Oulu', 'Hämeenlinna'), a region ('Uusimaa', 'Pirkanmaa'), 'Greater Helsinki', with or without ä ö å. Omit for Finland as a whole. Larger cities, regions and the country have quarterly figures (with the official price-index changes); other municipalities have the latest yearly figure. FR: town, e.g. 'Bordeaux', or use postcode. GB: the Royal Mail POSTAL TOWN as the Land Registry files it, e.g. 'Bristol'. It can be wider than the council area: 'Bristol' also takes in Bradley Stoke and Filton (South Gloucestershire), and every London sale is filed under 'London', so a London borough such as 'Camden' is not a town. For a council area or London borough use district. Give town or district. GB Scotland / Northern Ireland: 'Scotland', 'Northern Ireland' or a council area ('Edinburgh', 'Glasgow', 'Aberdeen', 'Fife', 'Highland', 'Belfast', 'Derry', 'Lisburn and Castlereagh'). Answered with the official monthly UK House Price Index average, not a list of sales. HU: 'Budapest', a statistical region ('Pest', 'Central Transdanubia', 'Western Transdanubia', 'Southern Transdanubia', 'Northern Hungary', 'Northern Great Plain', 'Southern Great Plain') or a county or big city that names one ('Debrecen', 'Győr', 'Pécs', 'Szeged'), or 'Hungary'. A town is answered at the level of its region. Without a town the Eurostat price index answers instead. IE: a county ('Cork') or Dublin postal district ('Dublin 6'). Omit for all of Ireland. NL: a municipality ('Amsterdam', 'Den Haag' / 'The Hague' / 's-Gravenhage, 'Utrecht') or a province ('Noord-Holland'). Omit for the national average. Official CBS annual average, not a list of sales. NO: a municipality ('Oslo', 'Bergen', 'Tromsø' or 'Tromso', 'Stavanger') or a county ('Rogaland', 'Vestland'), Norwegian or Sami spelling, with or without æ ø å. Omit for the whole country. Answers are Statistics Norway's published average price per m² (NOK) with the number of sales, not a list of sales. PL: a city, required (Warsaw, Krakow, Lodz, Wroclaw, Poznan, Gdansk, Gdynia, Szczecin, Lublin, Katowice, Bydgoszcz, Bialystok, Rzeszow, Torun, Kielce, Olsztyn, Opole, Radom, Czestochowa); Polish or English spelling. Flats only. A city county is read as a whole; districts are not available. PT: a municipality INE publishes ('Lisboa' / 'Lisbon', 'Porto' / 'Oporto', 'Cascais', 'Faro', 'Funchal' ... 58 in all) or a region ('Algarve', 'Grande Lisboa', 'Madeira', 'Açores'). Omit for Portugal as a whole. Official INE median per m² of the last 12 months of sales, not a list of sales. SE: a municipality ('Stockholm', 'Göteborg' or 'Gothenburg', 'Malmö' or 'Malmo', 'Uppsala'), a county ('Skåne', 'Stockholms län') or a metropolitan area ('Greater Gothenburg'), with or without å ä ö. Omit for Sweden as a whole. Answers are Statistics Sweden's published average purchase price (SEK per home) with the number of sales, not a list of sales. SG: required, one of the 26 HDB towns, e.g. 'Tampines', 'Ang Mo Kio', 'Bukit Merah', 'Kallang/Whampoa', 'Central Area' (case, hyphens and ', Singapore' are forgiven; 'Kallang' and 'CBD' are understood). TW: a city or county in English or Chinese ('Taipei' / '台北市' / '臺北市', 'New Taipei', 'Taichung', 'Kaohsiung', 'Tainan', 'Taoyuan', 'Hsinchu City', 'Hsinchu County'), or a district with its city ("Da'an, Taipei", '臺北市大安區', 'Banqiao, New Taipei'). Omit for all of Taiwan. A district name used in several cities ('Zhongzheng', 'Dongqu') needs the city too. US: a Connecticut town ('Hartford'), a New York City borough or neighborhood ('Brooklyn', 'Williamsburg'), 'Chicago', 'Cook County' or a Cook County assessment township ('Evanston', 'Oak Park'). Add the state if a name exists in two places ('Hartford, CT'). Required unless postcode is a New York City ZIP. |
| state | string | US only: 'CT' (Connecticut), 'NY' (New York City) or 'IL' (Cook County). Usually inferred from the place; set it when a name exists in two of them. |
| county | string | IE only: same as town; a county such as 'Dublin' or 'Cork'. |
| months | integer | How many recent months to include. Default 12. AT: ignored; STATISTIK AUSTRIA publishes one figure per calendar year (the latest is returned). AU: not used; the ABS publishes one mean price per quarter. BE: ignored; Statbel publishes quarters, half-years and years, and the latest period with a figure for the place is returned. CA: up to 4 gives the latest 3 months, more gives the latest 12 months. By default the latest 3 months, widening to 12 when a place is quiet. The figure is an average of declared values, not a median. DK: not used; Statistics Denmark publishes one average per quarter. BG HR CY CZ DE EE ES HU IS IT LV LT LU MT PL RO SI SK: ignored; the newest quarter with a figure is returned, with the change over the previous quarter and over a year. FI: not used; Statistics Finland publishes one average per quarter (postcodes, cities) or year (municipalities). GB Scotland / Northern Ireland: ignored; the newest published month is returned. HU: ignored; KSH publishes one figure per calendar year (the latest is returned). IE: rounded to the nearest of 3, 6, 12, 24 or 36. NL: ignored; CBS publishes one average per calendar year (the latest is returned). NO: not used; Statistics Norway publishes one figure per quarter and the answer gives the latest quarter plus the previous one and a year earlier. PL: 1 to 6 months of 30 days up to today; default 3. Large cities are read as a sample of up to 300 records per 30 days (the answer says so). PT: ignored; INE publishes one median per quarter, covering the 12 months to the quarter's end (the latest is returned). SE: not used; Statistics Sweden publishes one figure per year (municipalities, flats) or quarter (counties). TW: 12 or 24 whole calendar months; up to 18 gives 12 (24 if a place has too few sales in 12), more gives 24. The window ends at the last month that is at least 30 days old. US: 1 to 36 months back from the latest sale in the file (New York City: up to 12). |
| country* | string | AT = Austria (official STATISTIK AUSTRIA median price per m² of houses and flats, annual); AU = Australia (the Australian Bureau of Statistics' official mean price of residential dwellings, by state and territory; an official statistic of the whole dwelling stock, not individual sales and not a suburb price); BE = Belgium (official Statbel median sale prices by property type, quarterly); CA = Canada, British Columbia only (Property Transfer Tax data: average declared value of residential transfers, by municipality); DK = Denmark (official average price per property from Statistics Denmark, by province and region; an official statistic, not individual sales); Eurostat house price index (2015 = 100, an official index, NOT a price in money) for: BG = Bulgaria, HR = Croatia, CY = Cyprus, CZ = Czechia, DE = Germany, EE = Estonia, ES = Spain, HU = Hungary, IS = Iceland, IT = Italy, LV = Latvia, LT = Lithuania, LU = Luxembourg, MT = Malta, PL = Poland, RO = Romania, SK = Slovakia, SI = Slovenia; FI = Finland (official average price per m² of old dwellings in housing companies from Statistics Finland, by municipality, region or postcode; an official statistic, not individual sales); FR = France (DVF); GB = England & Wales (HM Land Registry); GB = England & Wales (HM Land Registry sales); Scotland and Northern Ireland (official UK House Price Index average); HU = Hungary (official KSH average price per m² of used and new dwellings, annual, by region and settlement type; with no town the Eurostat house price index answers); IE = Ireland (Property Price Register); NL = Netherlands (official CBS average sale price per municipality, annual); NO = Norway (official average price per m² from Statistics Norway, by municipality or county; an official statistic, not individual sales); PL = Poland (national Real Estate Price Register: notarised flat sales in the 19 biggest cities); PT = Portugal (official INE median sale price per m², quarterly, by region and municipality); SE = Sweden (official average purchase price from Statistics Sweden, by municipality or county; an official statistic, not individual sales); SG = Singapore HDB resale flats; TW = Taiwan (Ministry of the Interior actual price registration: every registered sale, summarised by city or county and district); US = United States, partial: Connecticut, New York City and Cook County IL (Chicago area) only; not nationwide |
| district | string | GB only: local authority (council area or London borough) as the Land Registry records it, e.g. 'Camden', 'City of Bristol', 'South Gloucestershire'. Use it instead of town for a London borough or when the postal town is wider than the place you mean. |
| postcode | string | Postcode, for a precise area. AT: only Vienna postcodes (1010 to 1230) are matched, to the Vienna district; elsewhere give the town or district as town. AU: a 4-digit postcode ('2150'), answered with the state or territory it lies in (the ABS has no postcode figures). BE: not supported (Statbel publishes by municipality); give the municipality as town. CA: not supported; BC publishes by municipality, so give the municipality as town. DK: not supported (Statistics Denmark publishes by province and region); give town instead. BG HR CY CZ DE EE ES HU IS IT LV LT LU MT PL RO SI SK: not supported (national index only). FI: a five-digit postcode (for example 00100): the latest yearly figure for that postal code area. Flats are published by number of rooms, so the answer is the room size with most transactions and the others are listed. FR: 5-digit postcode, e.g. '69003'; use instead of town for a precise area. HU: not supported (KSH publishes regions, not postcodes). NL: not supported (CBS publishes by municipality); give the municipality as town. NO: not supported (Statistics Norway publishes by municipality); give town instead. PL: not supported; give the city as town. PT: not supported (INE publishes by region and municipality); give the municipality as town. SE: not supported (Statistics Sweden publishes by municipality); give town instead. TW: not supported (the register has no postcodes); give the city, county or district as town. US: 5-digit ZIP code, New York City only (Connecticut and Cook County have no ZIP in the public file). |
| flat_type | string | SG only: HDB flat type. |
| settlement | string | HU only: type of settlement inside a region: all (default), county_seat, towns or villages. Budapest has one figure. |
| property_type | string | Kind of home. Default 'any'. AT: house or apartment (flats). The figure is the price per m² of living area. With no type given the headline is the flat figure and both medians are in extra.by_type. There is no figure for both together or for villas, detached, semi-detached or terraced homes. AU: not split by the ABS; the figure covers all residential dwellings (houses and attached dwellings together). Any value is accepted and noted. BE: house (all houses, not apartments), apartment, or detached / villa (houses with 4 or more facades), semi-detached or terraced (houses with 2 or 3 facades). Statbel has no figure for houses and apartments together, so without a type you get both medians in the summary and no single price. CA: only 'any' (or leave out); BC does not split the value by house, condo or other kind. DK: house (one-family houses), flat (owner-occupied flats). Without a type, the group with more sales in that place is answered and the other is in extra. Detached and terraced are not published separately. BG HR CY CZ DE EE ES HU IS IT LV LT LU MT PL RO SI SK: ignored; the index covers all dwellings (new and existing) bought by households. FI: flat (flats in blocks of flats), terraced (terraced houses, which also include detached houses with shares in a housing company). Without a type, all building types. House and detached are not covered. FR: house or apartment. GB: detached, semi-detached, terraced or flat-maisonette. GB Scotland / Northern Ireland: any, detached, semi-detached, terraced or flat-maisonette. HU: 'existing' (used dwellings, the default) or 'new' (newly built). The figure is an average price per m² of living space. IE: any, new or second-hand (new homes are usually recorded without VAT). NL: CBS does not split this figure by home type; only 'any' (all existing owner-occupied homes) has an answer. NO: any (all dwellings, default), house or detached (detached houses), terraced (row houses), flat (multi-dwelling buildings). Official price per m² of existing dwellings. PL: only flats are in the register extract we read, so leave out or use any. PT: INE splits by number of bedrooms, not by house or apartment; only 'any' has an answer (the answer includes the split by bedrooms). SE: house (one- and two-dwelling buildings; the default for any), flat (tenant-owned flats, median price, county or metropolitan area only). Villas, terraced and semi-detached houses are not split, so detached and terraced return no figure. TW: apartment (high-rise, mid-rise and walk-up flats together), house (透天厝), high-rise (住宅大樓, 11+ floors with a lift), mid-rise (華廈, up to 10 floors with a lift) or walk-up (公寓, up to 5 floors, no lift). Default any = all homes. US: any (default), house (one- to three-family houses and townhomes), condo, or coop (New York City only). |
| postcode_district | string | GB only: postcode district such as 'BS8' to narrow the area. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country"
],
"properties": {
"town": {
"type": "string",
"minLength": 2,
"description": "Town or city. AT: a municipality among the 100 largest ('Wien' / 'Vienna', 'Graz', 'Linz', 'Salzburg', 'Innsbruck'), a district ('Wien 2' for Leopoldstadt, 'Bezirk Baden', 'Kitzbühel'), or a Bundesland ('Tirol', 'Niederösterreich' / 'Lower Austria'). Omit for Austria. Official annual medians per m², not a list of sales. AU: a state or territory ('Victoria', 'NSW', 'Queensland', 'Tasmania', 'ACT'), or a city or town that lies in one ('Melbourne', 'Parramatta', 'Perth'). The ABS publishes by state and territory only, so a city is answered with its state (and the answer says so). Omit for Australia as a whole. BE: a municipality in Dutch, French or English ('Antwerpen' / 'Antwerp' / 'Anvers', 'Gent' / 'Ghent', 'Brussel' / 'Bruxelles' / 'Brussels', 'Liège'), or a province ('province of Namur') or region ('Flanders', 'Wallonia', 'Brussels Capital Region'). Omit for Belgium. Official Statbel medians, not a list of sales. CA (British Columbia): a municipality, rural area or regional district, e.g. Kelowna, Victoria, Surrey, 'Prince George', 'Quesnel Rural', 'Greater Vancouver'. Omit for the whole province. Other provinces are not covered. DK: a municipality or town ('København' or 'Copenhagen', 'Aarhus' or 'Århus', 'Odense', 'Aalborg'), a province ('Fyn', 'Østjylland', 'Nordsjælland') or a region ('Hovedstaden', 'Syddanmark'), with or without æ ø å. Statistics Denmark publishes by province, so a municipality is answered with the province it lies in (and the answer says which). Omit for Denmark as a whole. BG HR CY CZ DE EE ES HU IS IT LV LT LU MT PL RO SI SK: ignored; Eurostat publishes one national index per country (PL: a town is answered by the Polish price register instead). The answer is an index (2015 = 100), not a price in euros. FI: a municipality ('Helsinki' or 'Helsingfors', 'Espoo', 'Tampere', 'Oulu', 'Hämeenlinna'), a region ('Uusimaa', 'Pirkanmaa'), 'Greater Helsinki', with or without ä ö å. Omit for Finland as a whole. Larger cities, regions and the country have quarterly figures (with the official price-index changes); other municipalities have the latest yearly figure. FR: town, e.g. 'Bordeaux', or use postcode. GB: the Royal Mail POSTAL TOWN as the Land Registry files it, e.g. 'Bristol'. It can be wider than the council area: 'Bristol' also takes in Bradley Stoke and Filton (South Gloucestershire), and every London sale is filed under 'London', so a London borough such as 'Camden' is not a town. For a council area or London borough use district. Give town or district. GB Scotland / Northern Ireland: 'Scotland', 'Northern Ireland' or a council area ('Edinburgh', 'Glasgow', 'Aberdeen', 'Fife', 'Highland', 'Belfast', 'Derry', 'Lisburn and Castlereagh'). Answered with the official monthly UK House Price Index average, not a list of sales. HU: 'Budapest', a statistical region ('Pest', 'Central Transdanubia', 'Western Transdanubia', 'Southern Transdanubia', 'Northern Hungary', 'Northern Great Plain', 'Southern Great Plain') or a county or big city that names one ('Debrecen', 'Győr', 'Pécs', 'Szeged'), or 'Hungary'. A town is answered at the level of its region. Without a town the Eurostat price index answers instead. IE: a county ('Cork') or Dublin postal district ('Dublin 6'). Omit for all of Ireland. NL: a municipality ('Amsterdam', 'Den Haag' / 'The Hague' / 's-Gravenhage, 'Utrecht') or a province ('Noord-Holland'). Omit for the national average. Official CBS annual average, not a list of sales. NO: a municipality ('Oslo', 'Bergen', 'Tromsø' or 'Tromso', 'Stavanger') or a county ('Rogaland', 'Vestland'), Norwegian or Sami spelling, with or without æ ø å. Omit for the whole country. Answers are Statistics Norway's published average price per m² (NOK) with the number of sales, not a list of sales. PL: a city, required (Warsaw, Krakow, Lodz, Wroclaw, Poznan, Gdansk, Gdynia, Szczecin, Lublin, Katowice, Bydgoszcz, Bialystok, Rzeszow, Torun, Kielce, Olsztyn, Opole, Radom, Czestochowa); Polish or English spelling. Flats only. A city county is read as a whole; districts are not available. PT: a municipality INE publishes ('Lisboa' / 'Lisbon', 'Porto' / 'Oporto', 'Cascais', 'Faro', 'Funchal' ... 58 in all) or a region ('Algarve', 'Grande Lisboa', 'Madeira', 'Açores'). Omit for Portugal as a whole. Official INE median per m² of the last 12 months of sales, not a list of sales. SE: a municipality ('Stockholm', 'Göteborg' or 'Gothenburg', 'Malmö' or 'Malmo', 'Uppsala'), a county ('Skåne', 'Stockholms län') or a metropolitan area ('Greater Gothenburg'), with or without å ä ö. Omit for Sweden as a whole. Answers are Statistics Sweden's published average purchase price (SEK per home) with the number of sales, not a list of sales. SG: required, one of the 26 HDB towns, e.g. 'Tampines', 'Ang Mo Kio', 'Bukit Merah', 'Kallang/Whampoa', 'Central Area' (case, hyphens and ', Singapore' are forgiven; 'Kallang' and 'CBD' are understood). TW: a city or county in English or Chinese ('Taipei' / '台北市' / '臺北市', 'New Taipei', 'Taichung', 'Kaohsiung', 'Tainan', 'Taoyuan', 'Hsinchu City', 'Hsinchu County'), or a district with its city (\"Da'an, Taipei\", '臺北市大安區', 'Banqiao, New Taipei'). Omit for all of Taiwan. A district name used in several cities ('Zhongzheng', 'Dongqu') needs the city too. US: a Connecticut town ('Hartford'), a New York City borough or neighborhood ('Brooklyn', 'Williamsburg'), 'Chicago', 'Cook County' or a Cook County assessment township ('Evanston', 'Oak Park'). Add the state if a name exists in two places ('Hartford, CT'). Required unless postcode is a New York City ZIP."
},
"state": {
"type": "string",
"description": "US only: 'CT' (Connecticut), 'NY' (New York City) or 'IL' (Cook County). Usually inferred from the place; set it when a name exists in two of them."
},
"county": {
"type": "string",
"description": "IE only: same as town; a county such as 'Dublin' or 'Cork'."
},
"months": {
"type": "integer",
"maximum": 36,
"minimum": 1,
"description": "How many recent months to include. Default 12. AT: ignored; STATISTIK AUSTRIA publishes one figure per calendar year (the latest is returned). AU: not used; the ABS publishes one mean price per quarter. BE: ignored; Statbel publishes quarters, half-years and years, and the latest period with a figure for the place is returned. CA: up to 4 gives the latest 3 months, more gives the latest 12 months. By default the latest 3 months, widening to 12 when a place is quiet. The figure is an average of declared values, not a median. DK: not used; Statistics Denmark publishes one average per quarter. BG HR CY CZ DE EE ES HU IS IT LV LT LU MT PL RO SI SK: ignored; the newest quarter with a figure is returned, with the change over the previous quarter and over a year. FI: not used; Statistics Finland publishes one average per quarter (postcodes, cities) or year (municipalities). GB Scotland / Northern Ireland: ignored; the newest published month is returned. HU: ignored; KSH publishes one figure per calendar year (the latest is returned). IE: rounded to the nearest of 3, 6, 12, 24 or 36. NL: ignored; CBS publishes one average per calendar year (the latest is returned). NO: not used; Statistics Norway publishes one figure per quarter and the answer gives the latest quarter plus the previous one and a year earlier. PL: 1 to 6 months of 30 days up to today; default 3. Large cities are read as a sample of up to 300 records per 30 days (the answer says so). PT: ignored; INE publishes one median per quarter, covering the 12 months to the quarter's end (the latest is returned). SE: not used; Statistics Sweden publishes one figure per year (municipalities, flats) or quarter (counties). TW: 12 or 24 whole calendar months; up to 18 gives 12 (24 if a place has too few sales in 12), more gives 24. The window ends at the last month that is at least 30 days old. US: 1 to 36 months back from the latest sale in the file (New York City: up to 12)."
},
"country": {
"enum": [
"AT",
"AU",
"BE",
"CA",
"DK",
"BG",
"HR",
"CY",
"CZ",
"DE",
"EE",
"ES",
"HU",
"IS",
"IT",
"LV",
"LT",
"LU",
"MT",
"PL",
"RO",
"SK",
"SI",
"FI",
"FR",
"GB",
"IE",
"NL",
"NO",
"PT",
"SE",
"SG",
"TW",
"US"
],
"type": "string",
"description": "AT = Austria (official STATISTIK AUSTRIA median price per m² of houses and flats, annual); AU = Australia (the Australian Bureau of Statistics' official mean price of residential dwellings, by state and territory; an official statistic of the whole dwelling stock, not individual sales and not a suburb price); BE = Belgium (official Statbel median sale prices by property type, quarterly); CA = Canada, British Columbia only (Property Transfer Tax data: average declared value of residential transfers, by municipality); DK = Denmark (official average price per property from Statistics Denmark, by province and region; an official statistic, not individual sales); Eurostat house price index (2015 = 100, an official index, NOT a price in money) for: BG = Bulgaria, HR = Croatia, CY = Cyprus, CZ = Czechia, DE = Germany, EE = Estonia, ES = Spain, HU = Hungary, IS = Iceland, IT = Italy, LV = Latvia, LT = Lithuania, LU = Luxembourg, MT = Malta, PL = Poland, RO = Romania, SK = Slovakia, SI = Slovenia; FI = Finland (official average price per m² of old dwellings in housing companies from Statistics Finland, by municipality, region or postcode; an official statistic, not individual sales); FR = France (DVF); GB = England & Wales (HM Land Registry); GB = England & Wales (HM Land Registry sales); Scotland and Northern Ireland (official UK House Price Index average); HU = Hungary (official KSH average price per m² of used and new dwellings, annual, by region and settlement type; with no town the Eurostat house price index answers); IE = Ireland (Property Price Register); NL = Netherlands (official CBS average sale price per municipality, annual); NO = Norway (official average price per m² from Statistics Norway, by municipality or county; an official statistic, not individual sales); PL = Poland (national Real Estate Price Register: notarised flat sales in the 19 biggest cities); PT = Portugal (official INE median sale price per m², quarterly, by region and municipality); SE = Sweden (official average purchase price from Statistics Sweden, by municipality or county; an official statistic, not individual sales); SG = Singapore HDB resale flats; TW = Taiwan (Ministry of the Interior actual price registration: every registered sale, summarised by city or county and district); US = United States, partial: Connecticut, New York City and Cook County IL (Chicago area) only; not nationwide"
},
"district": {
"type": "string",
"description": "GB only: local authority (council area or London borough) as the Land Registry records it, e.g. 'Camden', 'City of Bristol', 'South Gloucestershire'. Use it instead of town for a London borough or when the postal town is wider than the place you mean."
},
"postcode": {
"type": "string",
"description": "Postcode, for a precise area. AT: only Vienna postcodes (1010 to 1230) are matched, to the Vienna district; elsewhere give the town or district as town. AU: a 4-digit postcode ('2150'), answered with the state or territory it lies in (the ABS has no postcode figures). BE: not supported (Statbel publishes by municipality); give the municipality as town. CA: not supported; BC publishes by municipality, so give the municipality as town. DK: not supported (Statistics Denmark publishes by province and region); give town instead. BG HR CY CZ DE EE ES HU IS IT LV LT LU MT PL RO SI SK: not supported (national index only). FI: a five-digit postcode (for example 00100): the latest yearly figure for that postal code area. Flats are published by number of rooms, so the answer is the room size with most transactions and the others are listed. FR: 5-digit postcode, e.g. '69003'; use instead of town for a precise area. HU: not supported (KSH publishes regions, not postcodes). NL: not supported (CBS publishes by municipality); give the municipality as town. NO: not supported (Statistics Norway publishes by municipality); give town instead. PL: not supported; give the city as town. PT: not supported (INE publishes by region and municipality); give the municipality as town. SE: not supported (Statistics Sweden publishes by municipality); give town instead. TW: not supported (the register has no postcodes); give the city, county or district as town. US: 5-digit ZIP code, New York City only (Connecticut and Cook County have no ZIP in the public file)."
},
"flat_type": {
"enum": [
"1 ROOM",
"2 ROOM",
"3 ROOM",
"4 ROOM",
"5 ROOM",
"EXECUTIVE",
"MULTI-GENERATION"
],
"type": "string",
"description": "SG only: HDB flat type."
},
"settlement": {
"type": "string",
"description": "HU only: type of settlement inside a region: all (default), county_seat, towns or villages. Budapest has one figure."
},
"property_type": {
"enum": [
"house",
"apartment",
"villa",
"detached",
"semi-detached",
"terraced",
"flat",
"flat-maisonette",
"any",
"existing",
"new",
"second-hand",
"high-rise",
"mid-rise",
"walk-up",
"condo",
"coop"
],
"type": "string",
"description": "Kind of home. Default 'any'. AT: house or apartment (flats). The figure is the price per m² of living area. With no type given the headline is the flat figure and both medians are in extra.by_type. There is no figure for both together or for villas, detached, semi-detached or terraced homes. AU: not split by the ABS; the figure covers all residential dwellings (houses and attached dwellings together). Any value is accepted and noted. BE: house (all houses, not apartments), apartment, or detached / villa (houses with 4 or more facades), semi-detached or terraced (houses with 2 or 3 facades). Statbel has no figure for houses and apartments together, so without a type you get both medians in the summary and no single price. CA: only 'any' (or leave out); BC does not split the value by house, condo or other kind. DK: house (one-family houses), flat (owner-occupied flats). Without a type, the group with more sales in that place is answered and the other is in extra. Detached and terraced are not published separately. BG HR CY CZ DE EE ES HU IS IT LV LT LU MT PL RO SI SK: ignored; the index covers all dwellings (new and existing) bought by households. FI: flat (flats in blocks of flats), terraced (terraced houses, which also include detached houses with shares in a housing company). Without a type, all building types. House and detached are not covered. FR: house or apartment. GB: detached, semi-detached, terraced or flat-maisonette. GB Scotland / Northern Ireland: any, detached, semi-detached, terraced or flat-maisonette. HU: 'existing' (used dwellings, the default) or 'new' (newly built). The figure is an average price per m² of living space. IE: any, new or second-hand (new homes are usually recorded without VAT). NL: CBS does not split this figure by home type; only 'any' (all existing owner-occupied homes) has an answer. NO: any (all dwellings, default), house or detached (detached houses), terraced (row houses), flat (multi-dwelling buildings). Official price per m² of existing dwellings. PL: only flats are in the register extract we read, so leave out or use any. PT: INE splits by number of bedrooms, not by house or apartment; only 'any' has an answer (the answer includes the split by bedrooms). SE: house (one- and two-dwelling buildings; the default for any), flat (tenant-owned flats, median price, county or metropolitan area only). Villas, terraced and semi-detached houses are not split, so detached and terraced return no figure. TW: apartment (high-rise, mid-rise and walk-up flats together), house (透天厝), high-rise (住宅大樓, 11+ floors with a lift), mid-rise (華廈, up to 10 floors with a lift) or walk-up (公寓, up to 5 floors, no lift). Default any = all homes. US: any (default), house (one- to three-family houses and townhomes), condo, or coop (New York City only)."
},
"postcode_district": {
"type": "string",
"description": "GB only: postcode district such as 'BS8' to narrow the area."
}
}
}| measure* | string | The upgrade: heat_pump, solar_pv, attic_insulation, wall_insulation, windows, or renovation (any home renovation works, where the publisher does not split by type). Plain words such as 'heat pump' or 'loft insulation' are accepted. GB: solar_pv (DESNZ, per kW installed) and heat_pump (Boiler Upgrade Scheme, per installation). Insulation and windows have no open GB cost statistic yet and return no_matches. IE: only renovation (any qualifying work). The Home Renovation Incentive is not split by heat pump, solar, insulation or windows, so those measures return no_matches. |
| size_kw | number | GB solar_pv: system size in kW; picks the DESNZ size band (0-4, 4-10 or 10-50 kW). Default: the 0-4 kW band. |
| technology | string | GB heat_pump: air_to_water (default), ground_source or biomass_boiler. |
| dwelling_type | string | Type of dwelling or job, only where the publisher splits by it (the country notes say which values). Leave out for the publisher's main figure. GB solar_pv: leave out for all small installations (median); or domestic, non-domestic, retrofit (domestic, existing home) or new build (domestic): these are means. GB heat_pump: not published, ignored. IE: not published, ignored. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country",
"measure"
],
"properties": {
"area": {
"type": "string",
"description": "Place, only where the publisher splits by place (the country notes say how). Leave out for the national figure. GB: national figures only; an area is ignored and the answer says so. IE: a county (Kerry, Cork, Dublin, Galway...) or a local authority (Fingal, DLR, Cork City...); leave out for all of Ireland."
},
"country": {
"enum": [
"GB",
"IE"
],
"type": "string",
"description": "GB = England and Wales for heat pumps (Boiler Upgrade Scheme statistics) and Great Britain for solar panels; GB = Great Britain (solar PV: DESNZ declared installed cost per kW from MCS certificates; heat pumps: Boiler Upgrade Scheme statistics; England and Wales for heat pumps, Great Britain for solar); IE = Ireland (Revenue Home Renovation Incentive: declared value of renovation works by county; not split by type of work; SEAI figures are not included yet)"
},
"measure": {
"enum": [
"heat_pump",
"solar_pv",
"attic_insulation",
"wall_insulation",
"windows",
"renovation"
],
"type": "string",
"description": "The upgrade: heat_pump, solar_pv, attic_insulation, wall_insulation, windows, or renovation (any home renovation works, where the publisher does not split by type). Plain words such as 'heat pump' or 'loft insulation' are accepted. GB: solar_pv (DESNZ, per kW installed) and heat_pump (Boiler Upgrade Scheme, per installation). Insulation and windows have no open GB cost statistic yet and return no_matches. IE: only renovation (any qualifying work). The Home Renovation Incentive is not split by heat pump, solar, insulation or windows, so those measures return no_matches."
},
"size_kw": {
"type": "number",
"description": "GB solar_pv: system size in kW; picks the DESNZ size band (0-4, 4-10 or 10-50 kW). Default: the 0-4 kW band."
},
"technology": {
"type": "string",
"description": "GB heat_pump: air_to_water (default), ground_source or biomass_boiler."
},
"dwelling_type": {
"type": "string",
"description": "Type of dwelling or job, only where the publisher splits by it (the country notes say which values). Leave out for the publisher's main figure. GB solar_pv: leave out for all small installations (median); or domestic, non-domestic, retrofit (domestic, existing home) or new build (domestic): these are means. GB heat_pump: not published, ignored. IE: not published, ignored."
}
}
}| stars | integer | Hotel star category (1 to 5), for sources that publish it. Only national figures are split by stars; do not combine with area. ES: optional, 1 to 5 hotel stars. INE publishes star categories for Spain as a whole only, so do not combine with area. FI: not used (Statistics Finland publishes no star split). HK: not available. The Bureau publishes all hotels together. NO: not used (SSB publishes no star split). |
| country* | string | ES = Spain (INE hotel survey, average price charged per occupied room per night, in euro); FI = Finland (Statistics Finland accommodation statistics, average price per occupied hotel room per night, in EUR); HK = Hong Kong (CSTB average achieved room rate per night in HK$, citywide, monthly official statistic); NO = Norway (Statistics Norway hotel statistics, average price per occupied room per night, in NOK) |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country"
],
"properties": {
"area": {
"type": "string",
"description": "Region, province or city inside the country, in plain words (for example 'Madrid', 'Andalucia', 'Benidorm'). Leave out for the national average. ES: optional. A region ('Andalucia', 'Cataluña', 'Madrid'), a province ('Málaga', 'Cádiz', 'Illes Balears') or a tourist city or resort ('Benidorm', 'Barcelona', 'Alicante') as INE names them; accents are optional. Leave out for the Spain-wide average. A name that is both a province and a city gives the province and lists the other. FI: optional. A region ('Uusimaa', 'Lapland', 'Pirkanmaa', 'Southwest Finland', 'Aland') or a main city ('Helsinki', 'Tampere', 'Turku', 'Oulu', 'Rovaniemi'), which is answered with its region. Leave out for the whole country. HK: leave out. The Bureau publishes one citywide figure; a district name is refused rather than answered with the city average. NO: optional. A county ('Oslo', 'Vestland', 'Rogaland', 'Troms', 'Svalbard') or a main city ('Bergen', 'Stavanger', 'Trondheim', 'Tromso') as SSB counts them; Norwegian spellings work. Leave out for the whole country."
},
"stars": {
"type": "integer",
"maximum": 5,
"minimum": 1,
"description": "Hotel star category (1 to 5), for sources that publish it. Only national figures are split by stars; do not combine with area. ES: optional, 1 to 5 hotel stars. INE publishes star categories for Spain as a whole only, so do not combine with area. FI: not used (Statistics Finland publishes no star split). HK: not available. The Bureau publishes all hotels together. NO: not used (SSB publishes no star split)."
},
"country": {
"enum": [
"ES",
"FI",
"HK",
"NO"
],
"type": "string",
"description": "ES = Spain (INE hotel survey, average price charged per occupied room per night, in euro); FI = Finland (Statistics Finland accommodation statistics, average price per occupied hotel room per night, in EUR); HK = Hong Kong (CSTB average achieved room rate per night in HK$, citywide, monthly official statistic); NO = Norway (Statistics Norway hotel statistics, average price per occupied room per night, in NOK)"
}
}
}| string |
| EU member states and Norway, as ISO codes (GR for Greece): AT = Austria, BE = Belgium, BG = Bulgaria, HR = Croatia, CZ = Czechia, DK = Denmark, EE = Estonia, FI = Finland, FR = France, GR = Greece, HU = Hungary, IE = Ireland, IT = Italy, LV = Latvia, LT = Lithuania, LU = Luxembourg, MT = Malta, NL = Netherlands, NO = Norway, PL = Poland, PT = Portugal, RO = Romania, SK = Slovakia, SI = Slovenia, ES = Spain, SE = Sweden. Not covered: DE, CY (Eurostat holds no farmland data) and GB. Belgium's sale prices end in 2014 and Italy's in 2020; Norway has rents only. |
| measure* | string | price = what agricultural land sells for per hectare; rent = what it costs to rent per hectare for one year. EU/NO: price = average sale price of agricultural land per hectare (Eurostat apri_lprc); rent = average rent for one year per hectare (apri_lrnt). Rents exist for most countries, prices for most but not NO. |
| land_type | string | Land type, e.g. 'arable', 'permanent grassland', 'arable or grassland' (rent only), 'irrigable arable' (price only). Leave out for the usual one. EU/NO, optional. For price: "arable" = Arable land; "permanent grassland" = Permanent grassland; "irrigable arable" = Irrigable arable land; "non-irrigable arable" = Non-irrigable arable land. For rent: "arable" = Arable land; "permanent grassland" = Permanent grassland; "arable or grassland" = Arable land and/or permanent grassland. Leave out for the usual one (price: arable; rent: arable and/or grassland). Not every country reports every land type; the answer lists what exists. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country",
"measure"
],
"properties": {
"region": {
"type": "string",
"description": "Optional region code for a regional figure, where the source publishes one (the country notes say which codes). Leave out for the whole country. EU/NO, optional. A NUTS region code (Eurostat's regional land data), e.g. ES51 = Cataluña, ES61 = Andalucía, FRJ2 = Midi-Pyrénées, IE05 = Southern, NL32 = Noord-Holland, PT11 = Norte, PL91 = Warszawski stołeczny, SE11 = Stockholm. Leave out for the whole country. Every national answer lists its regions in extra.regions_available. Regions exist only for some countries and years: a code Eurostat does not hold gets a clear no_matches."
},
"country": {
"enum": [
"AT",
"BE",
"BG",
"HR",
"CZ",
"DK",
"EE",
"FI",
"FR",
"GR",
"HU",
"IE",
"IT",
"LV",
"LT",
"LU",
"MT",
"NL",
"NO",
"PL",
"PT",
"RO",
"SK",
"SI",
"ES",
"SE"
],
"type": "string",
"description": "EU member states and Norway, as ISO codes (GR for Greece): AT = Austria, BE = Belgium, BG = Bulgaria, HR = Croatia, CZ = Czechia, DK = Denmark, EE = Estonia, FI = Finland, FR = France, GR = Greece, HU = Hungary, IE = Ireland, IT = Italy, LV = Latvia, LT = Lithuania, LU = Luxembourg, MT = Malta, NL = Netherlands, NO = Norway, PL = Poland, PT = Portugal, RO = Romania, SK = Slovakia, SI = Slovenia, ES = Spain, SE = Sweden. Not covered: DE, CY (Eurostat holds no farmland data) and GB. Belgium's sale prices end in 2014 and Italy's in 2020; Norway has rents only."
},
"measure": {
"enum": [
"price",
"rent"
],
"type": "string",
"description": "price = what agricultural land sells for per hectare; rent = what it costs to rent per hectare for one year. EU/NO: price = average sale price of agricultural land per hectare (Eurostat apri_lprc); rent = average rent for one year per hectare (apri_lrnt). Rents exist for most countries, prices for most but not NO."
},
"land_type": {
"type": "string",
"description": "Land type, e.g. 'arable', 'permanent grassland', 'arable or grassland' (rent only), 'irrigable arable' (price only). Leave out for the usual one. EU/NO, optional. For price: \"arable\" = Arable land; \"permanent grassland\" = Permanent grassland; \"irrigable arable\" = Irrigable arable land; \"non-irrigable arable\" = Non-irrigable arable land. For rent: \"arable\" = Arable land; \"permanent grassland\" = Permanent grassland; \"arable or grassland\" = Arable land and/or permanent grassland. Leave out for the usual one (price: arable; rent: arable and/or grassland). Not every country reports every land type; the answer lists what exists."
}
}
}| country* | string | SG = Singapore (Ministry of Health: median and middle-half hospital bills for medical conditions, Singapore Citizens, 2023); US = United States (what Medicare paid, nationally or by state) |
| service* | string | The medical service: plain words ('office visit', 'MRI lower back', 'knee replacement'), a billing code or a hospital-stay group code, as the country notes list them. Required. Singapore: a medical condition in plain words ('stroke', 'dementia', 'delirium', 'spinal cord conditions') or an MOH DRG code ('B70A'). Surgery and doctor visits are not covered. US: plain words ('office visit', 'MRI lower back', 'colonoscopy', 'physical therapy', 'knee replacement', 'pneumonia'), a billing code (HCPCS/CPT such as 99213 or G0121) or an MS-DRG hospital-stay code ('DRG 470'). |
| setting | string | office = a doctor's office (whole service); facility = hospital outpatient or surgery centre (doctor's fee only); inpatient = a hospital stay. Leave out to use the usual setting for the service. Singapore: only inpatient (a hospital stay); leave out. US: office (a doctor's office; the whole service), facility (a hospital outpatient department or surgery centre; the doctor's fee only) or inpatient (a hospital stay, by MS-DRG). Leave out to use the usual setting for the service. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country",
"service"
],
"properties": {
"state": {
"type": "string",
"minLength": 2,
"description": "A state or territory, where the source publishes one (the country notes say how to write it). Leave out for the national average. Singapore: the ward class, because Singapore has no states: c = public subsidised Ward C (default), b2 = public subsidised Ward B2, b1 = public unsubsidised Ward B1, a = public unsubsidised Ward A, private = private hospital. US: a state or territory as a two-letter code or name (TX, Texas). Leave out for the national average."
},
"country": {
"enum": [
"SG",
"US"
],
"type": "string",
"description": "SG = Singapore (Ministry of Health: median and middle-half hospital bills for medical conditions, Singapore Citizens, 2023); US = United States (what Medicare paid, nationally or by state)"
},
"service": {
"type": "string",
"minLength": 2,
"description": "The medical service: plain words ('office visit', 'MRI lower back', 'knee replacement'), a billing code or a hospital-stay group code, as the country notes list them. Required. Singapore: a medical condition in plain words ('stroke', 'dementia', 'delirium', 'spinal cord conditions') or an MOH DRG code ('B70A'). Surgery and doctor visits are not covered. US: plain words ('office visit', 'MRI lower back', 'colonoscopy', 'physical therapy', 'knee replacement', 'pneumonia'), a billing code (HCPCS/CPT such as 99213 or G0121) or an MS-DRG hospital-stay code ('DRG 470')."
},
"setting": {
"enum": [
"office",
"facility",
"inpatient"
],
"type": "string",
"description": "office = a doctor's office (whole service); facility = hospital outpatient or surgery centre (doctor's fee only); inpatient = a hospital stay. Leave out to use the usual setting for the service. Singapore: only inpatient (a hospital stay); leave out. US: office (a doctor's office; the whole service), facility (a hospital outpatient department or surgery centre; the doctor's fee only) or inpatient (a hospital stay, by MS-DRG). Leave out to use the usual setting for the service."
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country",
"medicine"
],
"properties": {
"country": {
"enum": [
"ES",
"FR",
"GB",
"IT",
"JP",
"NZ",
"US"
],
"type": "string",
"description": "ES = Spain (Ministerio de Sanidad Nomenclator: legally fixed public prices of medicines billed to the national health service); FR = France (public medicines database: legally fixed prices of reimbursable medicines); GB = England (NHS Prescription Cost Analysis: the basic price the NHS reimburses for the drug, per tablet/capsule/ml, not a patient price; England only); IT = Italy (AIFA transparency list: public prices of reimbursable off-patent class A medicines); JP = Japan (MHLW National Health Insurance drug price list: official reimbursement prices in yen); NZ = New Zealand (PHARMAC Pharmaceutical Schedule: list prices of subsidised community medicines, NZD); US = United States (NADAC: the average price retail pharmacies pay to acquire a drug, weekly, per tablet/capsule/mL/gram; not the patient's counter price)"
},
"medicine": {
"type": "string",
"description": "Medicine brand or active-substance name, e.g. 'doliprane' or 'paracetamol'. Only the first word is used. ES: Spanish active-ingredient or brand name, first word used ('paracetamol', 'ibuprofeno', 'omeprazol', 'dolocatil'). Needs 5+ packs on sale under that name. FR: brand or active substance, first word used ('doliprane', 'paracetamol', 'amoxicilline'). Needs 5+ priced packs under that name. GB: generic or brand name, optionally with strength and form ('omeprazole', 'atorvastatin 20mg', 'Lipitor', 'paracetamol tablets'). NHS names follow the British National Formulary (the common American names are mapped). Returns the NHS net ingredient cost per unit and per 28-unit supply. IT: Italian active-substance or brand name, first word used ('paracetamolo', 'amoxicillina', 'glucobay'). Needs 5+ packs under that name. Off-patent reimbursable (class A) medicines only. JP: the active ingredient, in English ('paracetamol', 'amlodipine', 'metformin') or Japanese ('アムロジピン'); first word used. Not brand names. Needs 5+ listed products. Official reimbursement price per tablet, capsule, gram, millilitre or vial, not what a patient paid. NZ: English chemical or brand name, first word used ('paracetamol', 'amoxicillin', 'panadol'). Needs 5+ subsidised packs under that name. Subsidised community medicines only; list prices, not what patients paid. US: generic or brand name, optionally with strength and form ('atorvastatin', 'atorvastatin 20mg', 'metformin 500 mg tablet', 'Lipitor'). NADAC uses American generic names ('acetaminophen' for paracetamol, 'albuterol' for salbutamol; the common British names are mapped). Returns the per-unit cost to the pharmacy."
}
}
}| Argument | Type | Description |
|---|---|---|
| spend | string | What kind of spending: leave out for all household consumption, or give 'food', 'meat', 'dairy', 'bread and cereals', 'fruit', 'vegetables', 'alcohol', 'tobacco', 'clothing', 'housing' (rent, water, energy), 'furnishings', 'health', 'transport', 'cars', 'communication', 'recreation', 'education', 'restaurants and hotels', 'goods' or 'services'. OECD: spend is one of 'food', 'meat', 'fish', 'dairy', 'bread and cereals', 'oils and fats', 'fruit', 'vegetables', 'sugar', 'soft drinks', 'alcohol', 'tobacco', 'clothing', 'housing' (rent, water, energy), 'furnishings', 'health', 'transport', 'cars', 'communication', 'recreation', 'education', 'restaurants and hotels', 'goods' or 'services'; leave out for all household consumption. The index is for the whole country, not a city. World Bank ICP: spend is one of 'food', 'bread and cereals', 'meat', 'fish', 'dairy', 'oils and fats', 'fruit', 'vegetables', 'sugar', 'soft drinks', 'alcohol', 'tobacco', 'clothing', 'housing' (rent, water, energy), 'furnishings', 'health', 'transport', 'cars', 'communication', 'recreation', 'education', 'restaurants and hotels' or 'gdp'; leave out for all household consumption. The index is for the whole country, not a city. |
| country* | string | Countries as ISO codes: AU = Australia, AT = Austria, BE = Belgium, CA = Canada, CL = Chile, CO = Colombia, CR = Costa Rica, CZ = Czechia, DK = Denmark, EE = Estonia, FI = Finland, FR = France, DE = Germany, GR = Greece, HU = Hungary, IS = Iceland, IE = Ireland, IL = Israel, IT = Italy, JP = Japan, KR = South Korea, LV = Latvia, LT = Lithuania, LU = Luxembourg, MX = Mexico, NL = Netherlands, NZ = New Zealand, NO = Norway, PL = Poland, PT = Portugal, SK = Slovakia, SI = Slovenia, ES = Spain, SE = Sweden, CH = Switzerland, TR = Turkey, GB = United Kingdom, US = United States, BG = Bulgaria, CY = Cyprus, MT = Malta, RO = Romania, AL = Albania, BA = Bosnia and Herzegovina, MK = North Macedonia, ME = Montenegro, RS = Serbia. OECD/Eurostat PPP survey: one price level index per country, year and spending group, whole country.; Countries as ISO codes: AF = Afghanistan, AO = Angola, AE = United Arab Emirates, AR = Argentina, AM = Armenia, AG = Antigua and Barbuda, AZ = Azerbaijan, BI = Burundi, BJ = Benin, BF = Burkina Faso, BD = Bangladesh, BH = Bahrain, BS = Bahamas, BY = Belarus, BZ = Belize, BO = Bolivia, BR = Brazil, BB = Barbados, BN = Brunei, BT = Bhutan, BW = Botswana, CF = Central African Republic, CN = China, CI = Cote d'Ivoire, CM = Cameroon, CD = Democratic Republic of the Congo, CG = Republic of the Congo, KM = Comoros, CV = Cabo Verde, DJ = Djibouti, DM = Dominica, DO = Dominican Republic, DZ = Algeria, EC = Ecuador, EG = Egypt, ER = Eritrea, ET = Ethiopia, FJ = Fiji, GA = Gabon, GE = Georgia, GH = Ghana, GN = Guinea, GM = Gambia, GW = Guinea-Bissau, GQ = Equatorial Guinea, GD = Grenada, GT = Guatemala, GY = Guyana, HK = Hong Kong, HN = Honduras, HR = Croatia, HT = Haiti, ID = Indonesia, IN = India, IR = Iran, IQ = Iraq, JM = Jamaica, JO = Jordan, KZ = Kazakhstan, KE = Kenya, KG = Kyrgyzstan, KH = Cambodia, KN = Saint Kitts and Nevis, KW = Kuwait, LA = Laos, LB = Lebanon, LR = Liberia, LY = Libya, LC = Saint Lucia, LK = Sri Lanka, LS = Lesotho, MO = Macao, MA = Morocco, MD = Moldova, MG = Madagascar, MV = Maldives, ML = Mali, MM = Myanmar, MN = Mongolia, MZ = Mozambique, MR = Mauritania, MU = Mauritius, MW = Malawi, MY = Malaysia, NA = Namibia, NE = Niger, NG = Nigeria, NI = Nicaragua, NP = Nepal, OM = Oman, PK = Pakistan, PA = Panama, PE = Peru, PH = Philippines, PY = Paraguay, PS = Palestine (West Bank and Gaza), QA = Qatar, RU = Russia, RW = Rwanda, SA = Saudi Arabia, SD = Sudan, SN = Senegal, SG = Singapore, SL = Sierra Leone, SV = El Salvador, SO = Somalia, SS = South Sudan, ST = Sao Tome and Principe, SR = Suriname, SZ = Eswatini, SC = Seychelles, SY = Syria, TD = Chad, TG = Togo, TH = Thailand, TJ = Tajikistan, TM = Turkmenistan, TL = Timor-Leste, TT = Trinidad and Tobago, TN = Tunisia, TW = Taiwan, TZ = Tanzania, UG = Uganda, UA = Ukraine, UY = Uruguay, UZ = Uzbekistan, VC = Saint Vincent and the Grenadines, VN = Vietnam, XK = Kosovo, ZA = South Africa, ZM = Zambia, ZW = Zimbabwe. World Bank ICP 2021 survey: one price level index per country and spending group, whole country, benchmark year 2021. |
| compare_to | string | What the index is measured against, as a short name of a comparison area. Leave out for the default; the allowed values are listed in the notes for the country. OECD: 'OECD' (default, OECD average = 100), 'USA' (United States = 100) or 'EU' (EU-27 average = 100). World Bank ICP countries: leave out. The index is measured against the world average (World = 100); the gap to the United States is always included. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country"
],
"properties": {
"spend": {
"type": "string",
"description": "What kind of spending: leave out for all household consumption, or give 'food', 'meat', 'dairy', 'bread and cereals', 'fruit', 'vegetables', 'alcohol', 'tobacco', 'clothing', 'housing' (rent, water, energy), 'furnishings', 'health', 'transport', 'cars', 'communication', 'recreation', 'education', 'restaurants and hotels', 'goods' or 'services'. OECD: spend is one of 'food', 'meat', 'fish', 'dairy', 'bread and cereals', 'oils and fats', 'fruit', 'vegetables', 'sugar', 'soft drinks', 'alcohol', 'tobacco', 'clothing', 'housing' (rent, water, energy), 'furnishings', 'health', 'transport', 'cars', 'communication', 'recreation', 'education', 'restaurants and hotels', 'goods' or 'services'; leave out for all household consumption. The index is for the whole country, not a city. World Bank ICP: spend is one of 'food', 'bread and cereals', 'meat', 'fish', 'dairy', 'oils and fats', 'fruit', 'vegetables', 'sugar', 'soft drinks', 'alcohol', 'tobacco', 'clothing', 'housing' (rent, water, energy), 'furnishings', 'health', 'transport', 'cars', 'communication', 'recreation', 'education', 'restaurants and hotels' or 'gdp'; leave out for all household consumption. The index is for the whole country, not a city."
},
"country": {
"enum": [
"AU",
"AT",
"BE",
"CA",
"CL",
"CO",
"CR",
"CZ",
"DK",
"EE",
"FI",
"FR",
"DE",
"GR",
"HU",
"IS",
"IE",
"IL",
"IT",
"JP",
"KR",
"LV",
"LT",
"LU",
"MX",
"NL",
"NZ",
"NO",
"PL",
"PT",
"SK",
"SI",
"ES",
"SE",
"CH",
"TR",
"GB",
"US",
"BG",
"CY",
"MT",
"RO",
"AL",
"BA",
"MK",
"ME",
"RS",
"AF",
"AO",
"AE",
"AR",
"AM",
"AG",
"AZ",
"BI",
"BJ",
"BF",
"BD",
"BH",
"BS",
"BY",
"BZ",
"BO",
"BR",
"BB",
"BN",
"BT",
"BW",
"CF",
"CN",
"CI",
"CM",
"CD",
"CG",
"KM",
"CV",
"DJ",
"DM",
"DO",
"DZ",
"EC",
"EG",
"ER",
"ET",
"FJ",
"GA",
"GE",
"GH",
"GN",
"GM",
"GW",
"GQ",
"GD",
"GT",
"GY",
"HK",
"HN",
"HR",
"HT",
"ID",
"IN",
"IR",
"IQ",
"JM",
"JO",
"KZ",
"KE",
"KG",
"KH",
"KN",
"KW",
"LA",
"LB",
"LR",
"LY",
"LC",
"LK",
"LS",
"MO",
"MA",
"MD",
"MG",
"MV",
"ML",
"MM",
"MN",
"MZ",
"MR",
"MU",
"MW",
"MY",
"NA",
"NE",
"NG",
"NI",
"NP",
"OM",
"PK",
"PA",
"PE",
"PH",
"PY",
"PS",
"QA",
"RU",
"RW",
"SA",
"SD",
"SN",
"SG",
"SL",
"SV",
"SO",
"SS",
"ST",
"SR",
"SZ",
"SC",
"SY",
"TD",
"TG",
"TH",
"TJ",
"TM",
"TL",
"TT",
"TN",
"TW",
"TZ",
"UG",
"UA",
"UY",
"UZ",
"VC",
"VN",
"XK",
"ZA",
"ZM",
"ZW"
],
"type": "string",
"description": "Countries as ISO codes: AU = Australia, AT = Austria, BE = Belgium, CA = Canada, CL = Chile, CO = Colombia, CR = Costa Rica, CZ = Czechia, DK = Denmark, EE = Estonia, FI = Finland, FR = France, DE = Germany, GR = Greece, HU = Hungary, IS = Iceland, IE = Ireland, IL = Israel, IT = Italy, JP = Japan, KR = South Korea, LV = Latvia, LT = Lithuania, LU = Luxembourg, MX = Mexico, NL = Netherlands, NZ = New Zealand, NO = Norway, PL = Poland, PT = Portugal, SK = Slovakia, SI = Slovenia, ES = Spain, SE = Sweden, CH = Switzerland, TR = Turkey, GB = United Kingdom, US = United States, BG = Bulgaria, CY = Cyprus, MT = Malta, RO = Romania, AL = Albania, BA = Bosnia and Herzegovina, MK = North Macedonia, ME = Montenegro, RS = Serbia. OECD/Eurostat PPP survey: one price level index per country, year and spending group, whole country.; Countries as ISO codes: AF = Afghanistan, AO = Angola, AE = United Arab Emirates, AR = Argentina, AM = Armenia, AG = Antigua and Barbuda, AZ = Azerbaijan, BI = Burundi, BJ = Benin, BF = Burkina Faso, BD = Bangladesh, BH = Bahrain, BS = Bahamas, BY = Belarus, BZ = Belize, BO = Bolivia, BR = Brazil, BB = Barbados, BN = Brunei, BT = Bhutan, BW = Botswana, CF = Central African Republic, CN = China, CI = Cote d'Ivoire, CM = Cameroon, CD = Democratic Republic of the Congo, CG = Republic of the Congo, KM = Comoros, CV = Cabo Verde, DJ = Djibouti, DM = Dominica, DO = Dominican Republic, DZ = Algeria, EC = Ecuador, EG = Egypt, ER = Eritrea, ET = Ethiopia, FJ = Fiji, GA = Gabon, GE = Georgia, GH = Ghana, GN = Guinea, GM = Gambia, GW = Guinea-Bissau, GQ = Equatorial Guinea, GD = Grenada, GT = Guatemala, GY = Guyana, HK = Hong Kong, HN = Honduras, HR = Croatia, HT = Haiti, ID = Indonesia, IN = India, IR = Iran, IQ = Iraq, JM = Jamaica, JO = Jordan, KZ = Kazakhstan, KE = Kenya, KG = Kyrgyzstan, KH = Cambodia, KN = Saint Kitts and Nevis, KW = Kuwait, LA = Laos, LB = Lebanon, LR = Liberia, LY = Libya, LC = Saint Lucia, LK = Sri Lanka, LS = Lesotho, MO = Macao, MA = Morocco, MD = Moldova, MG = Madagascar, MV = Maldives, ML = Mali, MM = Myanmar, MN = Mongolia, MZ = Mozambique, MR = Mauritania, MU = Mauritius, MW = Malawi, MY = Malaysia, NA = Namibia, NE = Niger, NG = Nigeria, NI = Nicaragua, NP = Nepal, OM = Oman, PK = Pakistan, PA = Panama, PE = Peru, PH = Philippines, PY = Paraguay, PS = Palestine (West Bank and Gaza), QA = Qatar, RU = Russia, RW = Rwanda, SA = Saudi Arabia, SD = Sudan, SN = Senegal, SG = Singapore, SL = Sierra Leone, SV = El Salvador, SO = Somalia, SS = South Sudan, ST = Sao Tome and Principe, SR = Suriname, SZ = Eswatini, SC = Seychelles, SY = Syria, TD = Chad, TG = Togo, TH = Thailand, TJ = Tajikistan, TM = Turkmenistan, TL = Timor-Leste, TT = Trinidad and Tobago, TN = Tunisia, TW = Taiwan, TZ = Tanzania, UG = Uganda, UA = Ukraine, UY = Uruguay, UZ = Uzbekistan, VC = Saint Vincent and the Grenadines, VN = Vietnam, XK = Kosovo, ZA = South Africa, ZM = Zambia, ZW = Zimbabwe. World Bank ICP 2021 survey: one price level index per country and spending group, whole country, benchmark year 2021."
},
"compare_to": {
"type": "string",
"description": "What the index is measured against, as a short name of a comparison area. Leave out for the default; the allowed values are listed in the notes for the country. OECD: 'OECD' (default, OECD average = 100), 'USA' (United States = 100) or 'EU' (EU-27 average = 100). World Bank ICP countries: leave out. The index is measured against the world average (World = 100); the gap to the United States is always included."
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country",
"product"
],
"properties": {
"country": {
"enum": [
"US",
"CA",
"BR",
"MX",
"AU",
"NZ",
"SG",
"JP",
"KR"
],
"type": "string",
"description": "Countries outside the EU, as ISO codes: US = the United States, CA = Canada, BR = Brazil, MX = Mexico, AU = Australia, NZ = New Zealand, SG = Singapore, JP = Japan, KR = South Korea. FAOSTAT annual producer (farm-gate) prices: one figure per country, product and year, usually one to two years old."
},
"product": {
"type": "string",
"description": "The crop or animal product, e.g. 'wheat', 'maize', 'rice', 'soybeans', 'potatoes', 'tomatoes', 'apples', 'bananas', 'beef', 'pork', 'chicken', 'eggs', 'milk', 'coffee', 'cotton'. US, CA, BR, MX, AU, NZ, SG, JP, KR (FAOSTAT; KR has few products): the crop or animal product, by everyday name: wheat, maize (corn), rice, barley, soybeans, potatoes, tomatoes, apples, bananas, oranges, beef, pork, chicken, eggs, milk, coffee, cotton and many more. Annual price per tonne in the country's own currency (and in US dollars where FAO gives it), also per kg. Not every country has every product: the answer lists what is available."
}
}
}| Argument | Type | Description |
|---|---|---|
| town | string | Town, city or local area. AU: use 'NSW' for the whole state; otherwise give a postcode (NSW rents are published by postcode). AU (Queensland): give a four-digit postcode; the RTA publishes by postcode, so a place name has no answer. CA: required. A town or city of 10,000 people or more, e.g. Toronto, Montréal (or Montreal), Vancouver, Calgary, Edmonton, Ottawa, Winnipeg, Halifax. Add the province to be exact ('London, Ontario'). DE: required. One of about 90 German cities, e.g. Berlin, Hamburg, München (Munich), Köln (Cologne), Frankfurt am Main, Stuttgart, Düsseldorf, Leipzig, Dresden. ES: required; a Catalan municipality, e.g. 'Barcelona', 'Sabadell', 'Girona' (Spanish or Catalan spelling). FI: optional: 'Helsinki', 'Espoo', 'Vantaa', 'Tampere', 'Turku', 'Oulu', 'Greater Helsinki', a region such as 'Uusimaa' or 'Pirkanmaa', or a district such as 'Helsinki 2'. Leave out for Finland as a whole. FR: required. An observed agglomeration: 'Paris' (the city), 'Ile-de-France' (Paris agglomeration), 'Marseille', 'Toulouse', 'Nantes', 'Rennes', 'Strasbourg', 'Bordeaux', 'Montpellier' (about 50 areas; Lyon and Lille are not observed). A name that is not observed returns the full list. GB: required. A local authority (Manchester, Leeds, Camden, Cardiff), an English region (London, North West) or England / Wales. Towns and postcodes are not published; Bristol, Hull etc. match their council area. HK: required. A region: 'Hong Kong' (Hong Kong Island), 'Kowloon' or 'New Territories'; a known district such as Mong Kok, Central or Sha Tin gives its region's figure. IE: required. A county ('Dublin', 'Cork'), a town ('Swords, Dublin', 'Galway City') or a Dublin district ('Dublin 6'). NO: required. A price zone: 'Norway' (whole country), 'Oslo', 'Akershus', 'Bergen', 'Trondheim', 'Stavanger', 'large towns', 'medium towns' or 'small towns'. NZ: required. A territorial authority or city ('Wellington', 'Auckland', 'Christchurch', 'Hamilton', 'Dunedin', 'Queenstown-Lakes'), a region ('Canterbury', 'Wellington Region') or 'New Zealand' for the whole country. A name that is both a city and a region (Wellington) gives the city. PT: any municipality ('Lisboa' / 'Lisbon', 'Porto', 'Cascais', 'Faro', 'Funchal', 'Coimbra' ... all 308) or a region ('Algarve', 'Grande Lisboa', 'Madeira', 'Açores'). Omit for Portugal as a whole. Official INE median monthly rent per m² of new leases of the last 12 months (not per home). SE: optional region group: 'Sweden' (default), 'Greater Stockholm', 'Greater Gothenburg', 'Greater Malmo', 'large municipalities' or 'small municipalities'. SE with new_build=true: optional region group: 'Sweden' (default), 'Greater Stockholm', 'Greater Gothenburg', 'Greater Malmo', 'large municipalities' or 'small municipalities'. SG: required, an HDB town such as 'Tampines', 'Bedok' or 'Toa Payoh'. TW: a city or county in English or Chinese ('Taipei' / '台北市' / '臺北市', 'New Taipei', 'Taichung', 'Kaohsiung', 'Tainan', 'Taoyuan', 'Hsinchu City', 'Hsinchu County'), or a district with its city ("Da'an, Taipei", '臺北市大安區', 'Banqiao, New Taipei'). Omit for all of Taiwan. A district name used in several cities ('Zhongzheng', 'Dongqu') needs the city too. |
| rooms | integer | NO only: number of rooms (living rooms plus bedrooms), 1 to 5 (5 means five or more). Required for Norway. |
| months | integer | How many recent months to include, for sources that hold individual rents. Ignored by sources that publish one figure per quarter or month. AU: 3 or 12 (anything up to 4 uses the latest 3 months, longer uses 12). By default the latest 3 months, widening to 12 when a postcode is quiet. AU (Queensland): ignored; the RTA publishes one median per quarter (the latest is returned). CA: ignored; the figure is for the newest October survey. DE: ignored; the figure is the census of 15 May 2022. ES: ignored; the figure is for the latest published quarter. FI: ignored; the figure is for the newest quarter with at least 5 observations. FR: ignored; the figure is for the latest year published. GB: ignored; the figure is for the latest month published. HK: ignored; the answer is the newest usable month, with the last 12 months in extra. IE: ignored; the figure is for the latest quarter published. NO: ignored; the figure is for the latest year published. NZ: ignored; the figure is for the latest month MBIE has published (about two months behind). PT: ignored; INE publishes one median per quarter, covering the 12 months to the quarter's end (the latest is returned). SE: ignored; the figure is for the latest year published. SG: window of recent months, 1 to 36. Default 12. TW: 12 or 24 whole calendar months; up to 18 gives 12 (24 if a place has too few tenancies in 12), more gives 24. The window ends at the last month that is at least 30 days old. |
| country* | string | AU = Australia, New South Wales only (rental bonds); AU = Australia, Queensland only (RTA rental bond statistics; New South Wales has its own source); CA = Canada (CMHC Rental Market Survey, average rents of purpose-built rental units, official statistic); DE = Germany (Zensus 2022 average net cold rent per m2 around the city centre, census of May 2022, official statistic); ES = Spain (Catalonia only: INCASOL registered lease deposits); FI = Finland (official average rent per m² of market-rate rented flats from Statistics Finland, by town, region or district); FR = France (observed rents in about 50 agglomerations, local rent observatories); GB = England and Wales (ONS average private rents; Scotland and Northern Ireland are not covered); HK = Hong Kong (Rating and Valuation Department, average rents of private domestic flats by class and region, official statistic); IE = Ireland (registered tenancies, Residential Tenancies Board); NO = Norway (Statistics Norway rental market survey); NZ = New Zealand (rental bond data from MBIE Tenancy Services; weekly rent in NZD); PT = Portugal (official INE median rent per m² per month of new leases, quarterly, by region and all 308 municipalities); SE = Sweden (Statistics Sweden rent survey); SE = Sweden (Statistics Sweden rent survey; with new_build=true, rents of newly built rented flats); SG = Singapore HDB public-housing flats; TW = Taiwan (Ministry of the Interior actual price registration of rentals: every declared residential tenancy, summarised by city or county and district) |
| tenancy | string | FR only: all leases (default), new = leases signed in the last year (what a new tenant faces), existing = leases of one year or more. New leases are published per dwelling type, not per size. |
| bedrooms | integer | Number of bedrooms (0 = studio). Leave out for all sizes. AU: 0 (studio), 1, 2, 3 or 4 (4 means four or more). AU (Queensland): flats 1-3, houses 2-4, townhouses 2-3. With no type and no bedrooms the answer is the most common dwelling in the postcode. CA: 0 (bachelor), 1, 2 or 3 (three or more). Leave out for two bedrooms, CMHC's usual headline size; the answer lists every size. DE: not supported (all sizes together); leave out. ES: not used. FI: optional: the number of ROOMS the Finnish way (a living room counts): 1, 2 or 3 (3 means three or more). Leave out for all sizes. FR: 0 (studio) to 3 or more; leave out for all sizes. France counts rooms including the living room, so 1 bedroom = 2 rooms (T2). GB: 1, 2, 3 or 4 (4 means four or more); leave out for all sizes. Studios are not published. Not together with property_type. HK: ignored; the RVD groups flats by saleable area. Use flat_class (A under 40 m², B 40–69.9, C 70–99.9, D 100–159.9, E 160+). Default B. IE: 1, 2, 3 or 4 (4 means four or more); leave out for all sizes. Studios are not published. NO: not used; use rooms instead (Norway counts rooms). NZ: not applied. MBIE publishes bedroom splits only by unnamed Statistics NZ area codes, not by place name; the answer says so. PT: not supported (INE does not split by bedrooms). SE: required; give the number of ROOMS (Sweden counts rooms, not bedrooms): 1, 2, 3 or 4 (4 means four or more). SE with new_build=true: optional number of ROOMS (1, 2, 3 or 4 = four or more); leave out for all new-build flats together. SG: ignored; HDB counts rooms, not bedrooms. Use flat_type ('4-ROOM'). TW: 0 (studio or open-plan) to 4; 5 means five or more. Leave out for all sizes. Not for rooms. |
| postcode | string | Postcode, for a precise area. AU: a four-digit NSW postcode, e.g. 2000 (Sydney CBD), 2150 (Parramatta), 2500 (Wollongong). AU (Queensland): a four-digit postcode, e.g. 4000 (Brisbane city), 4217 (Surfers Paradise), 4870 (Cairns), 4350 (Toowoomba). NSW postcodes (2xxx) are answered by the NSW source. CA: not used; give a town. DE: not supported; give the city as town. ES: not used. FI: not used. FR: not used; give the agglomeration as town. GB: not used (rents are published by local authority); give the area name in town. HK: not used (Hong Kong has no postcodes); give a region. IE: not used (Eircodes are not published); give a town. NO: not used; give a price zone as town. NZ: not used; rents are published by territorial authority and region. PT: not supported (INE publishes by region and municipality); give the municipality as town. SE: not used. SG: not used; give an HDB town. TW: not supported (the register has no postcodes); give the city, county or district as town. |
| flat_type | string | SG only: HDB flat type, one of 1-ROOM, 2-ROOM, 3-ROOM, 4-ROOM, 5-ROOM, EXECUTIVE ('4 ROOM' also works). Leave out for all types. |
| new_build | boolean | SE only: true = rents of newly built rented flats (built from 2022) instead of the all-flats rent survey. |
| flat_class | string | HK only: RVD flat class by saleable area, A (under 40 m²), B (40–69.9), C (70–99.9), D (100–159.9) or E (160 and over). Default B. |
| house_type | string | Kind of house, for sources that publish houses by type (needed with property_type house there). CA: not used (houses are not published). DE: not used. GB: detached, semi-detached or terraced; required with property_type house. HK: not used. IE: detached, semi-detached or terraced; required with property_type house. NZ: not applied (see property_type). TW: not available (the register does not say detached / semi-detached / terraced); use property_type house. |
| property_type | string | Kind of home: apartment (same as flat), house or room. Default 'any'. AU: apartment (flat or unit), house (includes terraces, townhouses and semi-detached) or any. Rooms are not published. AU (Queensland): apartment (flat), house or any. Townhouses are published separately and appear in extra.other_dwellings; rooms are not published. CA: apartment (or flat) means apartment buildings of three or more units; leave out for rows and apartments of three or more units. Houses and rooms are not published. DE: leave out. The census figure covers all rented dwellings together (flats and houses). ES: not used (all homes together). FI: not used (rented flats). FR: apartment (flat), house or leave out for all homes. Single rooms are not published. GB: apartment (flat) or house; leave out for all homes. For house, also give house_type. Rooms are not published. Not together with bedrooms. HK: ignored; private domestic flats only. Use flat_class for the size. IE: apartment (flat) or house; leave out for all homes. For house, also give house_type. Rooms are not published. NO: not used (the survey does not split by home type). NZ: not applied. The published place files do not split by dwelling type; the answer covers all new private tenancies and says so. PT: INE publishes one figure for all dwellings; only 'any' has an answer. SE: not used (flats in rented buildings). SG: ignored; every record is an HDB flat. Use flat_type for the size. TW: any (whole homes and self-contained studios), apartment, house (透天厝) or room (a room let separately in a shared home: 分租套房, 分租雅房; kept apart from every other figure). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country"
],
"properties": {
"town": {
"type": "string",
"minLength": 2,
"description": "Town, city or local area. AU: use 'NSW' for the whole state; otherwise give a postcode (NSW rents are published by postcode). AU (Queensland): give a four-digit postcode; the RTA publishes by postcode, so a place name has no answer. CA: required. A town or city of 10,000 people or more, e.g. Toronto, Montréal (or Montreal), Vancouver, Calgary, Edmonton, Ottawa, Winnipeg, Halifax. Add the province to be exact ('London, Ontario'). DE: required. One of about 90 German cities, e.g. Berlin, Hamburg, München (Munich), Köln (Cologne), Frankfurt am Main, Stuttgart, Düsseldorf, Leipzig, Dresden. ES: required; a Catalan municipality, e.g. 'Barcelona', 'Sabadell', 'Girona' (Spanish or Catalan spelling). FI: optional: 'Helsinki', 'Espoo', 'Vantaa', 'Tampere', 'Turku', 'Oulu', 'Greater Helsinki', a region such as 'Uusimaa' or 'Pirkanmaa', or a district such as 'Helsinki 2'. Leave out for Finland as a whole. FR: required. An observed agglomeration: 'Paris' (the city), 'Ile-de-France' (Paris agglomeration), 'Marseille', 'Toulouse', 'Nantes', 'Rennes', 'Strasbourg', 'Bordeaux', 'Montpellier' (about 50 areas; Lyon and Lille are not observed). A name that is not observed returns the full list. GB: required. A local authority (Manchester, Leeds, Camden, Cardiff), an English region (London, North West) or England / Wales. Towns and postcodes are not published; Bristol, Hull etc. match their council area. HK: required. A region: 'Hong Kong' (Hong Kong Island), 'Kowloon' or 'New Territories'; a known district such as Mong Kok, Central or Sha Tin gives its region's figure. IE: required. A county ('Dublin', 'Cork'), a town ('Swords, Dublin', 'Galway City') or a Dublin district ('Dublin 6'). NO: required. A price zone: 'Norway' (whole country), 'Oslo', 'Akershus', 'Bergen', 'Trondheim', 'Stavanger', 'large towns', 'medium towns' or 'small towns'. NZ: required. A territorial authority or city ('Wellington', 'Auckland', 'Christchurch', 'Hamilton', 'Dunedin', 'Queenstown-Lakes'), a region ('Canterbury', 'Wellington Region') or 'New Zealand' for the whole country. A name that is both a city and a region (Wellington) gives the city. PT: any municipality ('Lisboa' / 'Lisbon', 'Porto', 'Cascais', 'Faro', 'Funchal', 'Coimbra' ... all 308) or a region ('Algarve', 'Grande Lisboa', 'Madeira', 'Açores'). Omit for Portugal as a whole. Official INE median monthly rent per m² of new leases of the last 12 months (not per home). SE: optional region group: 'Sweden' (default), 'Greater Stockholm', 'Greater Gothenburg', 'Greater Malmo', 'large municipalities' or 'small municipalities'. SE with new_build=true: optional region group: 'Sweden' (default), 'Greater Stockholm', 'Greater Gothenburg', 'Greater Malmo', 'large municipalities' or 'small municipalities'. SG: required, an HDB town such as 'Tampines', 'Bedok' or 'Toa Payoh'. TW: a city or county in English or Chinese ('Taipei' / '台北市' / '臺北市', 'New Taipei', 'Taichung', 'Kaohsiung', 'Tainan', 'Taoyuan', 'Hsinchu City', 'Hsinchu County'), or a district with its city (\"Da'an, Taipei\", '臺北市大安區', 'Banqiao, New Taipei'). Omit for all of Taiwan. A district name used in several cities ('Zhongzheng', 'Dongqu') needs the city too."
},
"rooms": {
"type": "integer",
"maximum": 10,
"minimum": 1,
"description": "NO only: number of rooms (living rooms plus bedrooms), 1 to 5 (5 means five or more). Required for Norway."
},
"months": {
"type": "integer",
"maximum": 36,
"minimum": 1,
"description": "How many recent months to include, for sources that hold individual rents. Ignored by sources that publish one figure per quarter or month. AU: 3 or 12 (anything up to 4 uses the latest 3 months, longer uses 12). By default the latest 3 months, widening to 12 when a postcode is quiet. AU (Queensland): ignored; the RTA publishes one median per quarter (the latest is returned). CA: ignored; the figure is for the newest October survey. DE: ignored; the figure is the census of 15 May 2022. ES: ignored; the figure is for the latest published quarter. FI: ignored; the figure is for the newest quarter with at least 5 observations. FR: ignored; the figure is for the latest year published. GB: ignored; the figure is for the latest month published. HK: ignored; the answer is the newest usable month, with the last 12 months in extra. IE: ignored; the figure is for the latest quarter published. NO: ignored; the figure is for the latest year published. NZ: ignored; the figure is for the latest month MBIE has published (about two months behind). PT: ignored; INE publishes one median per quarter, covering the 12 months to the quarter's end (the latest is returned). SE: ignored; the figure is for the latest year published. SG: window of recent months, 1 to 36. Default 12. TW: 12 or 24 whole calendar months; up to 18 gives 12 (24 if a place has too few tenancies in 12), more gives 24. The window ends at the last month that is at least 30 days old."
},
"country": {
"enum": [
"AU",
"CA",
"DE",
"ES",
"FI",
"FR",
"GB",
"HK",
"IE",
"NO",
"NZ",
"PT",
"SE",
"SG",
"TW"
],
"type": "string",
"description": "AU = Australia, New South Wales only (rental bonds); AU = Australia, Queensland only (RTA rental bond statistics; New South Wales has its own source); CA = Canada (CMHC Rental Market Survey, average rents of purpose-built rental units, official statistic); DE = Germany (Zensus 2022 average net cold rent per m2 around the city centre, census of May 2022, official statistic); ES = Spain (Catalonia only: INCASOL registered lease deposits); FI = Finland (official average rent per m² of market-rate rented flats from Statistics Finland, by town, region or district); FR = France (observed rents in about 50 agglomerations, local rent observatories); GB = England and Wales (ONS average private rents; Scotland and Northern Ireland are not covered); HK = Hong Kong (Rating and Valuation Department, average rents of private domestic flats by class and region, official statistic); IE = Ireland (registered tenancies, Residential Tenancies Board); NO = Norway (Statistics Norway rental market survey); NZ = New Zealand (rental bond data from MBIE Tenancy Services; weekly rent in NZD); PT = Portugal (official INE median rent per m² per month of new leases, quarterly, by region and all 308 municipalities); SE = Sweden (Statistics Sweden rent survey); SE = Sweden (Statistics Sweden rent survey; with new_build=true, rents of newly built rented flats); SG = Singapore HDB public-housing flats; TW = Taiwan (Ministry of the Interior actual price registration of rentals: every declared residential tenancy, summarised by city or county and district)"
},
"tenancy": {
"enum": [
"all",
"new",
"existing"
],
"type": "string",
"description": "FR only: all leases (default), new = leases signed in the last year (what a new tenant faces), existing = leases of one year or more. New leases are published per dwelling type, not per size."
},
"bedrooms": {
"type": "integer",
"maximum": 10,
"minimum": 0,
"description": "Number of bedrooms (0 = studio). Leave out for all sizes. AU: 0 (studio), 1, 2, 3 or 4 (4 means four or more). AU (Queensland): flats 1-3, houses 2-4, townhouses 2-3. With no type and no bedrooms the answer is the most common dwelling in the postcode. CA: 0 (bachelor), 1, 2 or 3 (three or more). Leave out for two bedrooms, CMHC's usual headline size; the answer lists every size. DE: not supported (all sizes together); leave out. ES: not used. FI: optional: the number of ROOMS the Finnish way (a living room counts): 1, 2 or 3 (3 means three or more). Leave out for all sizes. FR: 0 (studio) to 3 or more; leave out for all sizes. France counts rooms including the living room, so 1 bedroom = 2 rooms (T2). GB: 1, 2, 3 or 4 (4 means four or more); leave out for all sizes. Studios are not published. Not together with property_type. HK: ignored; the RVD groups flats by saleable area. Use flat_class (A under 40 m², B 40–69.9, C 70–99.9, D 100–159.9, E 160+). Default B. IE: 1, 2, 3 or 4 (4 means four or more); leave out for all sizes. Studios are not published. NO: not used; use rooms instead (Norway counts rooms). NZ: not applied. MBIE publishes bedroom splits only by unnamed Statistics NZ area codes, not by place name; the answer says so. PT: not supported (INE does not split by bedrooms). SE: required; give the number of ROOMS (Sweden counts rooms, not bedrooms): 1, 2, 3 or 4 (4 means four or more). SE with new_build=true: optional number of ROOMS (1, 2, 3 or 4 = four or more); leave out for all new-build flats together. SG: ignored; HDB counts rooms, not bedrooms. Use flat_type ('4-ROOM'). TW: 0 (studio or open-plan) to 4; 5 means five or more. Leave out for all sizes. Not for rooms."
},
"postcode": {
"type": "string",
"description": "Postcode, for a precise area. AU: a four-digit NSW postcode, e.g. 2000 (Sydney CBD), 2150 (Parramatta), 2500 (Wollongong). AU (Queensland): a four-digit postcode, e.g. 4000 (Brisbane city), 4217 (Surfers Paradise), 4870 (Cairns), 4350 (Toowoomba). NSW postcodes (2xxx) are answered by the NSW source. CA: not used; give a town. DE: not supported; give the city as town. ES: not used. FI: not used. FR: not used; give the agglomeration as town. GB: not used (rents are published by local authority); give the area name in town. HK: not used (Hong Kong has no postcodes); give a region. IE: not used (Eircodes are not published); give a town. NO: not used; give a price zone as town. NZ: not used; rents are published by territorial authority and region. PT: not supported (INE publishes by region and municipality); give the municipality as town. SE: not used. SG: not used; give an HDB town. TW: not supported (the register has no postcodes); give the city, county or district as town."
},
"flat_type": {
"type": "string",
"description": "SG only: HDB flat type, one of 1-ROOM, 2-ROOM, 3-ROOM, 4-ROOM, 5-ROOM, EXECUTIVE ('4 ROOM' also works). Leave out for all types."
},
"new_build": {
"type": "boolean",
"description": "SE only: true = rents of newly built rented flats (built from 2022) instead of the all-flats rent survey."
},
"flat_class": {
"type": "string",
"description": "HK only: RVD flat class by saleable area, A (under 40 m²), B (40–69.9), C (70–99.9), D (100–159.9) or E (160 and over). Default B."
},
"house_type": {
"enum": [
"detached",
"semi-detached",
"terraced"
],
"type": "string",
"description": "Kind of house, for sources that publish houses by type (needed with property_type house there). CA: not used (houses are not published). DE: not used. GB: detached, semi-detached or terraced; required with property_type house. HK: not used. IE: detached, semi-detached or terraced; required with property_type house. NZ: not applied (see property_type). TW: not available (the register does not say detached / semi-detached / terraced); use property_type house."
},
"property_type": {
"enum": [
"any",
"apartment",
"flat",
"house",
"room"
],
"type": "string",
"description": "Kind of home: apartment (same as flat), house or room. Default 'any'. AU: apartment (flat or unit), house (includes terraces, townhouses and semi-detached) or any. Rooms are not published. AU (Queensland): apartment (flat), house or any. Townhouses are published separately and appear in extra.other_dwellings; rooms are not published. CA: apartment (or flat) means apartment buildings of three or more units; leave out for rows and apartments of three or more units. Houses and rooms are not published. DE: leave out. The census figure covers all rented dwellings together (flats and houses). ES: not used (all homes together). FI: not used (rented flats). FR: apartment (flat), house or leave out for all homes. Single rooms are not published. GB: apartment (flat) or house; leave out for all homes. For house, also give house_type. Rooms are not published. Not together with bedrooms. HK: ignored; private domestic flats only. Use flat_class for the size. IE: apartment (flat) or house; leave out for all homes. For house, also give house_type. Rooms are not published. NO: not used (the survey does not split by home type). NZ: not applied. The published place files do not split by dwelling type; the answer covers all new private tenancies and says so. PT: INE publishes one figure for all dwellings; only 'any' has an answer. SE: not used (flats in rented buildings). SG: ignored; every record is an HDB flat. Use flat_type for the size. TW: any (whole homes and self-contained studios), apartment, house (透天厝) or room (a room let separately in a shared home: 分租套房, 分租雅房; kept apart from every other figure)."
}
}
}| country* | string | CA = Canada (Statistics Canada: average posted tuition fees of publicly funded universities, by province, Canadian or international students, undergraduate or graduate); European countries as ISO codes (GR for Greece): BE = Belgium, BG = Bulgaria, CZ = Czechia, DK = Denmark, DE = Germany, EE = Estonia, IE = Ireland, GR = Greece, ES = Spain, FR = France, HR = Croatia, IT = Italy, CY = Cyprus, LV = Latvia, LT = Lithuania, LU = Luxembourg, HU = Hungary, MT = Malta, NL = Netherlands, AT = Austria, PL = Poland, PT = Portugal, RO = Romania, SI = Slovenia, SK = Slovakia, FI = Finland, SE = Sweden, AL = Albania, BA = Bosnia and Herzegovina, CH = Switzerland, IS = Iceland, LI = Liechtenstein, ME = Montenegro, MK = North Macedonia, NO = Norway, RS = Serbia, TR = Turkey; TW = Taiwan (Ministry of Education: posted tuition and miscellaneous fee standards per semester, bachelor's day programmes, by faculty group) |
| faculty | string | Taiwan only: faculty group (medicine, dentistry, medical_college, engineering, science_agri, business, humanities_law, other). Default humanities_law. Words like law, business, engineering, medicine, nursing also work. |
| province | string | Canada only: a province (Ontario, Quebec, BC, Alberta ...) or leave out for the Canada average. Yukon is mostly not published; the other territories are not in the table. |
| community | string | BE only: the higher-education system, because Belgium has three with different fees: fr (French Community), nl (Flemish Community) or de (German-speaking Community). |
| ownership | string | Taiwan only: public or private institutions (default both). |
| study_mode | string | full-time (the default) or part-time. Canada: full-time only (the default). Europe, Eurydice: full-time (default) or part-time. Taiwan: full-time day programmes only (the default). |
| school_type | string | Taiwan only: university (general universities) or technical (technical and vocational colleges); default both. |
| student_group | string | Who pays: home (nationals and EU students who pay home fees, the default), international (students from outside the EU/EEA), non-state-subsidised (self-financed places), specific-discipline (for example medicine), foreign-language (courses taught in another language). Canada, Statistics Canada: home = Canadian citizens and permanent residents (default) or international. Other groups are not published. Europe, Eurydice: home (default), international (non-EU/EEA), non-state-subsidised, specific-discipline, foreign-language. Not every group exists in every country: the answer says when a fee is not available. Taiwan: one fee standard per institution; home is the only group. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country"
],
"properties": {
"cycle": {
"enum": [
"first",
"second"
],
"type": "string",
"description": "Degree level: first = bachelor's (first cycle, the default), second = master's (second cycle). Also accepts bachelor, master, undergraduate, postgraduate. Canada, Statistics Canada: first = undergraduate (default), second = graduate (master's and doctorate). Europe, Eurydice: first = bachelor's (default), second = master's. Taiwan: first = bachelor's (the only level in the file)."
},
"country": {
"enum": [
"CA",
"BE",
"BG",
"CZ",
"DK",
"DE",
"EE",
"IE",
"GR",
"ES",
"FR",
"HR",
"IT",
"CY",
"LV",
"LT",
"LU",
"HU",
"MT",
"NL",
"AT",
"PL",
"PT",
"RO",
"SI",
"SK",
"FI",
"SE",
"AL",
"BA",
"CH",
"IS",
"LI",
"ME",
"MK",
"NO",
"RS",
"TR",
"TW"
],
"type": "string",
"description": "CA = Canada (Statistics Canada: average posted tuition fees of publicly funded universities, by province, Canadian or international students, undergraduate or graduate); European countries as ISO codes (GR for Greece): BE = Belgium, BG = Bulgaria, CZ = Czechia, DK = Denmark, DE = Germany, EE = Estonia, IE = Ireland, GR = Greece, ES = Spain, FR = France, HR = Croatia, IT = Italy, CY = Cyprus, LV = Latvia, LT = Lithuania, LU = Luxembourg, HU = Hungary, MT = Malta, NL = Netherlands, AT = Austria, PL = Poland, PT = Portugal, RO = Romania, SI = Slovenia, SK = Slovakia, FI = Finland, SE = Sweden, AL = Albania, BA = Bosnia and Herzegovina, CH = Switzerland, IS = Iceland, LI = Liechtenstein, ME = Montenegro, MK = North Macedonia, NO = Norway, RS = Serbia, TR = Turkey; TW = Taiwan (Ministry of Education: posted tuition and miscellaneous fee standards per semester, bachelor's day programmes, by faculty group)"
},
"faculty": {
"type": "string",
"description": "Taiwan only: faculty group (medicine, dentistry, medical_college, engineering, science_agri, business, humanities_law, other). Default humanities_law. Words like law, business, engineering, medicine, nursing also work."
},
"province": {
"type": "string",
"description": "Canada only: a province (Ontario, Quebec, BC, Alberta ...) or leave out for the Canada average. Yukon is mostly not published; the other territories are not in the table."
},
"community": {
"type": "string",
"description": "BE only: the higher-education system, because Belgium has three with different fees: fr (French Community), nl (Flemish Community) or de (German-speaking Community)."
},
"ownership": {
"type": "string",
"description": "Taiwan only: public or private institutions (default both)."
},
"study_mode": {
"enum": [
"full-time",
"part-time"
],
"type": "string",
"description": "full-time (the default) or part-time. Canada: full-time only (the default). Europe, Eurydice: full-time (default) or part-time. Taiwan: full-time day programmes only (the default)."
},
"school_type": {
"type": "string",
"description": "Taiwan only: university (general universities) or technical (technical and vocational colleges); default both."
},
"student_group": {
"enum": [
"home",
"international",
"non-state-subsidised",
"specific-discipline",
"foreign-language"
],
"type": "string",
"description": "Who pays: home (nationals and EU students who pay home fees, the default), international (students from outside the EU/EEA), non-state-subsidised (self-financed places), specific-discipline (for example medicine), foreign-language (courses taught in another language). Canada, Statistics Canada: home = Canadian citizens and permanent residents (default) or international. Other groups are not published. Europe, Eurydice: home (default), international (non-EU/EEA), non-state-subsidised, specific-discipline, foreign-language. Not every group exists in every country: the answer says when a fee is not available. Taiwan: one fee standard per institution; home is the only group."
}
}
}| string |
| CA only: one wholesale centre (Calgary, Edmonton, Vancouver or Winnipeg). Leave out for all centres together. AAFC does not quote every centre every week (the latest file has only Calgary and Winnipeg); an unquoted centre answers with the list of centres that are quoted. |
| country* | string | AU = Australia (Meat & Livestock Australia: daily weighted average saleyard auction prices for cattle and sheep, national indicators, not monthly); CA = Canada (AAFC weekly wholesale asking prices of fresh fruit and vegetables at Calgary, Edmonton, Vancouver and Winnipeg, quoted not paid); DE = Germany (BLE weekly national wholesale-market quotations for fruit and vegetables, quoted not paid); FR = France (FranceAgriMer RNM quotes of fruit and vegetables at producer markets, dispatch, import and wholesale, EUR excluding VAT per kg, quoted not paid, daily); GB = England and Wales (DEFRA average wholesale prices of home-grown fruit and vegetables at the Birmingham, Bristol, Manchester and London markets, quoted not paid, about every two weeks); HK = Hong Kong (AFCD daily average reference wholesale prices of fresh food, posted by wholesalers, not paid prices); MY = Malaysia (Department of Statistics Malaysia: monthly average fish and seafood prices per kg at landing, wholesale and retail, official statistic, not a live price) |
| product* | string | The food in plain words, e.g. 'live pig', 'chicken', 'eggs', 'grass carp', 'tomato'. The list for each country is in the tool notes. Australia: cattle or sheep in everyday words, e.g. cattle, western young cattle, restocker steers, feeder steers, steers, dairy cows, light lamb, lamb, heavy lamb, merino lamb, restocker lamb, mutton, restocker heifers, cows. Prices are Australian dollars: cents per kg (carcase or live weight, the answer says which) or dollars per head for the online indicators. The answer is for the newest trading day, not a month. CA: fresh fruit and vegetables such as apples, bananas, grapes, avocados, carrots, cabbage, cucumbers, celery, broccoli, cauliflower, beets, garlic, ginger, blueberries and Chinese vegetables. The answer is the median CAD per kg of the week's wholesale asking quotes with the 10th to 90th percentile and the number of quotes; add market=Calgary, Edmonton, Vancouver or Winnipeg for one centre. DE: fruit and vegetables on the German wholesale markets, in English or German: apples, pears, cucumbers, tomatoes, peppers, grapes, kiwis, plums, lemons, zucchini, oranges, mandarins, onions, aubergines, strawberries, cauliflower, carrots, peaches, nectarines, bananas, lettuce, leeks, brussels sprouts and more (no potatoes). A variety such as 'elstar' also works. The answer is the median of that week's national quotations in EUR per kg, with the cheapest and dearest quotation and the change on the previous week. FR: fruit and vegetables, English or French names: carrot, tomato, potato, onion, leek, cabbage, cauliflower, courgette, lettuce, apple, pear, orange, strawberry, peach, grape and about 60 more. The answer is the median of the quoted average prices per kg across the market lines of the last 7 days (retail, organic and bunch lines left out), with the lowest and highest quote and the markets. GB: home-grown fruit and vegetables: apples (gala, bramley, cox...), pears, plums, strawberries, raspberries, blackberries, blueberries, cherries, gooseberries, currants, carrots, onions, leeks, cauliflower, cabbage, calabrese, lettuce, tomatoes, cucumbers, courgettes, capsicum, beans, peas, beetroot, parsnips, swede, turnip, sprouts, celery, rhubarb, kale and more (no potatoes). An item with several varieties gives the mean of the varieties and lists each; add the variety (for example 'gala apples') for one price. Prices are GBP per kg, per head, per twin pack or per stem; the answer names the unit and the date. HK: live pig, live cattle, live chicken (local or mainland), eggs (mainland, USA, Germany), marine fish (golden thread, yellow croaker, mackerel, hairtail...), freshwater fish (grass carp, big head, mud carp) and vegetables (tomato, potato, broccoli, spinach, cabbage, Chinese kale, celery...). Prices are HK$ per kg (converted from per catty) or HK$ per egg; the answer names the unit and the day. Malaysia: a fish or seafood in English or Malay, e.g. mackerel, kembong, tenggiri, pomfret, bawal_putih, prawn, udang_harimau, squid, sotong_katak, crab, siakap, kerapu, bilis. About 150 kinds are published; a word that fits several (mackerel, prawn) returns the list to choose from. Prices are in ringgit per kg. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country",
"product"
],
"properties": {
"level": {
"type": "string",
"description": "Malaysia fish only: ex_vessel (the price fishers get at first sale at landing; default), wholesale or retail."
},
"market": {
"type": "string",
"description": "CA only: one wholesale centre (Calgary, Edmonton, Vancouver or Winnipeg). Leave out for all centres together. AAFC does not quote every centre every week (the latest file has only Calgary and Winnipeg); an unquoted centre answers with the list of centres that are quoted."
},
"country": {
"enum": [
"AU",
"CA",
"DE",
"FR",
"GB",
"HK",
"MY"
],
"type": "string",
"description": "AU = Australia (Meat & Livestock Australia: daily weighted average saleyard auction prices for cattle and sheep, national indicators, not monthly); CA = Canada (AAFC weekly wholesale asking prices of fresh fruit and vegetables at Calgary, Edmonton, Vancouver and Winnipeg, quoted not paid); DE = Germany (BLE weekly national wholesale-market quotations for fruit and vegetables, quoted not paid); FR = France (FranceAgriMer RNM quotes of fruit and vegetables at producer markets, dispatch, import and wholesale, EUR excluding VAT per kg, quoted not paid, daily); GB = England and Wales (DEFRA average wholesale prices of home-grown fruit and vegetables at the Birmingham, Bristol, Manchester and London markets, quoted not paid, about every two weeks); HK = Hong Kong (AFCD daily average reference wholesale prices of fresh food, posted by wholesalers, not paid prices); MY = Malaysia (Department of Statistics Malaysia: monthly average fish and seafood prices per kg at landing, wholesale and retail, official statistic, not a live price)"
},
"product": {
"type": "string",
"description": "The food in plain words, e.g. 'live pig', 'chicken', 'eggs', 'grass carp', 'tomato'. The list for each country is in the tool notes. Australia: cattle or sheep in everyday words, e.g. cattle, western young cattle, restocker steers, feeder steers, steers, dairy cows, light lamb, lamb, heavy lamb, merino lamb, restocker lamb, mutton, restocker heifers, cows. Prices are Australian dollars: cents per kg (carcase or live weight, the answer says which) or dollars per head for the online indicators. The answer is for the newest trading day, not a month. CA: fresh fruit and vegetables such as apples, bananas, grapes, avocados, carrots, cabbage, cucumbers, celery, broccoli, cauliflower, beets, garlic, ginger, blueberries and Chinese vegetables. The answer is the median CAD per kg of the week's wholesale asking quotes with the 10th to 90th percentile and the number of quotes; add market=Calgary, Edmonton, Vancouver or Winnipeg for one centre. DE: fruit and vegetables on the German wholesale markets, in English or German: apples, pears, cucumbers, tomatoes, peppers, grapes, kiwis, plums, lemons, zucchini, oranges, mandarins, onions, aubergines, strawberries, cauliflower, carrots, peaches, nectarines, bananas, lettuce, leeks, brussels sprouts and more (no potatoes). A variety such as 'elstar' also works. The answer is the median of that week's national quotations in EUR per kg, with the cheapest and dearest quotation and the change on the previous week. FR: fruit and vegetables, English or French names: carrot, tomato, potato, onion, leek, cabbage, cauliflower, courgette, lettuce, apple, pear, orange, strawberry, peach, grape and about 60 more. The answer is the median of the quoted average prices per kg across the market lines of the last 7 days (retail, organic and bunch lines left out), with the lowest and highest quote and the markets. GB: home-grown fruit and vegetables: apples (gala, bramley, cox...), pears, plums, strawberries, raspberries, blackberries, blueberries, cherries, gooseberries, currants, carrots, onions, leeks, cauliflower, cabbage, calabrese, lettuce, tomatoes, cucumbers, courgettes, capsicum, beans, peas, beetroot, parsnips, swede, turnip, sprouts, celery, rhubarb, kale and more (no potatoes). An item with several varieties gives the mean of the varieties and lists each; add the variety (for example 'gala apples') for one price. Prices are GBP per kg, per head, per twin pack or per stem; the answer names the unit and the date. HK: live pig, live cattle, live chicken (local or mainland), eggs (mainland, USA, Germany), marine fish (golden thread, yellow croaker, mackerel, hairtail...), freshwater fish (grass carp, big head, mud carp) and vegetables (tomato, potato, broccoli, spinach, cabbage, Chinese kale, celery...). Prices are HK$ per kg (converted from per catty) or HK$ per egg; the answer names the unit and the day. Malaysia: a fish or seafood in English or Malay, e.g. mackerel, kembong, tenggiri, pomfret, bawal_putih, prawn, udang_harimau, squid, sotong_katak, crab, siakap, kerapu, bilis. About 150 kinds are published; a word that fits several (mackerel, prawn) returns the list to choose from. Prices are in ringgit per kg."
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country",
"product"
],
"properties": {
"market": {
"type": "string",
"description": "One wholesale market, only where the source publishes by market (for example a city name). Leave out for all markets together. TW: optional wholesale market: taipei, banqiao, sanchong, yilan, taoyuan, taichung, fengyuan, xihu, xiluo, chiayi, dongshi, kaohsiung, fengshan, pingtung, taitung, hualien, tainan, changhua (or the Taiwanese name such as 西螺). Leave out for all markets together. Not every market trades every product."
},
"country": {
"enum": [
"TW"
],
"type": "string",
"description": "TW = Taiwan (daily trading averages at the wholesale vegetable and fruit markets)"
},
"product": {
"type": "string",
"description": "The vegetable or fruit in plain words, e.g. 'cabbage', 'tomato', 'banana', 'pineapple'. The local-language name also works. The full list is in the tool notes. TW: required. Vegetable or fruit by English name or Taiwanese name, in NT$ per kg: cabbage, chinese cabbage, pak choi, water spinach, celery, cauliflower, broccoli, cucumber, luffa, bitter gourd, wax gourd, eggplant, tomato, cherry tomato, bell pepper, chili, green beans, peas, corn, radish, carrot, onion, spring onion, sweet potato, potato, taro, bean sprouts, gai lan, banana, pineapple, ponkan, orange, lemon, grapefruit, pomelo, watermelon, melon, papaya, guava, wax apple, grapes, apple, pear, persimmon, dragon fruit, avocado, kiwi, sugar apple, passion fruit, coconut. Imported produce is left out unless fewer than 5 domestic records exist."
}
}
}| string |
| AU only: NEM region NSW1 (New South Wales incl. ACT, default), QLD1, SA1, TAS1 or VIC1; short names like NSW, VIC or Queensland also work. |
| country* | string | AU = Australia (National Electricity Market, five regions; prices in Australian dollars per MWh, not euro); DE = Germany (Germany/Luxembourg bidding zone, SMARD day-ahead hourly auction prices); Day-ahead wholesale power for ES = Spain and PT = Portugal (Iberian market, OMIE); Day-ahead wholesale power for AT = Austria, BE = Belgium, DK = Denmark, FR = France, IT = Italy, NL = the Netherlands, NO = Norway, PL = Poland (Germany is DE, served separately); Spot wholesale power for GB = Great Britain (Elexon market index, in pounds per MWh) |
| lookback_days | integer | How many recent days of hourly prices to include. Default 7, at most 14. AU: 1 to 7 trading days of five-minute prices (default 3); each five-minute interval counts as one record. Prices are in Australian dollars (AUD) per MWh. DE: 1 to 14 days of hourly prices (default 7); each hour counts as one record. ES/PT: 1 to 14 days of hourly average prices (default 7); each hour counts as one record. AT/BE/DK/FR/IT/NL/NO/PL: 1 to 14 days of hourly average prices (default 7); each hour counts as one record. GB: 1 to 14 days of half-hourly prices (default 7); each half-hour with traded volume counts as one record. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country"
],
"properties": {
"days": {
"type": "integer",
"maximum": 366,
"minimum": 2,
"description": "How many recent days to include. Default 30."
},
"zone": {
"type": "string",
"description": "Bidding zone, only where a country has more than one: DK = DK1 (west, default) or DK2 (east). IT answers northern Italy (IT-North), NO south-west Norway (NO2); other countries have one zone."
},
"market": {
"enum": [
"day-ahead"
],
"type": "string",
"description": "Which wholesale market. Only day-ahead (the next-day hourly auction) is available. AU: spot only (AEMO's five-minute regional price), not day-ahead; leave it out. DE: day-ahead only (the hourly auction held the day before delivery). ES/PT: day-ahead only (the auction held the day before delivery). AT/BE/DK/FR/IT/NL/NO/PL: day-ahead only (the auction held the day before delivery). GB: the half-hourly spot market index (traded prices); the day-ahead option is not used. Prices are in pounds, not euro."
},
"months": {
"type": "integer",
"maximum": 360,
"minimum": 2,
"description": "Instead of days: how many whole months of monthly history to return, where a source has loaded long history."
},
"region": {
"type": "string",
"description": "AU only: NEM region NSW1 (New South Wales incl. ACT, default), QLD1, SA1, TAS1 or VIC1; short names like NSW, VIC or Queensland also work."
},
"country": {
"enum": [
"AU",
"DE",
"ES",
"PT",
"AT",
"BE",
"DK",
"FR",
"IT",
"NL",
"NO",
"PL",
"GB"
],
"type": "string",
"description": "AU = Australia (National Electricity Market, five regions; prices in Australian dollars per MWh, not euro); DE = Germany (Germany/Luxembourg bidding zone, SMARD day-ahead hourly auction prices); Day-ahead wholesale power for ES = Spain and PT = Portugal (Iberian market, OMIE); Day-ahead wholesale power for AT = Austria, BE = Belgium, DK = Denmark, FR = France, IT = Italy, NL = the Netherlands, NO = Norway, PL = Poland (Germany is DE, served separately); Spot wholesale power for GB = Great Britain (Elexon market index, in pounds per MWh)"
},
"lookback_days": {
"type": "integer",
"maximum": 14,
"minimum": 1,
"description": "How many recent days of hourly prices to include. Default 7, at most 14. AU: 1 to 7 trading days of five-minute prices (default 3); each five-minute interval counts as one record. Prices are in Australian dollars (AUD) per MWh. DE: 1 to 14 days of hourly prices (default 7); each hour counts as one record. ES/PT: 1 to 14 days of hourly average prices (default 7); each hour counts as one record. AT/BE/DK/FR/IT/NL/NO/PL: 1 to 14 days of hourly average prices (default 7); each hour counts as one record. GB: 1 to 14 days of half-hourly prices (default 7); each half-hour with traded volume counts as one record."
}
}
}| region | string | AU only: NEM region NSW1 (New South Wales incl. ACT, default), QLD1, SA1, TAS1 or VIC1; short names like NSW, VIC or Queensland also work. |
| country* | string | AU = Australia (National Electricity Market, five regions; prices in Australian dollars per MWh, not euro); DE = Germany (Germany/Luxembourg bidding zone, SMARD day-ahead hourly auction prices); Day-ahead wholesale power for ES = Spain and PT = Portugal (Iberian market, OMIE); Day-ahead wholesale power for AT = Austria, BE = Belgium, DK = Denmark, FR = France, IT = Italy, NL = the Netherlands, NO = Norway, PL = Poland (Germany is DE, served separately); Spot wholesale power for GB = Great Britain (Elexon market index, in pounds per MWh) |
| lookback_days | integer | How many recent days of hourly prices to include. Default 7, at most 14. AU: 1 to 7 trading days of five-minute prices (default 3); each five-minute interval counts as one record. Prices are in Australian dollars (AUD) per MWh. DE: 1 to 14 days of hourly prices (default 7); each hour counts as one record. ES/PT: 1 to 14 days of hourly average prices (default 7); each hour counts as one record. AT/BE/DK/FR/IT/NL/NO/PL: 1 to 14 days of hourly average prices (default 7); each hour counts as one record. GB: 1 to 14 days of half-hourly prices (default 7); each half-hour with traded volume counts as one record. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"country"
],
"properties": {
"zone": {
"type": "string",
"description": "Bidding zone, only where a country has more than one: DK = DK1 (west, default) or DK2 (east). IT answers northern Italy (IT-North), NO south-west Norway (NO2); other countries have one zone."
},
"market": {
"enum": [
"day-ahead"
],
"type": "string",
"description": "Which wholesale market. Only day-ahead (the next-day hourly auction) is available. AU: spot only (AEMO's five-minute regional price), not day-ahead; leave it out. DE: day-ahead only (the hourly auction held the day before delivery). ES/PT: day-ahead only (the auction held the day before delivery). AT/BE/DK/FR/IT/NL/NO/PL: day-ahead only (the auction held the day before delivery). GB: the half-hourly spot market index (traded prices); the day-ahead option is not used. Prices are in pounds, not euro."
},
"region": {
"type": "string",
"description": "AU only: NEM region NSW1 (New South Wales incl. ACT, default), QLD1, SA1, TAS1 or VIC1; short names like NSW, VIC or Queensland also work."
},
"country": {
"enum": [
"AU",
"DE",
"ES",
"PT",
"AT",
"BE",
"DK",
"FR",
"IT",
"NL",
"NO",
"PL",
"GB"
],
"type": "string",
"description": "AU = Australia (National Electricity Market, five regions; prices in Australian dollars per MWh, not euro); DE = Germany (Germany/Luxembourg bidding zone, SMARD day-ahead hourly auction prices); Day-ahead wholesale power for ES = Spain and PT = Portugal (Iberian market, OMIE); Day-ahead wholesale power for AT = Austria, BE = Belgium, DK = Denmark, FR = France, IT = Italy, NL = the Netherlands, NO = Norway, PL = Poland (Germany is DE, served separately); Spot wholesale power for GB = Great Britain (Elexon market index, in pounds per MWh)"
},
"lookback_days": {
"type": "integer",
"maximum": 14,
"minimum": 1,
"description": "How many recent days of hourly prices to include. Default 7, at most 14. AU: 1 to 7 trading days of five-minute prices (default 3); each five-minute interval counts as one record. Prices are in Australian dollars (AUD) per MWh. DE: 1 to 14 days of hourly prices (default 7); each hour counts as one record. ES/PT: 1 to 14 days of hourly average prices (default 7); each hour counts as one record. AT/BE/DK/FR/IT/NL/NO/PL: 1 to 14 days of hourly average prices (default 7); each hour counts as one record. GB: 1 to 14 days of half-hourly prices (default 7); each half-hour with traded volume counts as one record."
}
}
}