Compare lodging + meals across cities
compare_city_costsCompare covered cities for a stay of N days, or for exact dates. Returns per-city lodging and meal components, a lodging + meals subtotal, the assumptions and formulas used, observed ranges, sample sizes, source coverage, freshness, and the categories that are explicitly NOT included. This is not a cost-of-living total.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| days | No | Number of days/nights to price. Ignored in exact mode. | |
| rooms | No | ||
| cities | No | City IDs such as 'th-bangkok'. Call get_dataset_coverage for the covered list. | |
| people | No | ||
| checkin | No | Exact mode: use with checkout. | |
| checkout | No | ||
| countries | No | ISO 3166-1 alpha-2 country codes, e.g. ['TH','VN']. | |
| components | No | Which components the subtotal covers. Pass ['meals'] to get a complete meals-only answer for cities that have meal prices but no lodging price, instead of a null lodging+meals subtotal. The returned subtotal_label always names exactly what the figure contains. | |
| lodging_types | No | ||
| freshness_days | No | Only use observations collected within this many days. | |
| min_review_count | No | ||
| min_rating_fraction | No | ||
| meals_per_person_per_day | No | Caller's assumption. BudgetAtlas does not infer how often someone eats out. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| meta | Yes | ||
| mode | Yes | ||
| cities | Yes | ||
| request | Yes | ||
| currency | Yes | ||
| suggestions | Yes | ||
| no_data_reason | Yes | ||
| unknown_cities | Yes | ||
| ranked_by_subtotal | Yes | ||
| excluded_categories | Yes |