Server definition
- Hash
- sha256:5bc2e51e893b653602a2017235e16a053ddf0370f2c152b8bab7cd44dca6501a
- What it is
- What a remote MCP server returned when asked what it offers: 24 tools
The blob, as servednamed by its sha256
{
"instructions": "Cite source, licence, date and open_in_browser. Preserve historical periods and original labels. Paused sources must not be retried. Unknown values stay null; a partial subtotal is not a complete budget. Separate observed groceries, official MOET references, community reports and estimates. Tools are read-only: no purchases, accounts, enrollment or contact. Ask for missing personal assumptions; do not put salary in URLs or logs. Request data pages only when needed for the user question; never export datasets.",
"tools": [
{
"description": "monthly/annual fuel+Salik inputs/rates or routes. Excludes parking/ownership.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"cursor": {
"maxLength": 512,
"minLength": 1,
"type": "string"
},
"days_per_week": {
"default": 5,
"maximum": 7,
"minimum": 0,
"type": "number"
},
"emirate_id": {
"enum": [
"dubai",
"abu_dhabi",
"sharjah",
"ajman",
"umm_al_quwain",
"ras_al_khaimah",
"fujairah"
],
"type": "string"
},
"from_area": {
"maxLength": 120,
"minLength": 1,
"type": "string"
},
"fuel": {
"default": "special95",
"enum": [
"super98",
"special95",
"eplus91",
"diesel"
],
"type": "string"
},
"km_per_day": {
"maximum": 1000,
"minimum": 0,
"type": "number"
},
"l_per_100km": {
"default": 8,
"maximum": 40,
"minimum": 1,
"type": "number"
},
"page_size": {
"default": 20,
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"salik_per_day": {
"maximum": 30,
"minimum": 0,
"type": "integer"
},
"sort": {
"default": "distance_km",
"enum": [
"distance_km",
"car_monthly_aed",
"from_area"
],
"type": "string"
},
"to_area": {
"maxLength": 120,
"minLength": 1,
"type": "string"
},
"to_hub_id": {
"enum": [
"downtown_difc",
"internet_city_marina",
"jafza_dubai_south",
"dxb_deira"
],
"type": "string"
}
},
"type": "object"
},
"name": "commute_cost",
"outputSchema": {
"$defs": {
"AreaCommuteRoute": {
"additionalProperties": false,
"properties": {
"car": {
"additionalProperties": false,
"properties": {
"crossings": {
"items": {
"additionalProperties": false,
"properties": {
"aed": {
"type": "number"
},
"at": {
"type": "string"
},
"gate": {
"type": "string"
},
"trip": {
"enum": [
"morning",
"evening"
],
"type": "string"
}
},
"required": [
"gate",
"trip",
"at",
"aed"
],
"type": "object"
},
"type": "array"
},
"days_per_week": {
"type": "integer"
},
"depart_times": {
"items": {
"type": "string"
},
"type": "array"
},
"fuel_aed": {
"type": "number"
},
"gates": {
"items": {
"type": "string"
},
"type": "array"
},
"km_per_day": {
"type": "number"
},
"litres_per_100km": {
"type": "number"
},
"monthly_aed": {
"type": "number"
},
"parking": {
"const": "not_included"
},
"tolls_aed": {
"type": "number"
},
"tolls_per_day": {
"type": "number"
}
},
"required": [
"monthly_aed",
"km_per_day",
"tolls_per_day",
"days_per_week",
"litres_per_100km",
"depart_times",
"fuel_aed",
"tolls_aed",
"parking",
"gates",
"crossings"
],
"type": [
"object",
"null"
]
},
"distance_km": {
"type": "number"
},
"emirate_id": {
"enum": [
"dubai",
"abu_dhabi",
"sharjah",
"ajman",
"umm_al_quwain",
"ras_al_khaimah",
"fujairah"
],
"type": "string"
},
"from_area": {
"type": "string"
},
"minutes_free_flow": {
"type": [
"integer",
"null"
]
},
"minutes_peak": {
"type": "null"
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"to_hub_id": {
"type": "string"
},
"to_hub_name": {
"type": "string"
}
},
"required": [
"emirate_id",
"from_area",
"to_hub_id",
"to_hub_name",
"distance_km",
"minutes_free_flow",
"minutes_peak",
"car",
"provenance"
],
"type": "object"
},
"AreaCommuteRouteListResponse": {
"additionalProperties": false,
"properties": {
"data": {
"items": {
"$ref": "#/$defs/AreaCommuteRoute"
},
"type": "array"
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"CommuteEstimate": {
"additionalProperties": false,
"properties": {
"annual_total_aed": {
"type": [
"number",
"null"
]
},
"calculation_basis": {
"additionalProperties": false,
"properties": {
"kilometres_per_consumption_unit": {
"type": "integer"
},
"months_per_year": {
"type": "integer"
},
"weeks_per_year": {
"type": "integer"
}
},
"required": [
"weeks_per_year",
"months_per_year",
"kilometres_per_consumption_unit"
],
"type": "object"
},
"days_per_month": {
"type": "number"
},
"fuel_month": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"inputs": {
"additionalProperties": false,
"properties": {
"days_per_week": {
"type": "number"
},
"fuel": {
"enum": [
"super98",
"special95",
"eplus91",
"diesel"
],
"type": "string"
},
"km_per_day": {
"type": "number"
},
"l_per_100km": {
"type": "number"
},
"salik_per_day": {
"type": "integer"
}
},
"required": [
"km_per_day",
"days_per_week",
"l_per_100km",
"fuel",
"salik_per_day"
],
"type": "object"
},
"litres_per_month": {
"type": "number"
},
"missing": {
"items": {
"type": "string"
},
"type": "array"
},
"monthly_aed": {
"additionalProperties": false,
"properties": {
"fuel": {
"type": [
"number",
"null"
]
},
"salik": {
"type": [
"number",
"null"
]
},
"total": {
"type": [
"number",
"null"
]
}
},
"required": [
"fuel",
"salik",
"total"
],
"type": "object"
},
"not_included": {
"items": {
"type": "string"
},
"type": "array"
},
"price_per_litre_aed": {
"type": [
"number",
"null"
]
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"salik_offpeak_rate_aed": {
"type": [
"number",
"null"
]
},
"salik_rate_aed": {
"type": [
"number",
"null"
]
}
},
"required": [
"fuel_month",
"inputs",
"price_per_litre_aed",
"salik_rate_aed",
"days_per_month",
"litres_per_month",
"monthly_aed",
"annual_total_aed",
"missing",
"not_included",
"provenance"
],
"type": "object"
},
"CommuteEstimateResponse": {
"additionalProperties": false,
"properties": {
"data": {
"anyOf": [
{
"$ref": "#/$defs/CommuteEstimate"
},
{
"type": "null"
}
]
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"Links": {
"additionalProperties": false,
"properties": {
"docs": {
"type": "string"
},
"next": {
"type": [
"string",
"null"
]
},
"open_in_browser": {
"type": [
"string",
"null"
]
},
"self": {
"type": "string"
}
},
"required": [
"self",
"next",
"open_in_browser",
"docs"
],
"type": "object"
},
"Provenance": {
"additionalProperties": true,
"required": [
"source_id",
"license_id",
"source_url",
"observed_on",
"observed_at",
"published_on",
"published_at",
"retrieved_at",
"stale",
"status",
"paused_since",
"flags"
],
"type": "object"
},
"ResponseMeta": {
"additionalProperties": true,
"required": [
"api_version",
"content_language",
"generated_at",
"currency",
"attribution",
"disclaimer",
"dataset",
"page"
],
"type": "object"
},
"ToolFailure": {
"additionalProperties": false,
"properties": {
"error": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"retry_after_s": {
"type": [
"integer",
"null"
]
},
"retryable": {
"type": "boolean"
}
},
"required": [
"code",
"message",
"retryable",
"retry_after_s"
],
"type": "object"
},
"request_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"error",
"request_id"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"$ref": "#/$defs/CommuteEstimateResponse"
},
{
"$ref": "#/$defs/AreaCommuteRouteListResponse"
},
{
"$ref": "#/$defs/ToolFailure"
}
],
"type": "object"
}
},
{
"description": "area ranks, rent/shared costs and tuition. Not full budgets.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"area": {
"maxLength": 120,
"minLength": 1,
"type": "string"
},
"bedrooms": {
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"cursor": {
"maxLength": 512,
"minLength": 1,
"type": "string"
},
"include_school": {
"type": "boolean"
},
"min_contracts": {
"maximum": 100000,
"minimum": 10,
"type": "integer"
},
"page_size": {
"default": 20,
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"property_type": {
"enum": [
"apartment",
"villa"
],
"type": "string"
},
"sort": {
"default": "total_monthly_aed",
"enum": [
"total_monthly_aed",
"-total_monthly_aed",
"rent_monthly_aed",
"total_with_school_monthly_aed",
"name"
],
"type": "string"
},
"transport": {
"enum": [
"car_commute_no_tolls",
"car_commute_with_salik",
"public_transport_one_zone",
"public_transport_two_zones"
],
"type": "string"
},
"zone_id": {
"pattern": "^[a-z0-9][a-z0-9._-]{0,119}$",
"type": "string"
}
},
"type": "object"
},
"name": "costs_by_area",
"outputSchema": {
"$defs": {
"AreaCostContext": {
"additionalProperties": true,
"required": [
"rent_period",
"profile",
"assumptions",
"shared_monthly_aed",
"not_included"
],
"type": "object"
},
"AreaLivingCost": {
"additionalProperties": false,
"properties": {
"cheapest_school_annual_aed": {
"type": [
"number",
"null"
]
},
"cheapest_school_monthly_aed": {
"type": [
"number",
"null"
]
},
"communities": {
"items": {
"type": "string"
},
"type": "array"
},
"contracts": {
"type": "integer"
},
"housing_fee_monthly_aed": {
"type": [
"number",
"null"
]
},
"name": {
"type": "string"
},
"open_in_browser": {
"type": [
"string",
"null"
]
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"rank": {
"type": "integer"
},
"rent_monthly_aed": {
"type": [
"number",
"null"
]
},
"rent_p25_monthly_aed": {
"type": [
"number",
"null"
]
},
"rent_p75_monthly_aed": {
"type": [
"number",
"null"
]
},
"schools_with_fees": {
"type": [
"integer",
"null"
]
},
"total_monthly_aed": {
"type": [
"number",
"null"
]
},
"total_with_school_monthly_aed": {
"type": [
"number",
"null"
]
},
"zone_id": {
"type": "string"
}
},
"required": [
"zone_id",
"name",
"communities",
"rent_monthly_aed",
"rent_p25_monthly_aed",
"rent_p75_monthly_aed",
"housing_fee_monthly_aed",
"total_monthly_aed",
"contracts",
"cheapest_school_monthly_aed",
"total_with_school_monthly_aed",
"open_in_browser",
"provenance"
],
"type": "object"
},
"AreaLivingCostListResponse": {
"additionalProperties": false,
"properties": {
"context": {
"anyOf": [
{
"$ref": "#/$defs/AreaCostContext"
},
{
"type": "null"
}
]
},
"data": {
"items": {
"$ref": "#/$defs/AreaLivingCost"
},
"type": "array"
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"context",
"data",
"links"
],
"type": "object"
},
"Links": {
"additionalProperties": false,
"properties": {
"docs": {
"type": "string"
},
"next": {
"type": [
"string",
"null"
]
},
"open_in_browser": {
"type": [
"string",
"null"
]
},
"self": {
"type": "string"
}
},
"required": [
"self",
"next",
"open_in_browser",
"docs"
],
"type": "object"
},
"Provenance": {
"additionalProperties": true,
"required": [
"source_id",
"license_id",
"source_url",
"observed_on",
"observed_at",
"published_on",
"published_at",
"retrieved_at",
"stale",
"status",
"paused_since",
"flags"
],
"type": "object"
},
"ResponseMeta": {
"additionalProperties": true,
"required": [
"api_version",
"content_language",
"generated_at",
"currency",
"attribution",
"disclaimer",
"dataset",
"page"
],
"type": "object"
},
"ToolFailure": {
"additionalProperties": false,
"properties": {
"error": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"retry_after_s": {
"type": [
"integer",
"null"
]
},
"retryable": {
"type": "boolean"
}
},
"required": [
"code",
"message",
"retryable",
"retry_after_s"
],
"type": "object"
},
"request_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"error",
"request_id"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"$ref": "#/$defs/AreaLivingCostListResponse"
},
{
"$ref": "#/$defs/ToolFailure"
}
],
"type": "object"
}
},
{
"description": "emirate rent/utilities/school costs. Non-Dubai rent unknown.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"cursor": {
"maxLength": 512,
"minLength": 1,
"type": "string"
},
"emirate_id": {
"enum": [
"dubai",
"abu_dhabi",
"sharjah",
"ajman",
"umm_al_quwain",
"ras_al_khaimah",
"fujairah"
],
"type": "string"
},
"page_size": {
"default": 20,
"maximum": 50,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"name": "costs_by_emirate",
"outputSchema": {
"$defs": {
"EmirateCostContext": {
"additionalProperties": true,
"required": [
"consumption",
"hubs",
"paused_tolls",
"notes"
],
"type": "object"
},
"EmirateCosts": {
"additionalProperties": false,
"properties": {
"areas": {
"items": {
"additionalProperties": false,
"properties": {
"area_id": {
"type": "string"
},
"name": {
"type": "string"
},
"nearest_airport": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"km": {
"type": "number"
},
"name": {
"type": "string"
}
},
"required": [
"code",
"name",
"km"
],
"type": [
"object",
"null"
]
},
"point": {
"$ref": "#/$defs/GeoPoint"
}
},
"required": [
"area_id",
"name",
"point",
"nearest_airport"
],
"type": "object"
},
"type": "array"
},
"emirate_id": {
"enum": [
"dubai",
"abu_dhabi",
"sharjah",
"ajman",
"umm_al_quwain",
"ras_al_khaimah",
"fujairah"
],
"type": "string"
},
"housing_fee": {
"additionalProperties": false,
"properties": {
"how": {
"type": [
"string",
"null"
]
},
"min_aed": {
"type": [
"number",
"null"
]
},
"percent_of_annual_rent": {
"type": [
"number",
"null"
]
},
"source_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"enum": [
"ok",
"partial",
"no_official_data_found"
],
"type": "string"
}
},
"required": [
"status",
"percent_of_annual_rent",
"min_aed",
"how",
"source_url"
],
"type": "object"
},
"intercity_buses": {
"items": {
"additionalProperties": false,
"properties": {
"fare_one_way_aed": {
"type": [
"number",
"null"
]
},
"frequency": {
"type": [
"string",
"null"
]
},
"from": {
"type": "string"
},
"minutes": {
"type": [
"integer",
"null"
]
},
"route": {
"type": "string"
},
"source_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"to_dubai_station": {
"type": "string"
}
},
"required": [
"route",
"from",
"to_dubai_station",
"fare_one_way_aed",
"minutes",
"frequency",
"source_url"
],
"type": "object"
},
"type": "array"
},
"name": {
"type": "string"
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"rent": {
"additionalProperties": false,
"properties": {
"attribution": {
"type": [
"string",
"null"
]
},
"medians": {
"items": {
"additionalProperties": false,
"properties": {
"area": {
"type": "string"
},
"bedrooms": {
"type": "integer"
},
"contracts": {
"type": "integer"
},
"median_annual_aed": {
"type": "number"
},
"median_monthly_aed": {
"type": "number"
},
"p25_annual_aed": {
"type": [
"number",
"null"
]
},
"p75_annual_aed": {
"type": [
"number",
"null"
]
},
"property_type": {
"enum": [
"apartment",
"villa"
],
"type": "string"
}
},
"required": [
"area",
"property_type",
"bedrooms",
"median_monthly_aed",
"median_annual_aed",
"p25_annual_aed",
"p75_annual_aed",
"contracts"
],
"type": "object"
},
"type": "array"
},
"note": {
"type": [
"string",
"null"
]
},
"period": {
"anyOf": [
{
"$ref": "#/$defs/Period"
},
{
"type": "null"
}
]
},
"source_urls": {
"items": {
"type": "string"
},
"type": "array"
},
"status": {
"enum": [
"ok",
"no_comparable_open_data",
"no_official_data_found"
],
"type": "string"
}
},
"required": [
"status",
"note",
"period",
"attribution",
"medians",
"source_urls"
],
"type": "object"
},
"schools": {
"additionalProperties": false,
"properties": {
"note": {
"type": [
"string",
"null"
]
},
"status": {
"enum": [
"ok",
"no_official_open_data_found"
],
"type": "string"
}
},
"required": [
"status",
"note"
],
"type": "object"
},
"utilities": {
"additionalProperties": false,
"properties": {
"basis": {
"type": "string"
},
"calculated": {
"type": "boolean"
},
"electricity_aed": {
"type": [
"number",
"null"
]
},
"missing": {
"items": {
"type": "string"
},
"type": "array"
},
"monthly_aed": {
"type": [
"number",
"null"
]
},
"provider": {
"type": "string"
},
"source_urls": {
"items": {
"type": "string"
},
"type": "array"
},
"vat_note": {
"type": [
"string",
"null"
]
},
"water_aed": {
"type": [
"number",
"null"
]
}
},
"required": [
"provider",
"monthly_aed",
"electricity_aed",
"water_aed",
"basis",
"vat_note",
"calculated",
"missing",
"source_urls"
],
"type": "object"
}
},
"required": [
"emirate_id",
"name",
"rent",
"utilities",
"housing_fee",
"schools",
"intercity_buses",
"areas",
"provenance"
],
"type": "object"
},
"EmirateCostsListResponse": {
"additionalProperties": false,
"properties": {
"context": {
"anyOf": [
{
"$ref": "#/$defs/EmirateCostContext"
},
{
"type": "null"
}
]
},
"data": {
"items": {
"$ref": "#/$defs/EmirateCosts"
},
"type": "array"
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"context",
"data",
"links"
],
"type": "object"
},
"EmirateCostsResponse": {
"additionalProperties": false,
"properties": {
"context": {
"anyOf": [
{
"$ref": "#/$defs/EmirateCostContext"
},
{
"type": "null"
}
]
},
"data": {
"anyOf": [
{
"$ref": "#/$defs/EmirateCosts"
},
{
"type": "null"
}
]
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"context",
"data",
"links"
],
"type": "object"
},
"GeoPoint": {
"additionalProperties": false,
"properties": {
"approximate": {
"type": "boolean"
},
"lat": {
"type": "number"
},
"lon": {
"type": "number"
}
},
"required": [
"lat",
"lon",
"approximate"
],
"type": "object"
},
"Links": {
"additionalProperties": false,
"properties": {
"docs": {
"type": "string"
},
"next": {
"type": [
"string",
"null"
]
},
"open_in_browser": {
"type": [
"string",
"null"
]
},
"self": {
"type": "string"
}
},
"required": [
"self",
"next",
"open_in_browser",
"docs"
],
"type": "object"
},
"Period": {
"additionalProperties": false,
"properties": {
"from": {
"type": "string"
},
"months": {
"type": [
"integer",
"null"
]
},
"to": {
"type": "string"
}
},
"required": [
"from",
"to",
"months"
],
"type": "object"
},
"Provenance": {
"additionalProperties": true,
"required": [
"source_id",
"license_id",
"source_url",
"observed_on",
"observed_at",
"published_on",
"published_at",
"retrieved_at",
"stale",
"status",
"paused_since",
"flags"
],
"type": "object"
},
"ResponseMeta": {
"additionalProperties": true,
"required": [
"api_version",
"content_language",
"generated_at",
"currency",
"attribution",
"disclaimer",
"dataset",
"page"
],
"type": "object"
},
"ToolFailure": {
"additionalProperties": false,
"properties": {
"error": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"retry_after_s": {
"type": [
"integer",
"null"
]
},
"retryable": {
"type": "boolean"
}
},
"required": [
"code",
"message",
"retryable",
"retry_after_s"
],
"type": "object"
},
"request_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"error",
"request_id"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"$ref": "#/$defs/EmirateCostsListResponse"
},
{
"$ref": "#/$defs/EmirateCostsResponse"
},
{
"$ref": "#/$defs/ToolFailure"
}
],
"type": "object"
}
},
{
"description": "publishers/links, licence conditions/dates and pause reasons. Not dataset rows.",
"inputSchema": {
"$defs": {
"Code": {
"maxLength": 80,
"pattern": "^[a-z0-9]+(_[a-z0-9]+)*$",
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"cursor": {
"maxLength": 512,
"minLength": 1,
"type": "string"
},
"dataset_id": {
"$ref": "#/$defs/Code"
},
"license_status": {
"enum": [
"confirmed",
"restricted",
"unconfirmed",
"paused"
],
"type": "string"
},
"page_size": {
"default": 20,
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"source_id": {
"$ref": "#/$defs/Code"
},
"status": {
"enum": [
"ok",
"paused",
"unreadable",
"not_published"
],
"type": "string"
}
},
"type": "object"
},
"name": "data_sources",
"outputSchema": {
"$defs": {
"Links": {
"additionalProperties": false,
"properties": {
"docs": {
"type": "string"
},
"next": {
"type": [
"string",
"null"
]
},
"open_in_browser": {
"type": [
"string",
"null"
]
},
"self": {
"type": "string"
}
},
"required": [
"self",
"next",
"open_in_browser",
"docs"
],
"type": "object"
},
"ResponseMeta": {
"additionalProperties": true,
"required": [
"api_version",
"content_language",
"generated_at",
"currency",
"attribution",
"disclaimer",
"dataset",
"page"
],
"type": "object"
},
"Source": {
"additionalProperties": true,
"required": [
"source_id",
"name",
"publisher",
"url",
"terms_url",
"license",
"attribution",
"status",
"paused_since",
"notice",
"dataset_ids"
],
"type": "object"
},
"SourceListResponse": {
"additionalProperties": false,
"properties": {
"data": {
"items": {
"$ref": "#/$defs/Source"
},
"type": "array"
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"SourceResponse": {
"additionalProperties": false,
"properties": {
"data": {
"$ref": "#/$defs/Source"
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"ToolFailure": {
"additionalProperties": false,
"properties": {
"error": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"retry_after_s": {
"type": [
"integer",
"null"
]
},
"retryable": {
"type": "boolean"
}
},
"required": [
"code",
"message",
"retryable",
"retry_after_s"
],
"type": "object"
},
"request_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"error",
"request_id"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"$ref": "#/$defs/SourceListResponse"
},
{
"$ref": "#/$defs/SourceResponse"
},
{
"$ref": "#/$defs/ToolFailure"
}
],
"type": "object"
}
},
{
"description": "slabs/surcharges/examples; kwh: water/VAT/housing-fee estimate. Not full bill.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"annual_rent_aed": {
"maximum": 100000000,
"minimum": 0,
"type": [
"number",
"null"
]
},
"kwh": {
"maximum": 1000000,
"minimum": 0,
"type": "number"
},
"water_gallons": {
"description": "Imperial gallons.",
"maximum": 100000000,
"minimum": 0,
"type": [
"number",
"null"
]
},
"water_m3": {
"maximum": 1000000,
"minimum": 0,
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"name": "dewa",
"outputSchema": {
"$defs": {
"DewaBillEstimate": {
"additionalProperties": false,
"properties": {
"annual_rent_aed": {
"type": [
"number",
"null"
]
},
"electricity_aed": {
"type": [
"number",
"null"
]
},
"electricity_fuel_surcharge_aed_per_kwh": {
"type": [
"number",
"null"
]
},
"housing_fee_aed": {
"type": [
"number",
"null"
]
},
"housing_fee_percent": {
"type": [
"number",
"null"
]
},
"kwh": {
"type": [
"number",
"null"
]
},
"meter_service_aed": {
"type": [
"number",
"null"
]
},
"months_per_year": {
"type": "integer"
},
"not_included": {
"type": [
"string",
"null"
]
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"subtotal_aed": {
"type": [
"number",
"null"
]
},
"surcharge_month": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tariff": {
"$ref": "#/$defs/DewaTariff"
},
"total_aed": {
"type": [
"number",
"null"
]
},
"vat_aed": {
"type": [
"number",
"null"
]
},
"water_aed": {
"type": [
"number",
"null"
]
},
"water_fuel_surcharge_aed_per_m3": {
"type": [
"number",
"null"
]
},
"water_gallons": {
"type": [
"number",
"null"
]
},
"water_m3": {
"type": [
"number",
"null"
]
}
},
"required": [
"surcharge_month",
"electricity_fuel_surcharge_aed_per_kwh",
"water_fuel_surcharge_aed_per_m3",
"kwh",
"water_m3",
"electricity_aed",
"water_aed",
"meter_service_aed",
"subtotal_aed",
"vat_aed",
"housing_fee_aed",
"total_aed",
"not_included",
"provenance"
],
"type": "object"
},
"DewaBillEstimateResponse": {
"additionalProperties": false,
"properties": {
"data": {
"anyOf": [
{
"$ref": "#/$defs/DewaBillEstimate"
},
{
"type": "null"
}
]
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"DewaTariff": {
"additionalProperties": false,
"properties": {
"electricity": {
"additionalProperties": false,
"properties": {
"fuel_surcharge_aed_per_kwh": {
"type": [
"number",
"null"
]
},
"meter_service_charges": {
"items": {
"additionalProperties": false,
"properties": {
"amount_aed": {
"type": "number"
},
"meter_type": {
"type": "integer"
}
},
"required": [
"meter_type",
"amount_aed"
],
"type": "object"
},
"type": "array"
},
"slabs": {
"items": {
"additionalProperties": false,
"properties": {
"aed_per_unit": {
"type": "number"
},
"from": {
"type": "number"
},
"to": {
"type": [
"number",
"null"
]
}
},
"required": [
"from",
"to",
"aed_per_unit"
],
"type": "object"
},
"type": "array"
},
"unit": {
"const": "kWh per month"
}
},
"required": [
"unit",
"slabs",
"fuel_surcharge_aed_per_kwh",
"meter_service_charges"
],
"type": "object"
},
"housing_fee_rate_of_annual_rent": {
"type": [
"number",
"null"
]
},
"imperial_gallons_per_m3": {
"type": "number"
},
"not_included": {
"type": [
"string",
"null"
]
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"surcharge_month": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"typical": {
"items": {
"additionalProperties": false,
"properties": {
"kwh": {
"type": "number"
},
"m3": {
"type": "number"
},
"monthly_aed": {
"type": [
"number",
"null"
]
},
"profile_id": {
"enum": [
"light",
"medium",
"heavy"
],
"type": "string"
}
},
"required": [
"profile_id",
"kwh",
"m3",
"monthly_aed"
],
"type": "object"
},
"type": "array"
},
"vat_percent": {
"type": [
"number",
"null"
]
},
"water": {
"additionalProperties": false,
"properties": {
"fuel_surcharge_aed_per_m3": {
"type": [
"number",
"null"
]
},
"meter_service_charges": {
"items": {
"additionalProperties": false,
"properties": {
"amount_aed": {
"type": "number"
},
"meter_type": {
"type": "integer"
}
},
"required": [
"meter_type",
"amount_aed"
],
"type": "object"
},
"type": "array"
},
"slabs": {
"items": {
"additionalProperties": false,
"properties": {
"aed_per_unit": {
"type": "number"
},
"from": {
"type": "number"
},
"to": {
"type": [
"number",
"null"
]
}
},
"required": [
"from",
"to",
"aed_per_unit"
],
"type": "object"
},
"type": "array"
},
"unit": {
"const": "m³ per month"
}
},
"required": [
"unit",
"slabs",
"fuel_surcharge_aed_per_m3",
"meter_service_charges"
],
"type": "object"
}
},
"required": [
"surcharge_month",
"vat_percent",
"electricity",
"water",
"housing_fee_rate_of_annual_rent",
"typical",
"not_included",
"provenance"
],
"type": "object"
},
"DewaTariffResponse": {
"additionalProperties": false,
"properties": {
"data": {
"anyOf": [
{
"$ref": "#/$defs/DewaTariff"
},
{
"type": "null"
}
]
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"Links": {
"additionalProperties": false,
"properties": {
"docs": {
"type": "string"
},
"next": {
"type": [
"string",
"null"
]
},
"open_in_browser": {
"type": [
"string",
"null"
]
},
"self": {
"type": "string"
}
},
"required": [
"self",
"next",
"open_in_browser",
"docs"
],
"type": "object"
},
"Provenance": {
"additionalProperties": true,
"required": [
"source_id",
"license_id",
"source_url",
"observed_on",
"observed_at",
"published_on",
"published_at",
"retrieved_at",
"stale",
"status",
"paused_since",
"flags"
],
"type": "object"
},
"ResponseMeta": {
"additionalProperties": true,
"required": [
"api_version",
"content_language",
"generated_at",
"currency",
"attribution",
"disclaimer",
"dataset",
"page"
],
"type": "object"
},
"ToolFailure": {
"additionalProperties": false,
"properties": {
"error": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"retry_after_s": {
"type": [
"integer",
"null"
]
},
"retryable": {
"type": "boolean"
}
},
"required": [
"code",
"message",
"retryable",
"retry_after_s"
],
"type": "object"
},
"request_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"error",
"request_id"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"$ref": "#/$defs/DewaTariffResponse"
},
{
"$ref": "#/$defs/DewaBillEstimateResponse"
},
{
"$ref": "#/$defs/ToolFailure"
}
],
"type": "object"
}
},
{
"description": "profile monthly costs/assumptions; separate basket. Not full budgets.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"page_size": {
"default": 20,
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"profile": {
"enum": [
"single",
"couple",
"family4"
],
"type": "string"
}
},
"type": "object"
},
"name": "fixed_monthly_costs",
"outputSchema": {
"$defs": {
"CostLine": {
"additionalProperties": false,
"properties": {
"assumption": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"line_id": {
"enum": [
"rent",
"housing_fee",
"dewa",
"transport",
"mobile",
"internet",
"school"
],
"type": "string"
},
"monthly_aed": {
"type": [
"number",
"null"
]
},
"range_aed": {
"additionalProperties": false,
"properties": {
"high_aed": {
"type": "number"
},
"low_aed": {
"type": "number"
}
},
"required": [
"low_aed",
"high_aed"
],
"type": [
"object",
"null"
]
},
"source": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"period_label": {
"type": [
"string",
"null"
]
},
"url": {
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"url",
"period_label"
],
"type": [
"object",
"null"
]
}
},
"required": [
"line_id",
"label",
"monthly_aed",
"range_aed",
"assumption",
"source"
],
"type": "object"
},
"HouseholdCostContext": {
"additionalProperties": true,
"required": [
"month",
"groceries_reference",
"not_included"
],
"type": "object"
},
"HouseholdCostProfile": {
"additionalProperties": false,
"properties": {
"covers": {
"type": "string"
},
"fixed_monthly_costs_aed": {
"type": [
"number",
"null"
]
},
"label": {
"type": "string"
},
"lines": {
"items": {
"$ref": "#/$defs/CostLine"
},
"type": "array"
},
"profile_id": {
"enum": [
"single",
"couple",
"family4"
],
"type": "string"
},
"provenance": {
"$ref": "#/$defs/Provenance"
}
},
"required": [
"profile_id",
"label",
"covers",
"fixed_monthly_costs_aed",
"lines",
"provenance"
],
"type": "object"
},
"HouseholdCostProfileListResponse": {
"additionalProperties": false,
"properties": {
"context": {
"$ref": "#/$defs/HouseholdCostContext"
},
"data": {
"items": {
"$ref": "#/$defs/HouseholdCostProfile"
},
"type": "array"
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"context",
"data",
"links"
],
"type": "object"
},
"Links": {
"additionalProperties": false,
"properties": {
"docs": {
"type": "string"
},
"next": {
"type": [
"string",
"null"
]
},
"open_in_browser": {
"type": [
"string",
"null"
]
},
"self": {
"type": "string"
}
},
"required": [
"self",
"next",
"open_in_browser",
"docs"
],
"type": "object"
},
"Provenance": {
"additionalProperties": true,
"required": [
"source_id",
"license_id",
"source_url",
"observed_on",
"observed_at",
"published_on",
"published_at",
"retrieved_at",
"stale",
"status",
"paused_since",
"flags"
],
"type": "object"
},
"ResponseMeta": {
"additionalProperties": true,
"required": [
"api_version",
"content_language",
"generated_at",
"currency",
"attribution",
"disclaimer",
"dataset",
"page"
],
"type": "object"
},
"ToolFailure": {
"additionalProperties": false,
"properties": {
"error": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"retry_after_s": {
"type": [
"integer",
"null"
]
},
"retryable": {
"type": "boolean"
}
},
"required": [
"code",
"message",
"retryable",
"retry_after_s"
],
"type": "object"
},
"request_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"error",
"request_id"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"$ref": "#/$defs/HouseholdCostProfileListResponse"
},
{
"$ref": "#/$defs/ToolFailure"
}
],
"type": "object"
}
},
{
"description": "setup packages, annual/monthly prices/visas and paused zones. Not visa routes.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"cursor": {
"maxLength": 512,
"minLength": 1,
"type": "string"
},
"emirate": {
"enum": [
"dubai",
"abu_dhabi",
"sharjah",
"ajman",
"umm_al_quwain",
"ras_al_khaimah",
"fujairah"
],
"type": "string"
},
"page_size": {
"default": 20,
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"published": {
"enum": [
"one_visa",
"partial",
"none",
"paused"
],
"type": "string"
},
"zone": {
"maxLength": 120,
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"name": "free_zone_companies",
"outputSchema": {
"$defs": {
"CompanyContext": {
"additionalProperties": true,
"required": [
"mainland"
],
"type": "object"
},
"FreeZoneSetup": {
"additionalProperties": false,
"properties": {
"emirate_id": {
"enum": [
"dubai",
"abu_dhabi",
"sharjah",
"ajman",
"umm_al_quwain",
"ras_al_khaimah",
"fujairah",
null
],
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"official_site": {
"type": [
"string",
"null"
]
},
"packages": {
"items": {
"additionalProperties": false,
"properties": {
"first_year_aed": {
"type": [
"number",
"null"
]
},
"monthly_aed": {
"type": [
"number",
"null"
]
},
"name": {
"type": "string"
},
"qualifier": {
"enum": [
"exact",
"from"
],
"type": "string"
},
"quote": {
"type": "string"
},
"renewal_aed": {
"type": [
"number",
"null"
]
},
"retrieved_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source_url": {
"type": "string"
},
"visas_included": {
"type": [
"integer",
"null"
]
}
},
"required": [
"name",
"visas_included",
"first_year_aed",
"monthly_aed",
"renewal_aed",
"qualifier",
"quote",
"source_url",
"retrieved_at"
],
"type": "object"
},
"type": "array"
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"published": {
"enum": [
"one_visa",
"partial",
"none",
"paused"
],
"type": "string"
},
"zone_id": {
"type": "string"
}
},
"required": [
"zone_id",
"name",
"emirate_id",
"official_site",
"published",
"packages",
"provenance"
],
"type": "object"
},
"FreeZoneSetupListResponse": {
"additionalProperties": false,
"properties": {
"context": {
"anyOf": [
{
"$ref": "#/$defs/CompanyContext"
},
{
"type": "null"
}
]
},
"data": {
"items": {
"$ref": "#/$defs/FreeZoneSetup"
},
"type": "array"
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"context",
"data",
"links"
],
"type": "object"
},
"Links": {
"additionalProperties": false,
"properties": {
"docs": {
"type": "string"
},
"next": {
"type": [
"string",
"null"
]
},
"open_in_browser": {
"type": [
"string",
"null"
]
},
"self": {
"type": "string"
}
},
"required": [
"self",
"next",
"open_in_browser",
"docs"
],
"type": "object"
},
"Provenance": {
"additionalProperties": true,
"required": [
"source_id",
"license_id",
"source_url",
"observed_on",
"observed_at",
"published_on",
"published_at",
"retrieved_at",
"stale",
"status",
"paused_since",
"flags"
],
"type": "object"
},
"ResponseMeta": {
"additionalProperties": true,
"required": [
"api_version",
"content_language",
"generated_at",
"currency",
"attribution",
"disclaimer",
"dataset",
"page"
],
"type": "object"
},
"ToolFailure": {
"additionalProperties": false,
"properties": {
"error": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"retry_after_s": {
"type": [
"integer",
"null"
]
},
"retryable": {
"type": "boolean"
}
},
"required": [
"code",
"message",
"retryable",
"retry_after_s"
],
"type": "object"
},
"request_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"error",
"request_id"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"$ref": "#/$defs/FreeZoneSetupListResponse"
},
{
"$ref": "#/$defs/ToolFailure"
}
],
"type": "object"
}
},
{
"description": "current/previous grades, changes, 50/70 L tank costs, transport context/history.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"cursor": {
"maxLength": 512,
"minLength": 1,
"type": "string"
},
"from": {
"pattern": "^[0-9]{4}-(0[1-9]|1[0-2])$",
"type": "string"
},
"include_history": {
"type": "boolean"
},
"page_size": {
"default": 20,
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"sort": {
"default": "-month",
"enum": [
"month",
"-month"
],
"type": "string"
},
"to": {
"pattern": "^[0-9]{4}-(0[1-9]|1[0-2])$",
"type": "string"
}
},
"type": "object"
},
"name": "fuel_prices",
"outputSchema": {
"$defs": {
"FuelContext": {
"additionalProperties": true,
"required": [
"tolls",
"parking",
"public_transport"
],
"type": "object"
},
"FuelGradePrices": {
"additionalProperties": false,
"properties": {
"diesel": {
"type": [
"number",
"null"
]
},
"eplus91": {
"type": [
"number",
"null"
]
},
"special95": {
"type": [
"number",
"null"
]
},
"super98": {
"type": [
"number",
"null"
]
}
},
"required": [
"super98",
"special95",
"eplus91",
"diesel"
],
"type": "object"
},
"FuelPriceHistoryResponse": {
"additionalProperties": false,
"properties": {
"data": {
"items": {
"$ref": "#/$defs/FuelPriceMonth"
},
"type": "array"
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"FuelPriceMonth": {
"additionalProperties": false,
"properties": {
"month": {
"type": "string"
},
"prices": {
"$ref": "#/$defs/FuelGradePrices"
},
"provenance": {
"$ref": "#/$defs/Provenance"
}
},
"required": [
"month",
"prices",
"provenance"
],
"type": "object"
},
"FuelPrices": {
"additionalProperties": false,
"properties": {
"announcement": {
"additionalProperties": false,
"properties": {
"published_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"publisher": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"publisher",
"url",
"published_at"
],
"type": [
"object",
"null"
]
},
"change": {
"anyOf": [
{
"$ref": "#/$defs/FuelGradePrices"
},
{
"type": "null"
}
]
},
"history_summary": {
"additionalProperties": false,
"properties": {
"from": {
"type": [
"string",
"null"
]
},
"missing_months": {
"type": "integer"
},
"to": {
"type": [
"string",
"null"
]
},
"tracked_months": {
"type": "integer"
}
},
"required": [
"tracked_months",
"from",
"to",
"missing_months"
],
"type": "object"
},
"missing_months": {
"items": {
"type": "string"
},
"type": "array"
},
"month": {
"type": "string"
},
"previous": {
"additionalProperties": false,
"properties": {
"month": {
"type": "string"
},
"prices": {
"$ref": "#/$defs/FuelGradePrices"
}
},
"required": [
"month",
"prices"
],
"type": [
"object",
"null"
]
},
"prices": {
"$ref": "#/$defs/FuelGradePrices"
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"tank_costs": {
"items": {
"additionalProperties": false,
"properties": {
"diesel_aed": {
"type": [
"number",
"null"
]
},
"eplus91_aed": {
"type": [
"number",
"null"
]
},
"special95_aed": {
"type": [
"number",
"null"
]
},
"super98_aed": {
"type": [
"number",
"null"
]
},
"tank_litres": {
"type": "integer"
}
},
"required": [
"tank_litres",
"super98_aed",
"special95_aed",
"eplus91_aed",
"diesel_aed"
],
"type": "object"
},
"type": "array"
},
"transport_context": {
"$ref": "#/$defs/FuelContext"
},
"unit": {
"const": "AED per litre"
}
},
"required": [
"month",
"unit",
"prices",
"previous",
"change",
"tank_costs",
"announcement",
"missing_months",
"provenance"
],
"type": "object"
},
"FuelPricesResponse": {
"additionalProperties": false,
"properties": {
"data": {
"anyOf": [
{
"$ref": "#/$defs/FuelPrices"
},
{
"type": "null"
}
]
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"Links": {
"additionalProperties": false,
"properties": {
"docs": {
"type": "string"
},
"next": {
"type": [
"string",
"null"
]
},
"open_in_browser": {
"type": [
"string",
"null"
]
},
"self": {
"type": "string"
}
},
"required": [
"self",
"next",
"open_in_browser",
"docs"
],
"type": "object"
},
"Provenance": {
"additionalProperties": true,
"required": [
"source_id",
"license_id",
"source_url",
"observed_on",
"observed_at",
"published_on",
"published_at",
"retrieved_at",
"stale",
"status",
"paused_since",
"flags"
],
"type": "object"
},
"ResponseMeta": {
"additionalProperties": true,
"required": [
"api_version",
"content_language",
"generated_at",
"currency",
"attribution",
"disclaimer",
"dataset",
"page"
],
"type": "object"
},
"ToolFailure": {
"additionalProperties": false,
"properties": {
"error": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"retry_after_s": {
"type": [
"integer",
"null"
]
},
"retryable": {
"type": "boolean"
}
},
"required": [
"code",
"message",
"retryable",
"retry_after_s"
],
"type": "object"
},
"request_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"error",
"request_id"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"$ref": "#/$defs/FuelPricesResponse"
},
{
"$ref": "#/$defs/FuelPriceHistoryResponse"
},
{
"$ref": "#/$defs/ToolFailure"
}
],
"type": "object"
}
},
{
"description": "dated CBUAE AED rates. Not bank quotes.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"currency": {
"pattern": "^[A-Z]{3}$",
"type": "string"
}
},
"type": "object"
},
"name": "fx_rates",
"outputSchema": {
"$defs": {
"FxRates": {
"additionalProperties": false,
"properties": {
"base": {
"const": "AED"
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"published_label": {
"type": [
"string",
"null"
]
},
"rates": {
"items": {
"additionalProperties": false,
"properties": {
"aed_per_unit": {
"type": "number"
},
"currency": {
"type": "string"
}
},
"required": [
"currency",
"aed_per_unit"
],
"type": "object"
},
"type": "array"
},
"rates_on": {
"type": "string"
},
"unit": {
"const": "AED per 1 unit of currency"
}
},
"required": [
"base",
"unit",
"rates_on",
"published_label",
"rates",
"provenance"
],
"type": "object"
},
"FxRatesResponse": {
"additionalProperties": false,
"properties": {
"data": {
"anyOf": [
{
"$ref": "#/$defs/FxRates"
},
{
"type": "null"
}
]
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"Links": {
"additionalProperties": false,
"properties": {
"docs": {
"type": "string"
},
"next": {
"type": [
"string",
"null"
]
},
"open_in_browser": {
"type": [
"string",
"null"
]
},
"self": {
"type": "string"
}
},
"required": [
"self",
"next",
"open_in_browser",
"docs"
],
"type": "object"
},
"Provenance": {
"additionalProperties": true,
"required": [
"source_id",
"license_id",
"source_url",
"observed_on",
"observed_at",
"published_on",
"published_at",
"retrieved_at",
"stale",
"status",
"paused_since",
"flags"
],
"type": "object"
},
"ResponseMeta": {
"additionalProperties": true,
"required": [
"api_version",
"content_language",
"generated_at",
"currency",
"attribution",
"disclaimer",
"dataset",
"page"
],
"type": "object"
},
"ToolFailure": {
"additionalProperties": false,
"properties": {
"error": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"retry_after_s": {
"type": [
"integer",
"null"
]
},
"retryable": {
"type": "boolean"
}
},
"required": [
"code",
"message",
"retryable",
"retry_after_s"
],
"type": "object"
},
"request_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"error",
"request_id"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"$ref": "#/$defs/FxRatesResponse"
},
{
"$ref": "#/$defs/ToolFailure"
}
],
"type": "object"
}
},
{
"description": "proposed items, subtotals, delivery/minimums. Not MOET/reports.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"area": {
"maxLength": 80,
"type": [
"string",
"null"
]
},
"items": {
"items": {
"maxLength": 120,
"minLength": 1,
"type": "string"
},
"maxItems": 40,
"minItems": 1,
"type": "array"
}
},
"required": [
"items"
],
"type": "object"
},
"name": "grocery_compare_list",
"outputSchema": {
"$defs": {
"ComparisonLine": {
"additionalProperties": false,
"properties": {
"at_recommended_store": {
"anyOf": [
{
"$ref": "#/$defs/OfferAt"
},
{
"type": "null"
}
]
},
"candidates": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"product_id": {
"type": "string"
}
},
"required": [
"product_id",
"name"
],
"type": "object"
},
"type": "array"
},
"cheapest_seen": {
"additionalProperties": false,
"properties": {
"cost_aed": {
"type": "number"
},
"store_id": {
"type": "string"
},
"store_name": {
"type": "string"
}
},
"required": [
"store_id",
"store_name",
"cost_aed"
],
"type": [
"object",
"null"
]
},
"match": {
"type": [
"string",
"null"
]
},
"next_step": {
"type": [
"string",
"null"
]
},
"product": {
"additionalProperties": false,
"properties": {
"comparison": {
"enum": [
"exact",
"equivalent"
],
"type": "string"
},
"name": {
"type": "string"
},
"product_id": {
"type": "string"
},
"unit": {
"enum": [
"each",
"kg",
"l"
],
"type": "string"
}
},
"required": [
"product_id",
"name",
"comparison",
"unit"
],
"type": [
"object",
"null"
]
},
"quantity": {
"additionalProperties": false,
"properties": {
"assumed": {
"type": "boolean"
},
"source": {
"type": "string"
},
"unit": {
"enum": [
"each",
"kg",
"l"
],
"type": "string"
},
"value": {
"type": "number"
}
},
"required": [
"value",
"unit",
"source",
"assumed"
],
"type": [
"object",
"null"
]
},
"status": {
"enum": [
"compared",
"not_compared",
"unresolved"
],
"type": "string"
},
"text": {
"type": "string"
},
"unresolved_reason": {
"type": [
"string",
"null"
]
}
},
"required": [
"text",
"status",
"match",
"product",
"quantity",
"at_recommended_store",
"cheapest_seen",
"unresolved_reason",
"candidates",
"next_step"
],
"type": "object"
},
"GroceryComparison": {
"additionalProperties": false,
"properties": {
"area": {
"additionalProperties": false,
"properties": {
"ok": {
"type": "boolean"
},
"reason": {
"type": [
"string",
"null"
]
},
"value": {
"type": "string"
}
},
"required": [
"ok",
"reason",
"value"
],
"type": "object"
},
"below_minimum_stores": {
"items": {
"additionalProperties": false,
"properties": {
"minimum_order_aed": {
"type": "number"
},
"shortfall_aed": {
"type": "number"
},
"store_id": {
"type": "string"
},
"store_name": {
"type": "string"
},
"subtotal_aed": {
"type": "number"
}
},
"required": [
"store_id",
"store_name",
"minimum_order_aed",
"subtotal_aed",
"shortfall_aed"
],
"type": "object"
},
"type": "array"
},
"browser_handoff_truncated": {
"type": "boolean"
},
"catalog_compiled_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"confidence": {
"enum": [
"high",
"medium",
"low",
"none"
],
"type": "string"
},
"items": {
"items": {
"$ref": "#/$defs/ComparisonLine"
},
"type": "array"
},
"outcome": {
"enum": [
"estimated",
"provisional",
"insufficient",
"single_store",
"empty",
"blocked"
],
"type": "string"
},
"ranking": {
"items": {
"$ref": "#/$defs/StoreTotal"
},
"type": "array"
},
"recommended_store": {
"anyOf": [
{
"$ref": "#/$defs/StoreTotal"
},
{
"type": "null"
}
]
},
"single_product_mode": {
"type": "boolean"
}
},
"required": [
"outcome",
"confidence",
"single_product_mode",
"catalog_compiled_at",
"area",
"recommended_store",
"ranking",
"items",
"below_minimum_stores",
"browser_handoff_truncated"
],
"type": "object"
},
"GroceryComparisonResponse": {
"additionalProperties": false,
"properties": {
"data": {
"anyOf": [
{
"$ref": "#/$defs/GroceryComparison"
},
{
"type": "null"
}
]
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"Links": {
"additionalProperties": false,
"properties": {
"docs": {
"type": "string"
},
"next": {
"type": [
"string",
"null"
]
},
"open_in_browser": {
"type": [
"string",
"null"
]
},
"self": {
"type": "string"
}
},
"required": [
"self",
"next",
"open_in_browser",
"docs"
],
"type": "object"
},
"OfferAt": {
"additionalProperties": false,
"properties": {
"cost_aed": {
"type": "number"
},
"estimated": {
"type": "boolean"
},
"observed_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"observed_on": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"pack_quantity": {
"type": "number"
},
"packs": {
"type": [
"integer",
"null"
]
},
"price_aed": {
"type": "number"
},
"purchased_quantity": {
"type": "number"
},
"sale_mode": {
"enum": [
"pack",
"weight"
],
"type": "string"
},
"store_id": {
"type": "string"
},
"store_name": {
"type": "string"
},
"title": {
"type": "string"
},
"unit": {
"enum": [
"each",
"kg",
"l"
],
"type": "string"
},
"unit_price_aed": {
"type": [
"number",
"null"
]
},
"url": {
"type": [
"string",
"null"
]
}
},
"required": [
"store_id",
"store_name",
"title",
"pack_quantity",
"unit",
"packs",
"sale_mode",
"price_aed",
"cost_aed",
"purchased_quantity",
"unit_price_aed",
"estimated",
"observed_on",
"observed_at",
"url"
],
"type": "object"
},
"ResponseMeta": {
"additionalProperties": true,
"required": [
"api_version",
"content_language",
"generated_at",
"currency",
"attribution",
"disclaimer",
"dataset",
"page"
],
"type": "object"
},
"StoreTotal": {
"additionalProperties": false,
"properties": {
"below_minimum": {
"type": "boolean"
},
"covered": {
"type": "integer"
},
"fee_known": {
"type": "boolean"
},
"fee_max_aed": {
"type": [
"number",
"null"
]
},
"fee_min_aed": {
"type": [
"number",
"null"
]
},
"fee_partial": {
"type": "boolean"
},
"free": {
"type": "boolean"
},
"free_from_aed": {
"type": [
"number",
"null"
]
},
"free_from_inclusive": {
"type": "boolean"
},
"minimum_order_aed": {
"type": [
"number",
"null"
]
},
"of": {
"type": "integer"
},
"offer": {
"anyOf": [
{
"$ref": "#/$defs/OfferAt"
},
{
"type": "null"
}
]
},
"order_charge_aed": {
"type": [
"number",
"null"
]
},
"ship_reason": {
"enum": [
"no_zone",
"outside_dubai",
"no_policy",
"policy_stale",
"policy_invalid",
"fee_below_threshold_unknown",
"checkout_unconfirmed",
null
],
"type": [
"string",
"null"
]
},
"shortfall_aed": {
"type": [
"number",
"null"
]
},
"store_id": {
"type": "string"
},
"store_name": {
"type": "string"
},
"subtotal_aed": {
"type": "number"
},
"total_max_aed": {
"type": [
"number",
"null"
]
},
"total_min_aed": {
"type": [
"number",
"null"
]
},
"unit": {
"enum": [
"each",
"kg",
"l",
null
],
"type": [
"string",
"null"
]
},
"unit_price_aed": {
"type": [
"number",
"null"
]
},
"url": {
"type": [
"string",
"null"
]
}
},
"required": [
"store_id",
"store_name",
"url",
"covered",
"of",
"subtotal_aed",
"fee_known",
"fee_min_aed",
"fee_max_aed",
"fee_partial",
"total_min_aed",
"total_max_aed",
"free",
"free_from_aed",
"free_from_inclusive",
"order_charge_aed",
"minimum_order_aed",
"below_minimum",
"shortfall_aed",
"ship_reason",
"unit",
"unit_price_aed",
"offer"
],
"type": "object"
},
"ToolFailure": {
"additionalProperties": false,
"properties": {
"error": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"retry_after_s": {
"type": [
"integer",
"null"
]
},
"retryable": {
"type": "boolean"
}
},
"required": [
"code",
"message",
"retryable",
"retry_after_s"
],
"type": "object"
},
"request_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"error",
"request_id"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"$ref": "#/$defs/GroceryComparisonResponse"
},
{
"$ref": "#/$defs/ToolFailure"
}
],
"type": "object"
}
},
{
"description": "products, pack/unit offers/dates; product_id: history. Not MOET/reports.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"availability": {
"enum": [
"available",
"unavailable",
"unknown"
],
"type": "string"
},
"available_only": {
"type": "boolean"
},
"comparison": {
"enum": [
"exact",
"equivalent"
],
"type": "string"
},
"cursor": {
"maxLength": 512,
"minLength": 1,
"type": "string"
},
"include_offers": {
"type": "boolean"
},
"page_size": {
"default": 20,
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"product_id": {
"pattern": "^[a-z0-9][a-z0-9._-]{0,119}$",
"type": "string"
},
"query": {
"maxLength": 120,
"minLength": 1,
"type": "string"
},
"sort": {
"default": "relevance",
"enum": [
"relevance",
"name",
"-name",
"lowest_price_aed",
"-lowest_price_aed"
],
"type": "string"
},
"store_id": {
"pattern": "^[a-z0-9][a-z0-9._-]{0,119}$",
"type": "string"
}
},
"type": "object"
},
"name": "grocery_products",
"outputSchema": {
"$defs": {
"GroceryOffer": {
"additionalProperties": false,
"properties": {
"availability": {
"enum": [
"available",
"unavailable",
"unknown"
],
"type": "string"
},
"comparison": {
"enum": [
"exact",
"equivalent"
],
"type": "string"
},
"freshness": {
"enum": [
"fresh",
"stale",
"future",
"invalid"
],
"type": "string"
},
"pack_quantity": {
"type": "number"
},
"price_aed": {
"type": "number"
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"sale_mode": {
"enum": [
"pack",
"weight"
],
"type": "string"
},
"store_id": {
"type": "string"
},
"store_name": {
"type": "string"
},
"title": {
"type": "string"
},
"unit": {
"enum": [
"each",
"kg",
"l"
],
"type": "string"
},
"unit_price_aed": {
"type": [
"number",
"null"
]
},
"url": {
"type": [
"string",
"null"
]
}
},
"required": [
"store_id",
"store_name",
"title",
"price_aed",
"unit_price_aed",
"unit",
"pack_quantity",
"sale_mode",
"comparison",
"availability",
"freshness",
"url",
"provenance"
],
"type": "object"
},
"GroceryOfferListResponse": {
"additionalProperties": false,
"properties": {
"data": {
"items": {
"$ref": "#/$defs/GroceryOffer"
},
"type": "array"
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"GroceryProduct": {
"additionalProperties": false,
"properties": {
"comparison": {
"enum": [
"exact",
"equivalent"
],
"type": "string"
},
"default_quantity": {
"type": [
"number",
"null"
]
},
"lowest_price_aed": {
"type": [
"number",
"null"
]
},
"name": {
"type": "string"
},
"offers": {
"items": {
"$ref": "#/$defs/GroceryOffer"
},
"type": "array"
},
"offers_count": {
"type": "integer"
},
"open_in_browser": {
"type": "string"
},
"page_url": {
"type": [
"string",
"null"
]
},
"product_id": {
"type": "string"
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"unit": {
"enum": [
"each",
"kg",
"l"
],
"type": "string"
}
},
"required": [
"product_id",
"name",
"comparison",
"unit",
"default_quantity",
"offers_count",
"lowest_price_aed",
"page_url",
"open_in_browser",
"provenance"
],
"type": "object"
},
"GroceryProductDetail": {
"additionalProperties": false,
"properties": {
"comparison": {
"enum": [
"exact",
"equivalent"
],
"type": "string"
},
"default_quantity": {
"type": [
"number",
"null"
]
},
"name": {
"type": "string"
},
"offers": {
"items": {
"$ref": "#/$defs/GroceryOffer"
},
"type": "array"
},
"open_in_browser": {
"type": "string"
},
"page_url": {
"type": [
"string",
"null"
]
},
"price_history": {
"additionalProperties": false,
"properties": {
"note": {
"type": "string"
},
"points": {
"items": {
"$ref": "#/$defs/PriceHistoryPoint"
},
"type": "array"
},
"status": {
"enum": [
"available",
"not_published"
],
"type": "string"
}
},
"required": [
"status",
"note",
"points"
],
"type": "object"
},
"product_id": {
"type": "string"
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"unit": {
"enum": [
"each",
"kg",
"l"
],
"type": "string"
}
},
"required": [
"product_id",
"name",
"comparison",
"unit",
"default_quantity",
"page_url",
"open_in_browser",
"offers",
"price_history",
"provenance"
],
"type": "object"
},
"GroceryProductListResponse": {
"additionalProperties": false,
"properties": {
"data": {
"items": {
"$ref": "#/$defs/GroceryProduct"
},
"type": "array"
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"GroceryProductResponse": {
"additionalProperties": false,
"properties": {
"data": {
"anyOf": [
{
"$ref": "#/$defs/GroceryProductDetail"
},
{
"type": "null"
}
]
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"Links": {
"additionalProperties": false,
"properties": {
"docs": {
"type": "string"
},
"next": {
"type": [
"string",
"null"
]
},
"open_in_browser": {
"type": [
"string",
"null"
]
},
"self": {
"type": "string"
}
},
"required": [
"self",
"next",
"open_in_browser",
"docs"
],
"type": "object"
},
"PriceHistoryPoint": {
"additionalProperties": false,
"properties": {
"date": {
"type": "string"
},
"price_aed": {
"type": "number"
},
"store_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"date",
"price_aed",
"store_id"
],
"type": "object"
},
"Provenance": {
"additionalProperties": true,
"required": [
"source_id",
"license_id",
"source_url",
"observed_on",
"observed_at",
"published_on",
"published_at",
"retrieved_at",
"stale",
"status",
"paused_since",
"flags"
],
"type": "object"
},
"ResponseMeta": {
"additionalProperties": true,
"required": [
"api_version",
"content_language",
"generated_at",
"currency",
"attribution",
"disclaimer",
"dataset",
"page"
],
"type": "object"
},
"ToolFailure": {
"additionalProperties": false,
"properties": {
"error": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"retry_after_s": {
"type": [
"integer",
"null"
]
},
"retryable": {
"type": "boolean"
}
},
"required": [
"code",
"message",
"retryable",
"retry_after_s"
],
"type": "object"
},
"request_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"error",
"request_id"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"$ref": "#/$defs/GroceryProductListResponse"
},
{
"$ref": "#/$defs/GroceryProductResponse"
},
{
"$ref": "#/$defs/GroceryOfferListResponse"
},
{
"$ref": "#/$defs/ToolFailure"
}
],
"type": "object"
}
},
{
"description": "stores, delivery fees/free thresholds/minimums. Not prices.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"cursor": {
"maxLength": 512,
"minLength": 1,
"type": "string"
},
"delivery_rule_status": {
"enum": [
"valid",
"stale",
"invalid",
"none"
],
"type": "string"
},
"page_size": {
"default": 20,
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"sort": {
"default": "name",
"enum": [
"name",
"-name"
],
"type": "string"
},
"store_id": {
"pattern": "^[a-z0-9][a-z0-9._-]{0,119}$",
"type": "string"
}
},
"type": "object"
},
"name": "grocery_stores",
"outputSchema": {
"$defs": {
"DeliveryRule": {
"additionalProperties": false,
"properties": {
"checked_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"fee_max_aed": {
"type": [
"number",
"null"
]
},
"fee_min_aed": {
"type": [
"number",
"null"
]
},
"free_from_aed": {
"type": [
"number",
"null"
]
},
"free_from_inclusive": {
"type": "boolean"
},
"minimum_order_aed": {
"type": [
"number",
"null"
]
},
"notes": {
"type": [
"string",
"null"
]
},
"possibly_free_from_aed": {
"type": [
"number",
"null"
]
},
"possibly_free_from_inclusive": {
"type": [
"boolean",
"null"
]
},
"scope": {
"type": "string"
},
"source_url": {
"type": [
"string",
"null"
]
}
},
"required": [
"scope",
"fee_min_aed",
"fee_max_aed",
"free_from_aed",
"free_from_inclusive",
"possibly_free_from_aed",
"possibly_free_from_inclusive",
"minimum_order_aed",
"notes",
"source_url",
"checked_at"
],
"type": "object"
},
"GroceryStore": {
"additionalProperties": false,
"properties": {
"coverage_note": {
"type": [
"string",
"null"
]
},
"delivery_rule": {
"anyOf": [
{
"$ref": "#/$defs/DeliveryRule"
},
{
"type": "null"
}
]
},
"delivery_rule_reason": {
"type": [
"string",
"null"
]
},
"delivery_rule_status": {
"enum": [
"valid",
"stale",
"invalid",
"none"
],
"type": "string"
},
"integrated": {
"type": "boolean"
},
"kind": {
"enum": [
"retailer",
"marketplace",
"aggregator"
],
"type": "string"
},
"minimum_order_aed": {
"type": [
"number",
"null"
]
},
"minimum_order_source_url": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"store_id": {
"type": "string"
},
"url": {
"type": [
"string",
"null"
]
}
},
"required": [
"store_id",
"name",
"url",
"kind",
"integrated",
"coverage_note",
"minimum_order_aed",
"minimum_order_source_url",
"delivery_rule",
"delivery_rule_status",
"delivery_rule_reason",
"provenance"
],
"type": "object"
},
"GroceryStoreListResponse": {
"additionalProperties": false,
"properties": {
"data": {
"items": {
"$ref": "#/$defs/GroceryStore"
},
"type": "array"
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"GroceryStoreResponse": {
"additionalProperties": false,
"properties": {
"data": {
"anyOf": [
{
"$ref": "#/$defs/GroceryStore"
},
{
"type": "null"
}
]
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"Links": {
"additionalProperties": false,
"properties": {
"docs": {
"type": "string"
},
"next": {
"type": [
"string",
"null"
]
},
"open_in_browser": {
"type": [
"string",
"null"
]
},
"self": {
"type": "string"
}
},
"required": [
"self",
"next",
"open_in_browser",
"docs"
],
"type": "object"
},
"Provenance": {
"additionalProperties": true,
"required": [
"source_id",
"license_id",
"source_url",
"observed_on",
"observed_at",
"published_on",
"published_at",
"retrieved_at",
"stale",
"status",
"paused_since",
"flags"
],
"type": "object"
},
"ResponseMeta": {
"additionalProperties": true,
"required": [
"api_version",
"content_language",
"generated_at",
"currency",
"attribution",
"disclaimer",
"dataset",
"page"
],
"type": "object"
},
"ToolFailure": {
"additionalProperties": false,
"properties": {
"error": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"retry_after_s": {
"type": [
"integer",
"null"
]
},
"retryable": {
"type": "boolean"
}
},
"required": [
"code",
"message",
"retryable",
"retry_after_s"
],
"type": "object"
},
"request_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"error",
"request_id"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"$ref": "#/$defs/GroceryStoreListResponse"
},
{
"$ref": "#/$defs/GroceryStoreResponse"
},
{
"$ref": "#/$defs/ToolFailure"
}
],
"type": "object"
}
},
{
"description": "payer rules, EBP band/benefits, fines/legal citations. Not insurer quotes.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"emirate": {
"enum": [
"dubai",
"abu_dhabi",
"sharjah",
"ajman",
"umm_al_quwain",
"ras_al_khaimah",
"fujairah"
],
"type": "string"
},
"page_size": {
"default": 20,
"maximum": 50,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"name": "health_insurance",
"outputSchema": {
"$defs": {
"HealthInsuranceScope": {
"additionalProperties": false,
"properties": {
"emirates": {
"items": {
"enum": [
"dubai",
"abu_dhabi",
"sharjah",
"ajman",
"umm_al_quwain",
"ras_al_khaimah",
"fujairah"
],
"type": "string"
},
"type": "array"
},
"facts": {
"items": {
"additionalProperties": false,
"properties": {
"amount_aed": {
"additionalProperties": false,
"properties": {
"max": {
"type": [
"number",
"null"
]
},
"min": {
"type": [
"number",
"null"
]
}
},
"required": [
"min",
"max"
],
"type": [
"object",
"null"
]
},
"fact_id": {
"type": "string"
},
"legal_source": {
"additionalProperties": false,
"properties": {
"article": {
"type": [
"string",
"null"
]
},
"document_date": {
"type": [
"string",
"null"
]
},
"doubtful": {
"type": "boolean"
},
"publisher": {
"type": [
"string",
"null"
]
},
"title": {
"type": "string"
},
"url": {
"type": [
"string",
"null"
]
}
},
"required": [
"title",
"publisher",
"url",
"article",
"document_date",
"doubtful"
],
"type": [
"object",
"null"
]
},
"text": {
"type": "string"
}
},
"required": [
"fact_id",
"text",
"amount_aed",
"legal_source"
],
"type": "object"
},
"type": "array"
},
"not_published": {
"items": {
"type": "string"
},
"type": "array"
},
"notice": {
"type": [
"string",
"null"
]
},
"paused_since": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"scope_id": {
"type": "string"
},
"status": {
"enum": [
"ok",
"paused"
],
"type": "string"
}
},
"required": [
"scope_id",
"emirates",
"status",
"notice",
"paused_since",
"facts",
"not_published",
"provenance"
],
"type": "object"
},
"HealthInsuranceScopeListResponse": {
"additionalProperties": false,
"properties": {
"data": {
"items": {
"$ref": "#/$defs/HealthInsuranceScope"
},
"type": "array"
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"Links": {
"additionalProperties": false,
"properties": {
"docs": {
"type": "string"
},
"next": {
"type": [
"string",
"null"
]
},
"open_in_browser": {
"type": [
"string",
"null"
]
},
"self": {
"type": "string"
}
},
"required": [
"self",
"next",
"open_in_browser",
"docs"
],
"type": "object"
},
"Provenance": {
"additionalProperties": true,
"required": [
"source_id",
"license_id",
"source_url",
"observed_on",
"observed_at",
"published_on",
"published_at",
"retrieved_at",
"stale",
"status",
"paused_since",
"flags"
],
"type": "object"
},
"ResponseMeta": {
"additionalProperties": true,
"required": [
"api_version",
"content_language",
"generated_at",
"currency",
"attribution",
"disclaimer",
"dataset",
"page"
],
"type": "object"
},
"ToolFailure": {
"additionalProperties": false,
"properties": {
"error": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"retry_after_s": {
"type": [
"integer",
"null"
]
},
"retryable": {
"type": "boolean"
}
},
"required": [
"code",
"message",
"retryable",
"retry_after_s"
],
"type": "object"
},
"request_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"error",
"request_id"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"$ref": "#/$defs/HealthInsuranceScopeListResponse"
},
{
"$ref": "#/$defs/ToolFailure"
}
],
"type": "object"
}
},
{
"description": "registered annual/monthly rent medians, contracts and zone sales. Not listings.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"bedrooms": {
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"contract": {
"enum": [
"new",
"renewal"
],
"type": "string"
},
"cursor": {
"maxLength": 512,
"minLength": 1,
"type": "string"
},
"min_contracts": {
"maximum": 100000,
"minimum": 10,
"type": "integer"
},
"page_size": {
"default": 20,
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"property_type": {
"enum": [
"apartment",
"villa"
],
"type": "string"
},
"q": {
"maxLength": 80,
"minLength": 1,
"type": "string"
},
"sort": {
"default": "median_annual_aed",
"enum": [
"median_annual_aed",
"-median_annual_aed",
"-contracts",
"zone_name"
],
"type": "string"
},
"zone": {
"maxLength": 120,
"minLength": 1,
"type": "string"
},
"zone_id": {
"pattern": "^[a-z0-9][a-z0-9._-]{0,119}$",
"type": "string"
}
},
"type": "object"
},
"name": "housing_rents",
"outputSchema": {
"$defs": {
"HousingZone": {
"additionalProperties": false,
"properties": {
"communities": {
"items": {
"type": "string"
},
"type": "array"
},
"communities_ar": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"name_ar": {
"type": [
"string",
"null"
]
},
"open_in_browser": {
"type": [
"string",
"null"
]
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"rent_contracts": {
"type": [
"integer",
"null"
]
},
"sale_transactions": {
"type": [
"integer",
"null"
]
},
"zone_id": {
"type": "string"
}
},
"required": [
"zone_id",
"name",
"name_ar",
"communities",
"communities_ar",
"rent_contracts",
"sale_transactions",
"open_in_browser",
"provenance"
],
"type": "object"
},
"HousingZoneDetail": {
"additionalProperties": false,
"properties": {
"communities": {
"items": {
"type": "string"
},
"type": "array"
},
"communities_ar": {
"items": {
"type": "string"
},
"type": "array"
},
"method": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"name_ar": {
"type": [
"string",
"null"
]
},
"open_in_browser": {
"type": [
"string",
"null"
]
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"rent_contracts": {
"type": [
"integer",
"null"
]
},
"rents": {
"items": {
"$ref": "#/$defs/RentMedian"
},
"type": "array"
},
"sale_transactions": {
"type": [
"integer",
"null"
]
},
"sales": {
"items": {
"$ref": "#/$defs/SaleMedian"
},
"type": "array"
},
"zone_id": {
"type": "string"
}
},
"required": [
"zone_id",
"name",
"name_ar",
"communities",
"communities_ar",
"rent_contracts",
"sale_transactions",
"open_in_browser",
"rents",
"sales",
"method",
"provenance"
],
"type": "object"
},
"HousingZoneListResponse": {
"additionalProperties": false,
"properties": {
"data": {
"items": {
"$ref": "#/$defs/HousingZone"
},
"type": "array"
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"HousingZoneResponse": {
"additionalProperties": false,
"properties": {
"data": {
"anyOf": [
{
"$ref": "#/$defs/HousingZoneDetail"
},
{
"type": "null"
}
]
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"Links": {
"additionalProperties": false,
"properties": {
"docs": {
"type": "string"
},
"next": {
"type": [
"string",
"null"
]
},
"open_in_browser": {
"type": [
"string",
"null"
]
},
"self": {
"type": "string"
}
},
"required": [
"self",
"next",
"open_in_browser",
"docs"
],
"type": "object"
},
"Provenance": {
"additionalProperties": true,
"required": [
"source_id",
"license_id",
"source_url",
"observed_on",
"observed_at",
"published_on",
"published_at",
"retrieved_at",
"stale",
"status",
"paused_since",
"flags"
],
"type": "object"
},
"RentMedian": {
"additionalProperties": false,
"properties": {
"bedrooms": {
"type": "integer"
},
"contracts": {
"type": "integer"
},
"display_monthly_aed": {
"type": [
"number",
"null"
]
},
"median_annual_aed": {
"type": "number"
},
"median_monthly_aed": {
"type": [
"number",
"null"
]
},
"new_contracts": {
"anyOf": [
{
"$ref": "#/$defs/RentSplit"
},
{
"type": "null"
}
]
},
"p25_annual_aed": {
"type": [
"number",
"null"
]
},
"p75_annual_aed": {
"type": [
"number",
"null"
]
},
"property_type": {
"enum": [
"apartment",
"villa"
],
"type": "string"
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"renewals": {
"anyOf": [
{
"$ref": "#/$defs/RentSplit"
},
{
"type": "null"
}
]
},
"zone_id": {
"type": "string"
},
"zone_name": {
"type": "string"
}
},
"required": [
"zone_id",
"zone_name",
"property_type",
"bedrooms",
"contracts",
"median_annual_aed",
"p25_annual_aed",
"p75_annual_aed",
"median_monthly_aed",
"new_contracts",
"renewals",
"provenance"
],
"type": "object"
},
"RentMedianListResponse": {
"additionalProperties": false,
"properties": {
"context": {
"additionalProperties": false,
"properties": {
"rents": {
"items": {
"$ref": "#/$defs/RentMedian"
},
"type": "array"
},
"sales": {
"items": {
"$ref": "#/$defs/SaleMedian"
},
"type": "array"
},
"zone": {
"$ref": "#/$defs/HousingZone"
}
},
"required": [
"zone",
"rents",
"sales"
],
"type": "object"
},
"data": {
"items": {
"$ref": "#/$defs/RentMedian"
},
"type": "array"
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"RentSplit": {
"additionalProperties": false,
"properties": {
"contracts": {
"type": [
"integer",
"null"
]
},
"median_annual_aed": {
"type": [
"number",
"null"
]
},
"p25_annual_aed": {
"type": [
"number",
"null"
]
},
"p75_annual_aed": {
"type": [
"number",
"null"
]
}
},
"required": [
"contracts",
"median_annual_aed",
"p25_annual_aed",
"p75_annual_aed"
],
"type": "object"
},
"ResponseMeta": {
"additionalProperties": true,
"required": [
"api_version",
"content_language",
"generated_at",
"currency",
"attribution",
"disclaimer",
"dataset",
"page"
],
"type": "object"
},
"SaleMedian": {
"additionalProperties": false,
"properties": {
"bedrooms": {
"type": "integer"
},
"market": {
"enum": [
"ready",
"off_plan"
],
"type": "string"
},
"median_aed_per_sqft": {
"type": [
"number",
"null"
]
},
"median_price_aed": {
"type": [
"number",
"null"
]
},
"p25_aed_per_sqft": {
"type": [
"number",
"null"
]
},
"p25_price_aed": {
"type": [
"number",
"null"
]
},
"p75_aed_per_sqft": {
"type": [
"number",
"null"
]
},
"p75_price_aed": {
"type": [
"number",
"null"
]
},
"property_type": {
"enum": [
"apartment",
"villa"
],
"type": "string"
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"transactions": {
"type": [
"integer",
"null"
]
},
"zone_id": {
"type": "string"
},
"zone_name": {
"type": "string"
}
},
"required": [
"zone_id",
"zone_name",
"property_type",
"bedrooms",
"market",
"transactions",
"median_price_aed",
"p25_price_aed",
"p75_price_aed",
"median_aed_per_sqft",
"p25_aed_per_sqft",
"p75_aed_per_sqft",
"provenance"
],
"type": "object"
},
"ToolFailure": {
"additionalProperties": false,
"properties": {
"error": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"retry_after_s": {
"type": [
"integer",
"null"
]
},
"retryable": {
"type": "boolean"
}
},
"required": [
"code",
"message",
"retryable",
"retry_after_s"
],
"type": "object"
},
"request_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"error",
"request_id"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"$ref": "#/$defs/RentMedianListResponse"
},
{
"$ref": "#/$defs/HousingZoneListResponse"
},
{
"$ref": "#/$defs/HousingZoneResponse"
},
{
"$ref": "#/$defs/ToolFailure"
}
],
"type": "object"
}
},
{
"description": "ready/off-plan registered medians/counts and rent context. Not listings.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"bedrooms": {
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"cursor": {
"maxLength": 512,
"minLength": 1,
"type": "string"
},
"market": {
"enum": [
"ready",
"off_plan"
],
"type": "string"
},
"page_size": {
"default": 20,
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"property_type": {
"enum": [
"apartment",
"villa"
],
"type": "string"
},
"sort": {
"default": "median_price_aed",
"enum": [
"median_price_aed",
"-median_price_aed",
"median_aed_per_sqft",
"-median_aed_per_sqft",
"-transactions",
"zone_name"
],
"type": "string"
},
"zone": {
"maxLength": 120,
"minLength": 1,
"type": "string"
},
"zone_id": {
"pattern": "^[a-z0-9][a-z0-9._-]{0,119}$",
"type": "string"
}
},
"type": "object"
},
"name": "housing_sales",
"outputSchema": {
"$defs": {
"HousingZone": {
"additionalProperties": false,
"properties": {
"communities": {
"items": {
"type": "string"
},
"type": "array"
},
"communities_ar": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"name_ar": {
"type": [
"string",
"null"
]
},
"open_in_browser": {
"type": [
"string",
"null"
]
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"rent_contracts": {
"type": [
"integer",
"null"
]
},
"sale_transactions": {
"type": [
"integer",
"null"
]
},
"zone_id": {
"type": "string"
}
},
"required": [
"zone_id",
"name",
"name_ar",
"communities",
"communities_ar",
"rent_contracts",
"sale_transactions",
"open_in_browser",
"provenance"
],
"type": "object"
},
"Links": {
"additionalProperties": false,
"properties": {
"docs": {
"type": "string"
},
"next": {
"type": [
"string",
"null"
]
},
"open_in_browser": {
"type": [
"string",
"null"
]
},
"self": {
"type": "string"
}
},
"required": [
"self",
"next",
"open_in_browser",
"docs"
],
"type": "object"
},
"Provenance": {
"additionalProperties": true,
"required": [
"source_id",
"license_id",
"source_url",
"observed_on",
"observed_at",
"published_on",
"published_at",
"retrieved_at",
"stale",
"status",
"paused_since",
"flags"
],
"type": "object"
},
"RentMedian": {
"additionalProperties": false,
"properties": {
"bedrooms": {
"type": "integer"
},
"contracts": {
"type": "integer"
},
"display_monthly_aed": {
"type": [
"number",
"null"
]
},
"median_annual_aed": {
"type": "number"
},
"median_monthly_aed": {
"type": [
"number",
"null"
]
},
"new_contracts": {
"anyOf": [
{
"$ref": "#/$defs/RentSplit"
},
{
"type": "null"
}
]
},
"p25_annual_aed": {
"type": [
"number",
"null"
]
},
"p75_annual_aed": {
"type": [
"number",
"null"
]
},
"property_type": {
"enum": [
"apartment",
"villa"
],
"type": "string"
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"renewals": {
"anyOf": [
{
"$ref": "#/$defs/RentSplit"
},
{
"type": "null"
}
]
},
"zone_id": {
"type": "string"
},
"zone_name": {
"type": "string"
}
},
"required": [
"zone_id",
"zone_name",
"property_type",
"bedrooms",
"contracts",
"median_annual_aed",
"p25_annual_aed",
"p75_annual_aed",
"median_monthly_aed",
"new_contracts",
"renewals",
"provenance"
],
"type": "object"
},
"RentSplit": {
"additionalProperties": false,
"properties": {
"contracts": {
"type": [
"integer",
"null"
]
},
"median_annual_aed": {
"type": [
"number",
"null"
]
},
"p25_annual_aed": {
"type": [
"number",
"null"
]
},
"p75_annual_aed": {
"type": [
"number",
"null"
]
}
},
"required": [
"contracts",
"median_annual_aed",
"p25_annual_aed",
"p75_annual_aed"
],
"type": "object"
},
"ResponseMeta": {
"additionalProperties": true,
"required": [
"api_version",
"content_language",
"generated_at",
"currency",
"attribution",
"disclaimer",
"dataset",
"page"
],
"type": "object"
},
"SaleMedian": {
"additionalProperties": false,
"properties": {
"bedrooms": {
"type": "integer"
},
"market": {
"enum": [
"ready",
"off_plan"
],
"type": "string"
},
"median_aed_per_sqft": {
"type": [
"number",
"null"
]
},
"median_price_aed": {
"type": [
"number",
"null"
]
},
"p25_aed_per_sqft": {
"type": [
"number",
"null"
]
},
"p25_price_aed": {
"type": [
"number",
"null"
]
},
"p75_aed_per_sqft": {
"type": [
"number",
"null"
]
},
"p75_price_aed": {
"type": [
"number",
"null"
]
},
"property_type": {
"enum": [
"apartment",
"villa"
],
"type": "string"
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"transactions": {
"type": [
"integer",
"null"
]
},
"zone_id": {
"type": "string"
},
"zone_name": {
"type": "string"
}
},
"required": [
"zone_id",
"zone_name",
"property_type",
"bedrooms",
"market",
"transactions",
"median_price_aed",
"p25_price_aed",
"p75_price_aed",
"median_aed_per_sqft",
"p25_aed_per_sqft",
"p75_aed_per_sqft",
"provenance"
],
"type": "object"
},
"SaleMedianListResponse": {
"additionalProperties": false,
"properties": {
"context": {
"additionalProperties": false,
"properties": {
"rents": {
"items": {
"$ref": "#/$defs/RentMedian"
},
"type": "array"
},
"sales": {
"items": {
"$ref": "#/$defs/SaleMedian"
},
"type": "array"
},
"zone": {
"$ref": "#/$defs/HousingZone"
}
},
"required": [
"zone",
"rents",
"sales"
],
"type": "object"
},
"data": {
"items": {
"$ref": "#/$defs/SaleMedian"
},
"type": "array"
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"ToolFailure": {
"additionalProperties": false,
"properties": {
"error": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"retry_after_s": {
"type": [
"integer",
"null"
]
},
"retryable": {
"type": "boolean"
}
},
"required": [
"code",
"message",
"retryable",
"retry_after_s"
],
"type": "object"
},
"request_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"error",
"request_id"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"$ref": "#/$defs/SaleMedianListResponse"
},
{
"$ref": "#/$defs/ToolFailure"
}
],
"type": "object"
}
},
{
"description": "VAT-inclusive mobile/home prices, promo then regular, data and contracts.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"cursor": {
"maxLength": 512,
"minLength": 1,
"type": "string"
},
"max_aed": {
"maximum": 100000,
"minimum": 0,
"type": "number"
},
"min_data_gb": {
"minimum": 0,
"type": "number"
},
"operator": {
"maxLength": 40,
"minLength": 1,
"type": "string"
},
"page_size": {
"default": 20,
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"plan_id": {
"pattern": "^[a-z0-9][a-z0-9._-]{0,119}$",
"type": "string"
},
"sort": {
"default": "price_aed_per_month",
"enum": [
"price_aed_per_month",
"aed_per_gb",
"-data_gb",
"name"
],
"type": "string"
},
"status": {
"enum": [
"ranked",
"unverified",
"excluded"
],
"type": "string"
},
"type": {
"enum": [
"mobile_postpaid",
"mobile_prepaid",
"home_internet"
],
"type": "string"
}
},
"type": "object"
},
"name": "mobile_internet_plans",
"outputSchema": {
"$defs": {
"Links": {
"additionalProperties": false,
"properties": {
"docs": {
"type": "string"
},
"next": {
"type": [
"string",
"null"
]
},
"open_in_browser": {
"type": [
"string",
"null"
]
},
"self": {
"type": "string"
}
},
"required": [
"self",
"next",
"open_in_browser",
"docs"
],
"type": "object"
},
"Provenance": {
"additionalProperties": true,
"required": [
"source_id",
"license_id",
"source_url",
"observed_on",
"observed_at",
"published_on",
"published_at",
"retrieved_at",
"stale",
"status",
"paused_since",
"flags"
],
"type": "object"
},
"ResponseMeta": {
"additionalProperties": true,
"required": [
"api_version",
"content_language",
"generated_at",
"currency",
"attribution",
"disclaimer",
"dataset",
"page"
],
"type": "object"
},
"TelecomPlan": {
"additionalProperties": false,
"properties": {
"aed_per_day": {
"type": [
"number",
"null"
]
},
"aed_per_gb": {
"type": [
"number",
"null"
]
},
"category": {
"enum": [
"mobile_postpaid",
"mobile_prepaid",
"home_internet"
],
"type": "string"
},
"citation": {
"type": [
"string",
"null"
]
},
"contract_months": {
"type": [
"number",
"null"
]
},
"data_gb": {
"type": [
"number",
"null"
]
},
"days": {
"type": [
"integer",
"null"
]
},
"excluded_reason": {
"type": [
"string",
"null"
]
},
"intl_minutes": {
"type": [
"number",
"null"
]
},
"local_minutes": {
"type": [
"number",
"null"
]
},
"name": {
"type": "string"
},
"operator": {
"type": "string"
},
"plan_id": {
"type": "string"
},
"price_aed_per_month": {
"type": [
"number",
"null"
]
},
"price_basis": {
"enum": [
"published_with_vat",
"calculated_vat_added",
null
],
"type": [
"string",
"null"
]
},
"promo_months": {
"type": [
"integer",
"null"
]
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"regular_aed_per_month": {
"type": [
"number",
"null"
]
},
"speed_mbps": {
"type": [
"number",
"null"
]
},
"status": {
"enum": [
"ranked",
"unverified",
"excluded"
],
"type": "string"
},
"unlimited_data": {
"type": [
"boolean",
"null"
]
},
"upfront_aed": {
"type": [
"number",
"null"
]
},
"url": {
"type": [
"string",
"null"
]
}
},
"required": [
"plan_id",
"operator",
"category",
"name",
"status",
"excluded_reason",
"price_aed_per_month",
"price_basis",
"regular_aed_per_month",
"promo_months",
"upfront_aed",
"days",
"aed_per_day",
"data_gb",
"unlimited_data",
"local_minutes",
"intl_minutes",
"speed_mbps",
"contract_months",
"aed_per_gb",
"url",
"citation",
"provenance"
],
"type": "object"
},
"TelecomPlanListResponse": {
"additionalProperties": false,
"properties": {
"data": {
"items": {
"$ref": "#/$defs/TelecomPlan"
},
"type": "array"
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"TelecomPlanResponse": {
"additionalProperties": false,
"properties": {
"data": {
"anyOf": [
{
"$ref": "#/$defs/TelecomPlan"
},
{
"type": "null"
}
]
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"ToolFailure": {
"additionalProperties": false,
"properties": {
"error": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"retry_after_s": {
"type": [
"integer",
"null"
]
},
"retryable": {
"type": "boolean"
}
},
"required": [
"code",
"message",
"retryable",
"retry_after_s"
],
"type": "object"
},
"request_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"error",
"request_id"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"$ref": "#/$defs/TelecomPlanListResponse"
},
{
"$ref": "#/$defs/TelecomPlanResponse"
},
{
"$ref": "#/$defs/ToolFailure"
}
],
"type": "object"
}
},
{
"description": "home/Dubai net, taxes, FX, costs/savings; omit country: models. Not tax advice.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"area": {
"maxLength": 80,
"type": [
"string",
"null"
]
},
"bedrooms": {
"maximum": 10,
"minimum": 0,
"type": [
"integer",
"null"
]
},
"country": {
"maxLength": 2,
"minLength": 2,
"pattern": "^[A-Z]{2}$",
"type": "string"
},
"currency": {
"pattern": "^[A-Z]{3}$",
"type": [
"string",
"null"
]
},
"cursor": {
"maxLength": 512,
"minLength": 1,
"type": "string"
},
"dubai_gross_annual_aed": {
"exclusiveMinimum": 0,
"maximum": 10000000000000,
"type": [
"number",
"null"
]
},
"gross_annual": {
"exclusiveMinimum": 0,
"maximum": 10000000000000,
"type": "number"
},
"home_monthly_costs": {
"maximum": 10000000000000,
"minimum": 0,
"type": [
"number",
"null"
]
},
"household": {
"additionalProperties": false,
"properties": {
"children": {
"maximum": 10,
"minimum": 0,
"type": "integer"
},
"status": {
"enum": [
"single",
"married"
],
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"iso2": {
"pattern": "^[A-Z]{2}$",
"type": "string"
},
"page_size": {
"default": 20,
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"property_type": {
"enum": [
"apartment",
"villa",
null
],
"type": [
"string",
"null"
]
},
"sort": {
"default": "name",
"enum": [
"name",
"iso2"
],
"type": "string"
},
"status": {
"enum": [
"complete",
"incomplete"
],
"type": "string"
},
"variant": {
"maxLength": 40,
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"name": "move_to_dubai",
"outputSchema": {
"$defs": {
"Links": {
"additionalProperties": false,
"properties": {
"docs": {
"type": "string"
},
"next": {
"type": [
"string",
"null"
]
},
"open_in_browser": {
"type": [
"string",
"null"
]
},
"self": {
"type": "string"
}
},
"required": [
"self",
"next",
"open_in_browser",
"docs"
],
"type": "object"
},
"Provenance": {
"additionalProperties": true,
"required": [
"source_id",
"license_id",
"source_url",
"observed_on",
"observed_at",
"published_on",
"published_at",
"retrieved_at",
"stale",
"status",
"paused_since",
"flags"
],
"type": "object"
},
"RelocationEstimate": {
"additionalProperties": false,
"properties": {
"assumptions": {
"items": {
"type": "string"
},
"type": "array"
},
"country": {
"additionalProperties": false,
"properties": {
"currency": {
"type": "string"
},
"iso2": {
"type": "string"
},
"name": {
"type": "string"
},
"tax_year": {
"type": [
"string",
"null"
]
},
"tax_year_period": {
"type": [
"string",
"null"
]
},
"variant": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"variant_label": {
"type": [
"string",
"null"
]
}
},
"required": [
"iso2",
"name",
"currency",
"tax_year",
"tax_year_period",
"variant",
"variant_label"
],
"type": "object"
},
"country_notes": {
"items": {
"type": "string"
},
"type": "array"
},
"disclaimer": {
"type": "string"
},
"dubai": {
"additionalProperties": false,
"properties": {
"gross_annual_aed": {
"type": "number"
},
"income_tax_aed": {
"const": 0
},
"net_annual_aed": {
"type": "number"
},
"net_monthly_aed": {
"type": "number"
}
},
"required": [
"gross_annual_aed",
"net_annual_aed",
"net_monthly_aed",
"income_tax_aed"
],
"type": "object"
},
"dubai_monthly_costs_aed": {
"additionalProperties": false,
"properties": {
"groceries": {
"type": [
"number",
"null"
]
},
"health": {
"type": [
"number",
"null"
]
},
"rent": {
"type": [
"number",
"null"
]
},
"school": {
"type": [
"number",
"null"
]
},
"transport": {
"type": [
"number",
"null"
]
},
"utilities": {
"type": [
"number",
"null"
]
}
},
"required": [
"rent",
"school",
"groceries",
"utilities",
"transport",
"health"
],
"type": "object"
},
"estimate": {
"const": true
},
"fx": {
"additionalProperties": false,
"properties": {
"aed_per_unit": {
"type": [
"number",
"null"
]
},
"rates_on": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source": {
"type": [
"string",
"null"
]
}
},
"required": [
"aed_per_unit",
"rates_on",
"source"
],
"type": "object"
},
"gross_annual": {
"additionalProperties": false,
"properties": {
"aed": {
"type": [
"number",
"null"
]
},
"amount": {
"type": "number"
},
"currency": {
"type": "string"
}
},
"required": [
"amount",
"currency",
"aed"
],
"type": "object"
},
"home": {
"additionalProperties": false,
"properties": {
"breakdown": {
"items": {
"additionalProperties": false,
"properties": {
"amount": {
"type": "number"
},
"component_id": {
"type": "string"
},
"kind": {
"type": "string"
},
"label": {
"type": "string"
}
},
"required": [
"component_id",
"label",
"kind",
"amount"
],
"type": "object"
},
"type": "array"
},
"currency": {
"type": "string"
},
"effective_rate": {
"type": "number"
},
"effective_rate_percent": {
"type": "number"
},
"income_tax": {
"type": "number"
},
"net_annual": {
"type": "number"
},
"net_annual_aed": {
"type": [
"number",
"null"
]
},
"net_monthly": {
"type": "number"
},
"social_contributions": {
"type": "number"
}
},
"required": [
"currency",
"net_annual",
"net_monthly",
"income_tax",
"social_contributions",
"effective_rate",
"breakdown",
"net_annual_aed"
],
"type": "object"
},
"household": {
"additionalProperties": false,
"properties": {
"children": {
"type": "integer"
},
"status": {
"enum": [
"single",
"married"
],
"type": "string"
}
},
"required": [
"status",
"children"
],
"type": "object"
},
"not_modelled": {
"items": {
"type": "string"
},
"type": "array"
},
"notices": {
"items": {
"type": "string"
},
"type": "array"
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"savings": {
"additionalProperties": false,
"properties": {
"costs_complete": {
"type": "boolean"
},
"dubai_annual_savings": {
"type": [
"number",
"null"
]
},
"dubai_monthly_costs": {
"type": [
"number",
"null"
]
},
"dubai_monthly_net": {
"type": [
"number",
"null"
]
},
"dubai_monthly_savings": {
"type": [
"number",
"null"
]
},
"home_annual_savings": {
"type": [
"number",
"null"
]
},
"home_monthly_net": {
"type": [
"number",
"null"
]
},
"home_monthly_savings": {
"type": [
"number",
"null"
]
},
"missing_costs": {
"items": {
"enum": [
"rent",
"school",
"groceries",
"utilities",
"transport",
"health"
],
"type": "string"
},
"type": "array"
},
"net_gain_annual": {
"type": [
"number",
"null"
]
},
"net_gain_monthly": {
"type": [
"number",
"null"
]
},
"savings_difference_annual": {
"type": [
"number",
"null"
]
},
"savings_difference_monthly": {
"type": [
"number",
"null"
]
},
"withheld_reason": {
"enum": [
"rent_unknown",
null
],
"type": [
"string",
"null"
]
}
},
"required": [
"home_monthly_net",
"dubai_monthly_net",
"net_gain_monthly",
"net_gain_annual",
"dubai_monthly_costs",
"missing_costs",
"costs_complete",
"dubai_monthly_savings",
"dubai_annual_savings",
"home_monthly_savings",
"home_annual_savings",
"savings_difference_monthly",
"savings_difference_annual",
"withheld_reason"
],
"type": "object"
},
"transport_reference": {
"additionalProperties": false,
"properties": {
"car_monthly_aed": {
"type": "number"
},
"fuel_month": {
"type": "string"
},
"km_per_day": {
"type": "number"
},
"public_transport_max_aed": {
"type": "number"
},
"public_transport_min_aed": {
"type": "number"
},
"salik_per_day": {
"type": "integer"
}
},
"required": [
"car_monthly_aed",
"km_per_day",
"salik_per_day",
"public_transport_min_aed",
"public_transport_max_aed",
"fuel_month"
],
"type": [
"object",
"null"
]
}
},
"required": [
"estimate",
"disclaimer",
"country",
"household",
"gross_annual",
"home",
"dubai",
"fx",
"dubai_monthly_costs_aed",
"savings",
"transport_reference",
"notices",
"country_notes",
"not_modelled",
"assumptions",
"provenance"
],
"type": "object"
},
"RelocationEstimateResponse": {
"additionalProperties": false,
"properties": {
"data": {
"anyOf": [
{
"$ref": "#/$defs/RelocationEstimate"
},
{
"type": "null"
}
]
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"ResponseMeta": {
"additionalProperties": true,
"required": [
"api_version",
"content_language",
"generated_at",
"currency",
"attribution",
"disclaimer",
"dataset",
"page"
],
"type": "object"
},
"TaxCountryModel": {
"additionalProperties": false,
"properties": {
"currency": {
"type": "string"
},
"incomplete_reason": {
"type": [
"string",
"null"
]
},
"iso2": {
"type": "string"
},
"name": {
"type": "string"
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"sources": {
"items": {
"additionalProperties": false,
"properties": {
"accessed_on": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"title": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"title",
"url",
"accessed_on"
],
"type": "object"
},
"type": "array"
},
"status": {
"enum": [
"complete",
"incomplete"
],
"type": "string"
},
"tax_year": {
"type": [
"string",
"null"
]
},
"tax_year_period": {
"type": [
"string",
"null"
]
},
"variants": {
"items": {
"additionalProperties": false,
"properties": {
"label": {
"type": "string"
},
"variant_id": {
"type": "string"
}
},
"required": [
"variant_id",
"label"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"iso2",
"name",
"currency",
"status",
"incomplete_reason",
"tax_year",
"tax_year_period",
"variants",
"sources",
"provenance"
],
"type": "object"
},
"TaxCountryModelListResponse": {
"additionalProperties": false,
"properties": {
"data": {
"items": {
"$ref": "#/$defs/TaxCountryModel"
},
"type": "array"
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"ToolFailure": {
"additionalProperties": false,
"properties": {
"error": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"retry_after_s": {
"type": [
"integer",
"null"
]
},
"retryable": {
"type": "boolean"
}
},
"required": [
"code",
"message",
"retryable",
"retry_after_s"
],
"type": "object"
},
"request_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"error",
"request_id"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"$ref": "#/$defs/RelocationEstimateResponse"
},
{
"$ref": "#/$defs/TaxCountryModelListResponse"
},
{
"$ref": "#/$defs/ToolFailure"
}
],
"type": "object"
}
},
{
"description": "unaltered MOET Dubai pack prices/branch counts. Not live offers.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"category": {
"enum": [
"bread",
"chicken",
"cooking_oil",
"dairy",
"eggs",
"legumes",
"rice",
"sugar"
],
"type": "string"
},
"chain_id": {
"enum": [
"al_maya",
"carrefour",
"emirates_coop",
"lulu",
"nesto",
"safeer",
"spinneys",
"union_coop"
],
"type": "string"
},
"cursor": {
"maxLength": 512,
"minLength": 1,
"type": "string"
},
"page_size": {
"default": 20,
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"product_id": {
"pattern": "^[a-z0-9][a-z0-9._-]{0,119}$",
"type": "string"
},
"q": {
"maxLength": 120,
"minLength": 1,
"type": "string"
},
"sort": {
"default": "name",
"enum": [
"name",
"category"
],
"type": "string"
}
},
"type": "object"
},
"name": "official_shop_prices",
"outputSchema": {
"$defs": {
"Links": {
"additionalProperties": false,
"properties": {
"docs": {
"type": "string"
},
"next": {
"type": [
"string",
"null"
]
},
"open_in_browser": {
"type": [
"string",
"null"
]
},
"self": {
"type": "string"
}
},
"required": [
"self",
"next",
"open_in_browser",
"docs"
],
"type": "object"
},
"OfficialShopPrice": {
"additionalProperties": false,
"properties": {
"brand": {
"type": [
"string",
"null"
]
},
"category": {
"enum": [
"bread",
"chicken",
"cooking_oil",
"dairy",
"eggs",
"legumes",
"rice",
"sugar"
],
"type": "string"
},
"chains": {
"items": {
"additionalProperties": false,
"properties": {
"branches": {
"type": "integer"
},
"chain_id": {
"enum": [
"al_maya",
"carrefour",
"emirates_coop",
"lulu",
"nesto",
"safeer",
"spinneys",
"union_coop"
],
"type": "string"
},
"chain_name": {
"type": "string"
},
"median_price_aed": {
"type": "number"
},
"min_price_aed": {
"type": "number"
},
"single_branch": {
"type": "boolean"
}
},
"required": [
"chain_id",
"chain_name",
"min_price_aed",
"median_price_aed",
"branches",
"single_branch"
],
"type": "object"
},
"type": "array"
},
"excluded_rows": {
"type": "integer"
},
"low_branch_rows": {
"type": "integer"
},
"name": {
"type": "string"
},
"product_id": {
"type": "string"
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"size": {
"additionalProperties": false,
"properties": {
"quantity": {
"type": "number"
},
"unit": {
"enum": [
"g",
"ml",
"pc"
],
"type": "string"
}
},
"required": [
"quantity",
"unit"
],
"type": "object"
}
},
"required": [
"product_id",
"name",
"category",
"brand",
"size",
"chains",
"low_branch_rows",
"excluded_rows",
"provenance"
],
"type": "object"
},
"OfficialShopPriceListResponse": {
"additionalProperties": false,
"properties": {
"data": {
"items": {
"$ref": "#/$defs/OfficialShopPrice"
},
"type": "array"
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"Provenance": {
"additionalProperties": true,
"required": [
"source_id",
"license_id",
"source_url",
"observed_on",
"observed_at",
"published_on",
"published_at",
"retrieved_at",
"stale",
"status",
"paused_since",
"flags"
],
"type": "object"
},
"ResponseMeta": {
"additionalProperties": true,
"required": [
"api_version",
"content_language",
"generated_at",
"currency",
"attribution",
"disclaimer",
"dataset",
"page"
],
"type": "object"
},
"ToolFailure": {
"additionalProperties": false,
"properties": {
"error": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"retry_after_s": {
"type": [
"integer",
"null"
]
},
"retryable": {
"type": "boolean"
}
},
"required": [
"code",
"message",
"retryable",
"retry_after_s"
],
"type": "object"
},
"request_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"error",
"request_id"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"$ref": "#/$defs/OfficialShopPriceListResponse"
},
{
"$ref": "#/$defs/ToolFailure"
}
],
"type": "object"
}
},
{
"description": "route payer/requirements, fees, common medical/insurance bands and paused steps.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"include_common_fees": {
"type": "boolean"
},
"page_size": {
"default": 20,
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"route_id": {
"enum": [
"employment",
"family",
"golden",
"remote",
"freelance",
"investor"
],
"type": "string"
}
},
"type": "object"
},
"name": "residence_visas",
"outputSchema": {
"$defs": {
"AedRange": {
"additionalProperties": false,
"properties": {
"max_aed": {
"type": "number"
},
"min_aed": {
"type": "number"
}
},
"required": [
"min_aed",
"max_aed"
],
"type": "object"
},
"Fee": {
"additionalProperties": false,
"properties": {
"alternative_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"amount_aed": {
"type": [
"number",
"null"
]
},
"amount_max_aed": {
"type": [
"number",
"null"
]
},
"fee_id": {
"type": "string"
},
"optional": {
"type": "boolean"
},
"percent": {
"type": [
"number",
"null"
]
},
"quote": {
"type": "string"
},
"when": {
"type": [
"string",
"null"
]
}
},
"required": [
"fee_id",
"quote",
"amount_aed",
"amount_max_aed",
"percent",
"when",
"alternative_id",
"optional"
],
"type": "object"
},
"FeeCard": {
"additionalProperties": false,
"properties": {
"authority_source": {
"additionalProperties": false,
"properties": {
"authority": {
"type": "string"
},
"title": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"authority",
"title",
"url"
],
"type": [
"object",
"null"
]
},
"card_id": {
"type": "string"
},
"citation": {
"type": "string"
},
"doubtful": {
"type": "boolean"
},
"effective_from": {
"type": "string"
},
"fees": {
"items": {
"$ref": "#/$defs/Fee"
},
"type": "array"
},
"notes": {
"items": {
"additionalProperties": false,
"properties": {
"note_id": {
"type": "string"
},
"quote": {
"type": "string"
}
},
"required": [
"note_id",
"quote"
],
"type": "object"
},
"type": "array"
},
"official_total_aed": {
"type": [
"number",
"null"
]
},
"processing_time": {
"type": [
"string",
"null"
]
},
"title": {
"type": "string"
},
"total_from_abroad": {
"anyOf": [
{
"$ref": "#/$defs/AedRange"
},
{
"type": "null"
}
]
},
"total_inside_uae": {
"anyOf": [
{
"$ref": "#/$defs/AedRange"
},
{
"type": "null"
}
]
}
},
"required": [
"card_id",
"title",
"fees",
"total_from_abroad",
"total_inside_uae",
"official_total_aed",
"processing_time",
"notes",
"authority_source"
],
"type": "object"
},
"Links": {
"additionalProperties": false,
"properties": {
"docs": {
"type": "string"
},
"next": {
"type": [
"string",
"null"
]
},
"open_in_browser": {
"type": [
"string",
"null"
]
},
"self": {
"type": "string"
}
},
"required": [
"self",
"next",
"open_in_browser",
"docs"
],
"type": "object"
},
"Provenance": {
"additionalProperties": true,
"required": [
"source_id",
"license_id",
"source_url",
"observed_on",
"observed_at",
"published_on",
"published_at",
"retrieved_at",
"stale",
"status",
"paused_since",
"flags"
],
"type": "object"
},
"ResidenceContext": {
"additionalProperties": true,
"required": [
"unknown_costs"
],
"type": "object"
},
"ResidenceFeeItem": {
"additionalProperties": false,
"properties": {
"authority": {
"type": [
"string",
"null"
]
},
"card": {
"anyOf": [
{
"$ref": "#/$defs/FeeCard"
},
{
"type": "null"
}
]
},
"item_id": {
"type": "string"
},
"paused_since": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"status": {
"enum": [
"ok",
"paused"
],
"type": "string"
},
"title": {
"type": "string"
},
"url": {
"type": [
"string",
"null"
]
}
},
"required": [
"item_id",
"title",
"status",
"authority",
"url",
"paused_since",
"card",
"provenance"
],
"type": "object"
},
"ResidenceFeeItemListResponse": {
"additionalProperties": false,
"properties": {
"context": {
"anyOf": [
{
"$ref": "#/$defs/ResidenceContext"
},
{
"type": "null"
}
]
},
"data": {
"items": {
"$ref": "#/$defs/ResidenceFeeItem"
},
"type": "array"
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"context",
"data",
"links"
],
"type": "object"
},
"ResidenceRoute": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"paused_steps": {
"items": {
"additionalProperties": false,
"properties": {
"authority": {
"type": [
"string",
"null"
]
},
"paused_since": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"step_id": {
"enum": [
"work_permit",
"entry_permit",
"residence",
"renewal"
],
"type": "string"
},
"title": {
"type": "string"
},
"url": {
"type": [
"string",
"null"
]
}
},
"required": [
"step_id",
"title",
"authority",
"url",
"paused_since"
],
"type": "object"
},
"type": "array"
},
"payer": {
"enum": [
"employer",
"sponsor",
"self",
null
],
"type": [
"string",
"null"
]
},
"payer_note": {
"type": [
"string",
"null"
]
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"requirements": {
"items": {
"additionalProperties": false,
"properties": {
"quote": {
"type": "string"
},
"requirement_id": {
"type": "string"
}
},
"required": [
"requirement_id",
"quote"
],
"type": "object"
},
"type": "array"
},
"route_id": {
"enum": [
"employment",
"family",
"golden",
"remote",
"freelance",
"investor"
],
"type": "string"
},
"steps": {
"items": {
"$ref": "#/$defs/FeeCard"
},
"type": "array"
},
"title": {
"type": "string"
},
"validity": {
"type": [
"string",
"null"
]
}
},
"required": [
"route_id",
"title",
"description",
"payer",
"payer_note",
"validity",
"steps",
"paused_steps",
"requirements",
"provenance"
],
"type": "object"
},
"ResidenceRouteListResponse": {
"additionalProperties": false,
"properties": {
"context": {
"anyOf": [
{
"$ref": "#/$defs/ResidenceContext"
},
{
"type": "null"
}
]
},
"data": {
"items": {
"$ref": "#/$defs/ResidenceRoute"
},
"type": "array"
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"context",
"data",
"links"
],
"type": "object"
},
"ResidenceRouteResponse": {
"additionalProperties": false,
"properties": {
"context": {
"$ref": "#/$defs/ResidenceContext"
},
"data": {
"anyOf": [
{
"$ref": "#/$defs/ResidenceRoute"
},
{
"type": "null"
}
]
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"ResponseMeta": {
"additionalProperties": true,
"required": [
"api_version",
"content_language",
"generated_at",
"currency",
"attribution",
"disclaimer",
"dataset",
"page"
],
"type": "object"
},
"ToolFailure": {
"additionalProperties": false,
"properties": {
"error": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"retry_after_s": {
"type": [
"integer",
"null"
]
},
"retryable": {
"type": "boolean"
}
},
"required": [
"code",
"message",
"retryable",
"retry_after_s"
],
"type": "object"
},
"request_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"error",
"request_id"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"$ref": "#/$defs/ResidenceRouteListResponse"
},
{
"$ref": "#/$defs/ResidenceRouteResponse"
},
{
"$ref": "#/$defs/ResidenceFeeItemListResponse"
},
{
"$ref": "#/$defs/ToolFailure"
}
],
"type": "object"
}
},
{
"description": "historical KHDA grade tuition, bus fees/year, distances. q: school name/part; near: zone; school_id: detail. Year ≠ Grade; uniforms paused.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"area": {
"maxLength": 80,
"minLength": 1,
"type": "string"
},
"curriculum": {
"maxLength": 60,
"minLength": 1,
"type": "string"
},
"cursor": {
"maxLength": 512,
"minLength": 1,
"type": "string"
},
"grade": {
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"max_fee_aed": {
"maximum": 1000000,
"minimum": 0,
"type": "number"
},
"near": {
"description": "Zone, not school.",
"maxLength": 80,
"minLength": 1,
"type": "string"
},
"page_size": {
"default": 20,
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"q": {
"description": "school name or part of it",
"maxLength": 120,
"minLength": 1,
"type": "string"
},
"radius_km": {
"default": 10,
"enum": [
5,
10,
15,
20,
30
],
"type": "integer"
},
"rating": {
"maxLength": 40,
"type": "string"
},
"school_id": {
"pattern": "^[a-z0-9][a-z0-9._-]{0,119}$",
"type": "string"
},
"sort": {
"default": "name",
"enum": [
"name",
"distance_km",
"annual_fee_aed",
"-annual_fee_aed"
],
"type": "string"
}
},
"type": "object"
},
"name": "schools",
"outputSchema": {
"$defs": {
"AedRange": {
"additionalProperties": false,
"properties": {
"max_aed": {
"type": "number"
},
"min_aed": {
"type": "number"
}
},
"required": [
"min_aed",
"max_aed"
],
"type": "object"
},
"CompactSchool": {
"additionalProperties": false,
"properties": {
"academic_year": {
"type": [
"string",
"null"
]
},
"annual_fee_range": {
"anyOf": [
{
"$ref": "#/$defs/AedRange"
},
{
"type": "null"
}
]
},
"area": {
"type": [
"string",
"null"
]
},
"bus": {
"anyOf": [
{
"$ref": "#/$defs/CompactSchoolBus"
},
{
"type": "null"
}
]
},
"curricula": {
"items": {
"type": "string"
},
"type": "array"
},
"distance_km": {
"type": [
"number",
"null"
]
},
"grade_fee_aed": {
"type": [
"number",
"null"
]
},
"location_approximate": {
"type": [
"boolean",
"null"
]
},
"name": {
"type": "string"
},
"open_in_browser": {
"type": "string"
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"rating": {
"type": [
"string",
"null"
]
},
"school_id": {
"type": "string"
},
"source_url": {
"type": [
"string",
"null"
]
},
"uniforms_status": {
"enum": [
"available",
"paused",
"not_published"
],
"type": "string"
},
"website": {
"type": [
"string",
"null"
]
}
},
"required": [
"school_id",
"name",
"area",
"curricula",
"rating",
"academic_year",
"annual_fee_range",
"grade_fee_aed",
"website",
"source_url",
"distance_km",
"location_approximate",
"bus",
"uniforms_status",
"open_in_browser",
"provenance"
],
"type": "object"
},
"CompactSchoolBus": {
"additionalProperties": false,
"properties": {
"academic_year": {
"type": "string"
},
"operator": {
"type": "string"
},
"source_url": {
"type": "string"
},
"zones": {
"items": {
"additionalProperties": false,
"properties": {
"annual_aed": {
"type": "number"
},
"zone": {
"type": "integer"
}
},
"required": [
"zone",
"annual_aed"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"operator",
"academic_year",
"zones",
"source_url"
],
"type": "object"
},
"CompactSchoolListResponse": {
"additionalProperties": false,
"properties": {
"context": {
"additionalProperties": false,
"properties": {
"search": {
"additionalProperties": false,
"properties": {
"displayed_count": {
"type": "integer"
},
"near": {
"type": [
"string",
"null"
]
},
"radius_km": {
"type": [
"number",
"null"
]
},
"remaining_count": {
"type": "integer"
},
"returned_remaining_count": {
"type": "integer"
},
"total_schools": {
"type": "integer"
},
"unlocated": {
"type": [
"integer",
"null"
]
}
},
"required": [
"total_schools",
"near",
"radius_km",
"unlocated"
],
"type": "object"
}
},
"required": [
"search"
],
"type": "object"
},
"data": {
"items": {
"$ref": "#/$defs/CompactSchool"
},
"type": "array"
},
"fee_policy": {
"anyOf": [
{
"$ref": "#/$defs/SchoolFeePolicy"
},
{
"type": "null"
}
]
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"GradeFee": {
"additionalProperties": false,
"properties": {
"annual_fee_aed": {
"type": "number"
},
"grade": {
"type": "string"
}
},
"required": [
"grade",
"annual_fee_aed"
],
"type": "object"
},
"Links": {
"additionalProperties": false,
"properties": {
"docs": {
"type": "string"
},
"next": {
"type": [
"string",
"null"
]
},
"open_in_browser": {
"type": [
"string",
"null"
]
},
"self": {
"type": "string"
}
},
"required": [
"self",
"next",
"open_in_browser",
"docs"
],
"type": "object"
},
"Provenance": {
"additionalProperties": true,
"required": [
"source_id",
"license_id",
"source_url",
"observed_on",
"observed_at",
"published_on",
"published_at",
"retrieved_at",
"stale",
"status",
"paused_since",
"flags"
],
"type": "object"
},
"ResponseMeta": {
"additionalProperties": true,
"required": [
"api_version",
"content_language",
"generated_at",
"currency",
"attribution",
"disclaimer",
"dataset",
"page"
],
"type": "object"
},
"School": {
"additionalProperties": false,
"properties": {
"academic_year": {
"type": [
"string",
"null"
]
},
"annual_fee_range": {
"anyOf": [
{
"$ref": "#/$defs/AedRange"
},
{
"type": "null"
}
]
},
"area": {
"type": [
"string",
"null"
]
},
"bus": {
"anyOf": [
{
"$ref": "#/$defs/SchoolBus"
},
{
"type": "null"
}
]
},
"curricula": {
"items": {
"type": "string"
},
"type": "array"
},
"distance_km": {
"type": [
"number",
"null"
]
},
"fees": {
"items": {
"$ref": "#/$defs/GradeFee"
},
"type": "array"
},
"grade_fee_aed": {
"type": [
"number",
"null"
]
},
"location_approximate": {
"type": [
"boolean",
"null"
]
},
"name": {
"type": "string"
},
"open_in_browser": {
"type": "string"
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"rating": {
"type": [
"string",
"null"
]
},
"school_id": {
"type": "string"
},
"source_url": {
"type": [
"string",
"null"
]
},
"uniforms_status": {
"enum": [
"available",
"paused",
"not_published"
],
"type": "string"
},
"website": {
"type": [
"string",
"null"
]
}
},
"required": [
"school_id",
"name",
"area",
"curricula",
"rating",
"academic_year",
"fees",
"annual_fee_range",
"grade_fee_aed",
"website",
"source_url",
"distance_km",
"location_approximate",
"bus",
"uniforms_status",
"open_in_browser",
"provenance"
],
"type": "object"
},
"SchoolBus": {
"additionalProperties": false,
"properties": {
"academic_year": {
"type": "string"
},
"operator": {
"type": "string"
},
"source_url": {
"type": "string"
},
"zones": {
"items": {
"additionalProperties": false,
"properties": {
"annual_aed": {
"type": "number"
},
"areas": {
"items": {
"type": "string"
},
"type": "array"
},
"zone": {
"type": "integer"
}
},
"required": [
"zone",
"annual_aed",
"areas"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"operator",
"academic_year",
"zones",
"source_url"
],
"type": "object"
},
"SchoolFeePolicy": {
"additionalProperties": false,
"properties": {
"note": {
"type": [
"string",
"null"
]
},
"rules": {
"items": {
"additionalProperties": false,
"properties": {
"academic_year": {
"type": "string"
},
"announced": {
"type": "string"
},
"cap_pct": {
"type": [
"number",
"null"
]
},
"id": {
"type": "string"
},
"kind": {
"enum": [
"cap",
"no-increase"
],
"type": "string"
},
"publisher": {
"type": "string"
},
"quote": {
"type": "string"
},
"summary": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"id",
"academic_year",
"kind",
"cap_pct",
"announced",
"publisher",
"url",
"quote",
"summary"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"note",
"rules"
],
"type": "object"
},
"SchoolResponse": {
"additionalProperties": false,
"properties": {
"context": {
"additionalProperties": false,
"properties": {
"search": {
"additionalProperties": false,
"properties": {
"displayed_count": {
"type": "integer"
},
"near": {
"type": [
"string",
"null"
]
},
"radius_km": {
"type": [
"number",
"null"
]
},
"remaining_count": {
"type": "integer"
},
"returned_remaining_count": {
"type": "integer"
},
"total_schools": {
"type": "integer"
},
"unlocated": {
"type": [
"integer",
"null"
]
}
},
"required": [
"total_schools",
"near",
"radius_km",
"unlocated"
],
"type": "object"
}
},
"required": [
"search"
],
"type": "object"
},
"data": {
"anyOf": [
{
"$ref": "#/$defs/School"
},
{
"type": "null"
}
]
},
"fee_policy": {
"anyOf": [
{
"$ref": "#/$defs/SchoolFeePolicy"
},
{
"type": "null"
}
]
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"ToolFailure": {
"additionalProperties": false,
"properties": {
"error": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"retry_after_s": {
"type": [
"integer",
"null"
]
},
"retryable": {
"type": "boolean"
}
},
"required": [
"code",
"message",
"retryable",
"retry_after_s"
],
"type": "object"
},
"request_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"error",
"request_id"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"$ref": "#/$defs/CompactSchoolListResponse"
},
{
"$ref": "#/$defs/SchoolResponse"
},
{
"$ref": "#/$defs/ToolFailure"
}
],
"type": "object"
}
},
{
"description": "moderated prices/store/date/promos. Not MOET/live offers.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"area": {
"maxLength": 120,
"minLength": 1,
"type": "string"
},
"cursor": {
"maxLength": 512,
"minLength": 1,
"type": "string"
},
"page_size": {
"default": 20,
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"product_id": {
"pattern": "^[a-z0-9][a-z0-9._-]{0,119}$",
"type": "string"
},
"purchased_since": {
"format": "date",
"type": "string"
},
"sort": {
"default": "-purchased_on",
"enum": [
"-purchased_on",
"purchased_on",
"unit_price_aed"
],
"type": "string"
},
"store_id": {
"pattern": "^[a-z0-9][a-z0-9._-]{0,119}$",
"type": "string"
}
},
"type": "object"
},
"name": "shopper_price_reports",
"outputSchema": {
"$defs": {
"Links": {
"additionalProperties": false,
"properties": {
"docs": {
"type": "string"
},
"next": {
"type": [
"string",
"null"
]
},
"open_in_browser": {
"type": [
"string",
"null"
]
},
"self": {
"type": "string"
}
},
"required": [
"self",
"next",
"open_in_browser",
"docs"
],
"type": "object"
},
"Provenance": {
"additionalProperties": true,
"required": [
"source_id",
"license_id",
"source_url",
"observed_on",
"observed_at",
"published_on",
"published_at",
"retrieved_at",
"stale",
"status",
"paused_since",
"flags"
],
"type": "object"
},
"ResponseMeta": {
"additionalProperties": true,
"required": [
"api_version",
"content_language",
"generated_at",
"currency",
"attribution",
"disclaimer",
"dataset",
"page"
],
"type": "object"
},
"ShopperReport": {
"additionalProperties": false,
"properties": {
"moderation_status": {
"const": "accepted"
},
"product_id": {
"type": "string"
},
"promo": {
"type": "boolean"
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"purchased_on": {
"type": "string"
},
"report_id": {
"type": "string"
},
"store_id": {
"type": "string"
},
"unit_price_aed": {
"type": "number"
}
},
"required": [
"report_id",
"product_id",
"store_id",
"purchased_on",
"unit_price_aed",
"promo",
"moderation_status",
"provenance"
],
"type": "object"
},
"ShopperReportListResponse": {
"additionalProperties": false,
"properties": {
"data": {
"items": {
"$ref": "#/$defs/ShopperReport"
},
"type": "array"
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"ToolFailure": {
"additionalProperties": false,
"properties": {
"error": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"retry_after_s": {
"type": [
"integer",
"null"
]
},
"retryable": {
"type": "boolean"
}
},
"required": [
"code",
"message",
"retryable",
"retry_after_s"
],
"type": "object"
},
"request_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"error",
"request_id"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"$ref": "#/$defs/ShopperReportListResponse"
},
{
"$ref": "#/$defs/ToolFailure"
}
],
"type": "object"
}
},
{
"description": "country family-index income/tax savings/years. Not tax advice.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"country": {
"pattern": "^[A-Z]{2}$",
"type": "string"
},
"cursor": {
"maxLength": 512,
"minLength": 1,
"type": "string"
},
"household": {
"enum": [
"employee",
"business_owner"
],
"type": "string"
},
"page_size": {
"default": 20,
"maximum": 50,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"name": "tax_savings_by_country",
"outputSchema": {
"$defs": {
"BusinessOwners": {
"additionalProperties": false,
"properties": {
"assumptions": {
"items": {
"type": "string"
},
"type": "array"
},
"component_labels": {
"items": {
"additionalProperties": false,
"properties": {
"component_id": {
"type": "string"
},
"label": {
"type": "string"
}
},
"required": [
"component_id",
"label"
],
"type": "object"
},
"type": "array"
},
"default_case": {
"type": [
"string",
"null"
]
},
"leaving_rules": {
"items": {
"additionalProperties": false,
"properties": {
"rule_id": {
"type": "string"
},
"sources": {
"items": {
"$ref": "#/$defs/SourceDoc"
},
"type": "array"
},
"text": {
"type": "string"
}
},
"required": [
"rule_id",
"text",
"sources"
],
"type": "object"
},
"type": "array"
},
"not_modelled": {
"items": {
"type": "string"
},
"type": "array"
},
"scenarios": {
"items": {
"additionalProperties": false,
"properties": {
"choice": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"corporate_tax": {
"type": [
"number",
"null"
]
},
"dubai": {
"additionalProperties": false,
"properties": {
"free_zone": {
"$ref": "#/$defs/DubaiOwnerOutcome"
},
"mainland": {
"$ref": "#/$defs/DubaiOwnerOutcome"
}
},
"required": [
"mainland",
"free_zone"
],
"type": "object"
},
"effective_rate": {
"type": [
"number",
"null"
]
},
"net": {
"type": [
"number",
"null"
]
},
"personal_tax": {
"type": [
"number",
"null"
]
},
"profit": {
"type": "number"
},
"profit_aed": {
"type": [
"number",
"null"
]
},
"regime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"total_tax": {
"type": [
"number",
"null"
]
}
},
"required": [
"profit",
"profit_aed",
"corporate_tax",
"personal_tax",
"total_tax",
"net",
"effective_rate",
"choice",
"regime",
"dubai"
],
"type": "object"
},
"type": "array"
},
"sources": {
"items": {
"$ref": "#/$defs/SourceDoc"
},
"type": "array"
},
"status": {
"enum": [
"complete",
"incomplete"
],
"type": "string"
},
"tax_year": {
"type": [
"string",
"null"
]
}
},
"required": [
"status",
"tax_year",
"default_case",
"scenarios",
"component_labels",
"assumptions",
"not_modelled",
"leaving_rules",
"sources"
],
"type": "object"
},
"DubaiOwnerOutcome": {
"additionalProperties": false,
"properties": {
"effective_rate": {
"type": [
"number",
"null"
]
},
"net": {
"type": [
"number",
"null"
]
},
"saving": {
"type": [
"number",
"null"
]
},
"saving_aed": {
"type": [
"number",
"null"
]
},
"saving_share": {
"type": [
"number",
"null"
]
},
"tax": {
"type": [
"number",
"null"
]
},
"tax_aed": {
"type": [
"number",
"null"
]
}
},
"required": [
"tax_aed",
"tax",
"net",
"effective_rate",
"saving",
"saving_aed",
"saving_share"
],
"type": "object"
},
"FamilyIndexContext": {
"additionalProperties": true,
"required": [
"dubai_corporate",
"fx"
],
"type": "object"
},
"FamilyIndexEntry": {
"additionalProperties": false,
"properties": {
"business_owners": {
"anyOf": [
{
"$ref": "#/$defs/BusinessOwners"
},
{
"type": "null"
}
]
},
"currency": {
"type": "string"
},
"employees": {
"items": {
"additionalProperties": false,
"properties": {
"available": {
"type": "boolean"
},
"children": {
"type": "integer"
},
"gross": {
"type": [
"number",
"null"
]
},
"gross_aed": {
"type": [
"number",
"null"
]
},
"household_status": {
"enum": [
"single",
"married"
],
"type": "string"
},
"income_tax": {
"type": [
"number",
"null"
]
},
"label": {
"type": "string"
},
"net": {
"type": [
"number",
"null"
]
},
"saving": {
"type": [
"number",
"null"
]
},
"saving_aed": {
"type": [
"number",
"null"
]
},
"saving_monthly": {
"type": [
"number",
"null"
]
},
"saving_share": {
"type": [
"number",
"null"
]
},
"scenario_id": {
"type": "string"
},
"social_contributions": {
"type": [
"number",
"null"
]
},
"statistic_id": {
"type": "string"
}
},
"required": [
"scenario_id",
"label",
"statistic_id",
"household_status",
"children",
"available",
"gross",
"gross_aed",
"income_tax",
"social_contributions",
"net",
"saving",
"saving_monthly",
"saving_aed",
"saving_share"
],
"type": "object"
},
"type": "array"
},
"fx_aed_per_unit": {
"type": [
"number",
"null"
]
},
"iso2": {
"type": "string"
},
"name": {
"type": "string"
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"statistics": {
"items": {
"additionalProperties": false,
"properties": {
"annual_factor": {
"type": "number"
},
"basis": {
"type": "string"
},
"label": {
"type": "string"
},
"measure": {
"type": "string"
},
"period_label": {
"type": "string"
},
"population": {
"type": "string"
},
"published_on": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"quote": {
"type": [
"string",
"null"
]
},
"source": {
"$ref": "#/$defs/SourceDoc"
},
"statistic_id": {
"type": "string"
},
"value": {
"type": "number"
}
},
"required": [
"statistic_id",
"label",
"measure",
"value",
"annual_factor",
"period_label",
"basis",
"population",
"published_on",
"source",
"quote"
],
"type": "object"
},
"type": "array"
},
"tax_year": {
"type": [
"string",
"null"
]
}
},
"required": [
"iso2",
"name",
"currency",
"tax_year",
"fx_aed_per_unit",
"employees",
"statistics",
"business_owners",
"provenance"
],
"type": "object"
},
"FamilyIndexListResponse": {
"additionalProperties": false,
"properties": {
"context": {
"anyOf": [
{
"$ref": "#/$defs/FamilyIndexContext"
},
{
"type": "null"
}
]
},
"data": {
"items": {
"$ref": "#/$defs/FamilyIndexEntry"
},
"type": "array"
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"context",
"data",
"links"
],
"type": "object"
},
"Links": {
"additionalProperties": false,
"properties": {
"docs": {
"type": "string"
},
"next": {
"type": [
"string",
"null"
]
},
"open_in_browser": {
"type": [
"string",
"null"
]
},
"self": {
"type": "string"
}
},
"required": [
"self",
"next",
"open_in_browser",
"docs"
],
"type": "object"
},
"Provenance": {
"additionalProperties": true,
"required": [
"source_id",
"license_id",
"source_url",
"observed_on",
"observed_at",
"published_on",
"published_at",
"retrieved_at",
"stale",
"status",
"paused_since",
"flags"
],
"type": "object"
},
"ResponseMeta": {
"additionalProperties": true,
"required": [
"api_version",
"content_language",
"generated_at",
"currency",
"attribution",
"disclaimer",
"dataset",
"page"
],
"type": "object"
},
"SourceDoc": {
"additionalProperties": true,
"required": [
"title",
"url",
"accessed_on"
],
"type": "object"
},
"ToolFailure": {
"additionalProperties": false,
"properties": {
"error": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"retry_after_s": {
"type": [
"integer",
"null"
]
},
"retryable": {
"type": "boolean"
}
},
"required": [
"code",
"message",
"retryable",
"retry_after_s"
],
"type": "object"
},
"request_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"error",
"request_id"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"$ref": "#/$defs/FamilyIndexListResponse"
},
{
"$ref": "#/$defs/ToolFailure"
}
],
"type": "object"
}
},
{
"description": "dated highlights, sources/figures/caveats. Not live.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {},
"type": "object"
},
"name": "today",
"outputSchema": {
"$defs": {
"Links": {
"additionalProperties": false,
"properties": {
"docs": {
"type": "string"
},
"next": {
"type": [
"string",
"null"
]
},
"open_in_browser": {
"type": [
"string",
"null"
]
},
"self": {
"type": "string"
}
},
"required": [
"self",
"next",
"open_in_browser",
"docs"
],
"type": "object"
},
"Provenance": {
"additionalProperties": true,
"required": [
"source_id",
"license_id",
"source_url",
"observed_on",
"observed_at",
"published_on",
"published_at",
"retrieved_at",
"stale",
"status",
"paused_since",
"flags"
],
"type": "object"
},
"ResponseMeta": {
"additionalProperties": true,
"required": [
"api_version",
"content_language",
"generated_at",
"currency",
"attribution",
"disclaimer",
"dataset",
"page"
],
"type": "object"
},
"TodayContext": {
"additionalProperties": true,
"required": [
"date",
"lead",
"post",
"image"
],
"type": "object"
},
"TodayFuelValues": {
"additionalProperties": false,
"properties": {
"diesel": {
"type": "number"
},
"eplus91": {
"type": "number"
},
"month": {
"type": "string"
},
"pct_super98": {
"type": "number"
},
"previous_month": {
"type": "string"
},
"previous_super98": {
"type": "number"
},
"special95": {
"type": "number"
},
"super98": {
"type": "number"
}
},
"required": [
"month",
"super98",
"special95",
"eplus91",
"diesel",
"previous_month",
"previous_super98",
"pct_super98"
],
"type": "object"
},
"TodayItem": {
"additionalProperties": false,
"properties": {
"item_id": {
"enum": [
"fuel",
"rent",
"tax_savings",
"school_fees"
],
"type": "string"
},
"observed_on": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"source_label": {
"type": [
"string",
"null"
]
},
"text": {
"type": "string"
},
"url": {
"type": [
"string",
"null"
]
},
"values": {
"oneOf": [
{
"$ref": "#/$defs/TodayFuelValues"
},
{
"$ref": "#/$defs/TodayRentValues"
},
{
"$ref": "#/$defs/TodayTaxSavingsValues"
},
{
"$ref": "#/$defs/TodaySchoolFeesValues"
}
]
}
},
"required": [
"item_id",
"text",
"url",
"source_label",
"observed_on",
"values",
"provenance"
],
"type": "object"
},
"TodayItemListResponse": {
"additionalProperties": false,
"properties": {
"context": {
"anyOf": [
{
"$ref": "#/$defs/TodayContext"
},
{
"type": "null"
}
]
},
"data": {
"items": {
"$ref": "#/$defs/TodayItem"
},
"type": "array"
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"context",
"data",
"links"
],
"type": "object"
},
"TodayRentValues": {
"additionalProperties": false,
"properties": {
"bedrooms": {
"type": "integer"
},
"contracts": {
"type": "integer"
},
"from": {
"type": "string"
},
"median_annual_aed": {
"type": "number"
},
"p25_annual_aed": {
"type": [
"number",
"null"
]
},
"p75_annual_aed": {
"type": [
"number",
"null"
]
},
"to": {
"type": "string"
},
"zone": {
"type": "string"
},
"zone_id": {
"type": "string"
}
},
"required": [
"zone",
"zone_id",
"bedrooms",
"median_annual_aed",
"p25_annual_aed",
"p75_annual_aed",
"contracts",
"from",
"to"
],
"type": "object"
},
"TodaySchoolFeesValues": {
"additionalProperties": false,
"properties": {
"academic_year": {
"type": "string"
},
"highest_aed": {
"type": "number"
},
"lowest_aed": {
"type": "number"
},
"schools": {
"type": "integer"
}
},
"required": [
"schools",
"lowest_aed",
"highest_aed",
"academic_year"
],
"type": "object"
},
"TodayTaxSavingsValues": {
"additionalProperties": false,
"properties": {
"country": {
"type": "string"
},
"currency": {
"type": "string"
},
"period_label": {
"type": "string"
},
"saving_aed": {
"type": "number"
},
"saving_local": {
"type": "number"
},
"statistic": {
"type": "string"
},
"tax_year": {
"type": "string"
}
},
"required": [
"country",
"currency",
"saving_local",
"saving_aed",
"statistic",
"period_label",
"tax_year"
],
"type": "object"
},
"ToolFailure": {
"additionalProperties": false,
"properties": {
"error": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"retry_after_s": {
"type": [
"integer",
"null"
]
},
"retryable": {
"type": "boolean"
}
},
"required": [
"code",
"message",
"retryable",
"retry_after_s"
],
"type": "object"
},
"request_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"error",
"request_id"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"$ref": "#/$defs/TodayItemListResponse"
},
{
"$ref": "#/$defs/ToolFailure"
}
],
"type": "object"
}
},
{
"description": "taxi tariffs/trip estimate or public/parking/tolls plus fuel. Not app quotes.",
"inputSchema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"booking": {
"enum": [
"street_day",
"street_night",
"ehail_offpeak",
"ehail_peak",
"ehail_night"
],
"type": "string"
},
"emirate": {
"enum": [
"dubai",
"abu_dhabi",
"sharjah",
"ajman",
"umm_al_quwain",
"ras_al_khaimah",
"fujairah"
],
"type": "string"
},
"km": {
"maximum": 300,
"minimum": 0.1,
"type": "number"
},
"mode": {
"enum": [
"taxi",
"public",
"parking",
"tolls"
],
"type": "string"
},
"operator_id": {
"enum": [
"salik",
"darb"
],
"type": "string"
},
"page_size": {
"default": 20,
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"to_sharjah": {
"type": "boolean"
},
"wait_minutes": {
"maximum": 180,
"minimum": 0,
"type": "number"
}
},
"required": [
"mode"
],
"type": "object"
},
"name": "transport_fares",
"outputSchema": {
"$defs": {
"Links": {
"additionalProperties": false,
"properties": {
"docs": {
"type": "string"
},
"next": {
"type": [
"string",
"null"
]
},
"open_in_browser": {
"type": [
"string",
"null"
]
},
"self": {
"type": "string"
}
},
"required": [
"self",
"next",
"open_in_browser",
"docs"
],
"type": "object"
},
"ParkingTariffs": {
"additionalProperties": false,
"properties": {
"average_paid_per_hour": {
"additionalProperties": false,
"properties": {
"all_zones_aed": {
"type": [
"number",
"null"
]
},
"by_zone": {
"items": {
"additionalProperties": false,
"properties": {
"aed": {
"type": "number"
},
"previous_aed": {
"type": [
"number",
"null"
]
},
"zones": {
"type": "string"
}
},
"required": [
"zones",
"aed",
"previous_aed"
],
"type": "object"
},
"type": "array"
},
"compared_with": {
"type": "string"
},
"period": {
"type": "string"
},
"previous_all_zones_aed": {
"type": [
"number",
"null"
]
},
"what": {
"type": "string"
}
},
"required": [
"period",
"compared_with",
"what",
"by_zone",
"all_zones_aed",
"previous_all_zones_aed"
],
"type": [
"object",
"null"
]
},
"chargeable_hours": {
"items": {
"$ref": "#/$defs/TimeRange"
},
"type": "array"
},
"effective_on": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"emirate": {
"enum": [
"dubai",
"abu_dhabi",
"sharjah",
"ajman",
"umm_al_quwain",
"ras_al_khaimah",
"fujairah"
],
"type": "string"
},
"free_days": {
"type": "string"
},
"grand_events": {
"additionalProperties": false,
"properties": {
"aed_per_hour": {
"type": "number"
},
"hours": {
"items": {
"$ref": "#/$defs/TimeRange"
},
"type": "array"
},
"where": {
"type": "string"
}
},
"required": [
"aed_per_hour",
"hours",
"where"
],
"type": [
"object",
"null"
]
},
"multi_storey": {
"additionalProperties": false,
"properties": {
"aed_per_hour": {
"type": "number"
},
"chargeable": {
"type": "string"
},
"max_aed_over_8_hours_in_24": {
"type": [
"number",
"null"
]
}
},
"required": [
"aed_per_hour",
"chargeable",
"max_aed_over_8_hours_in_24"
],
"type": [
"object",
"null"
]
},
"off_peak_hours": {
"items": {
"$ref": "#/$defs/TimeRange"
},
"type": "array"
},
"operator_name": {
"type": "string"
},
"peak_hours": {
"items": {
"$ref": "#/$defs/TimeRange"
},
"type": "array"
},
"posted_hourly_aed": {
"type": "null"
},
"posted_hourly_note": {
"type": "string"
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"seasonal_cards": {
"additionalProperties": false,
"properties": {
"as_of": {
"type": "string"
},
"options": {
"items": {
"additionalProperties": false,
"properties": {
"option_id": {
"type": "string"
},
"prices": {
"items": {
"additionalProperties": false,
"properties": {
"aed": {
"type": "number"
},
"months": {
"type": "integer"
}
},
"required": [
"months",
"aed"
],
"type": "object"
},
"type": "array"
},
"zones": {
"type": "string"
}
},
"required": [
"option_id",
"zones",
"prices"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"as_of",
"options"
],
"type": [
"object",
"null"
]
},
"zones": {
"items": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"kind": {
"enum": [
"on_street",
"off_street"
],
"type": "string"
},
"premium_code": {
"type": [
"string",
"null"
]
}
},
"required": [
"code",
"kind",
"premium_code"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"emirate",
"operator_name",
"effective_on",
"chargeable_hours",
"peak_hours",
"off_peak_hours",
"free_days",
"zones",
"posted_hourly_aed",
"posted_hourly_note",
"average_paid_per_hour",
"seasonal_cards",
"multi_storey",
"grand_events",
"provenance"
],
"type": "object"
},
"ParkingTariffsResponse": {
"additionalProperties": false,
"properties": {
"context": {
"$ref": "#/$defs/TransportReferenceContext"
},
"data": {
"anyOf": [
{
"$ref": "#/$defs/ParkingTariffs"
},
{
"type": "null"
}
]
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"Provenance": {
"additionalProperties": true,
"required": [
"source_id",
"license_id",
"source_url",
"observed_on",
"observed_at",
"published_on",
"published_at",
"retrieved_at",
"stale",
"status",
"paused_since",
"flags"
],
"type": "object"
},
"PublicTransportFare": {
"additionalProperties": false,
"properties": {
"emirate": {
"enum": [
"dubai",
"abu_dhabi",
"sharjah",
"ajman",
"umm_al_quwain",
"ras_al_khaimah",
"fujairah"
],
"type": "string"
},
"fares": {
"items": {
"additionalProperties": false,
"properties": {
"aed": {
"type": "number"
},
"fare_id": {
"type": "string"
},
"label": {
"type": "string"
},
"per": {
"enum": [
"ticket",
"month",
"card",
"passenger"
],
"type": "string"
}
},
"required": [
"fare_id",
"label",
"aed",
"per"
],
"type": "object"
},
"type": "array"
},
"notice": {
"type": [
"string",
"null"
]
},
"operator_id": {
"enum": [
"rta_nol",
"srta_bus",
"srta_bus_on_demand"
],
"type": "string"
},
"operator_name": {
"type": "string"
},
"paused_since": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"service_area": {
"type": [
"string",
"null"
]
},
"status": {
"enum": [
"ok",
"paused"
],
"type": "string"
}
},
"required": [
"operator_id",
"operator_name",
"emirate",
"status",
"notice",
"paused_since",
"fares",
"service_area",
"provenance"
],
"type": "object"
},
"PublicTransportFareListResponse": {
"additionalProperties": false,
"properties": {
"context": {
"$ref": "#/$defs/TransportReferenceContext"
},
"data": {
"items": {
"$ref": "#/$defs/PublicTransportFare"
},
"type": "array"
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"ResponseMeta": {
"additionalProperties": true,
"required": [
"api_version",
"content_language",
"generated_at",
"currency",
"attribution",
"disclaimer",
"dataset",
"page"
],
"type": "object"
},
"TaxiBand": {
"additionalProperties": false,
"properties": {
"aed": {
"type": "number"
},
"from": {
"type": "string"
},
"to": {
"type": "string"
}
},
"required": [
"from",
"to",
"aed"
],
"type": "object"
},
"TaxiFares": {
"additionalProperties": false,
"properties": {
"abu_dhabi": {
"additionalProperties": false,
"properties": {
"notice": {
"type": [
"string",
"null"
]
},
"paused_since": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"enum": [
"ok",
"paused"
],
"type": "string"
}
},
"required": [
"status",
"notice",
"paused_since"
],
"type": "object"
},
"ehail_starting_aed": {
"additionalProperties": false,
"properties": {
"friday": {
"items": {
"$ref": "#/$defs/TaxiBand"
},
"type": "array"
},
"weekdays": {
"items": {
"$ref": "#/$defs/TaxiBand"
},
"type": "array"
},
"weekends": {
"items": {
"$ref": "#/$defs/TaxiBand"
},
"type": "array"
}
},
"required": [
"weekdays",
"friday",
"weekends"
],
"type": "object"
},
"minimum_fare_aed": {
"additionalProperties": false,
"properties": {
"ehail": {
"type": [
"number",
"null"
]
},
"street": {
"type": [
"number",
"null"
]
}
},
"required": [
"street",
"ehail"
],
"type": "object"
},
"not_included": {
"type": [
"string",
"null"
]
},
"operator_name": {
"type": "string"
},
"per_km_aed": {
"type": [
"number",
"null"
]
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"public_transport": {
"items": {
"$ref": "#/$defs/PublicTransportFare"
},
"type": "array"
},
"sharjah_surcharge_aed": {
"type": [
"number",
"null"
]
},
"sharjah_taxi_notice": {
"type": [
"string",
"null"
]
},
"street_hail_starting_aed": {
"items": {
"$ref": "#/$defs/TaxiBand"
},
"type": "array"
},
"trip": {
"anyOf": [
{
"$ref": "#/$defs/TaxiTrip"
},
{
"type": "null"
}
]
},
"waiting_per_minute_aed": {
"type": [
"number",
"null"
]
}
},
"required": [
"operator_name",
"street_hail_starting_aed",
"ehail_starting_aed",
"per_km_aed",
"minimum_fare_aed",
"waiting_per_minute_aed",
"sharjah_surcharge_aed",
"trip",
"abu_dhabi",
"not_included",
"provenance"
],
"type": "object"
},
"TaxiFaresResponse": {
"additionalProperties": false,
"properties": {
"data": {
"anyOf": [
{
"$ref": "#/$defs/TaxiFares"
},
{
"type": "null"
}
]
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"TaxiTrip": {
"additionalProperties": false,
"properties": {
"booking": {
"enum": [
"street_day",
"street_night",
"ehail_offpeak",
"ehail_peak",
"ehail_night"
],
"type": "string"
},
"distance_aed": {
"type": "number"
},
"km": {
"type": "number"
},
"minimum_aed": {
"type": "number"
},
"minimum_applied": {
"type": "boolean"
},
"starting_aed": {
"type": "number"
},
"surcharge_aed": {
"type": "number"
},
"to_sharjah": {
"type": "boolean"
},
"total_aed": {
"type": "number"
},
"wait_minutes": {
"type": "number"
},
"waiting_aed": {
"type": "number"
}
},
"required": [
"km",
"booking",
"wait_minutes",
"to_sharjah",
"starting_aed",
"distance_aed",
"waiting_aed",
"surcharge_aed",
"minimum_aed",
"minimum_applied",
"total_aed"
],
"type": "object"
},
"TimeRange": {
"additionalProperties": false,
"properties": {
"from": {
"type": "string"
},
"to": {
"type": "string"
}
},
"required": [
"from",
"to"
],
"type": "object"
},
"TollTariff": {
"additionalProperties": false,
"properties": {
"effective_on": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"emirate": {
"enum": [
"dubai",
"abu_dhabi",
"sharjah",
"ajman",
"umm_al_quwain",
"ras_al_khaimah",
"fujairah"
],
"type": "string"
},
"gate_count": {
"type": [
"integer",
"null"
]
},
"gates_named": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"opened_on": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"road": {
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"road",
"opened_on"
],
"type": "object"
},
"type": "array"
},
"notes": {
"items": {
"type": "string"
},
"type": "array"
},
"notice": {
"type": [
"string",
"null"
]
},
"operator_id": {
"enum": [
"salik",
"darb"
],
"type": "string"
},
"operator_name": {
"type": "string"
},
"paused_since": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"provenance": {
"$ref": "#/$defs/Provenance"
},
"schedule": {
"items": {
"additionalProperties": false,
"properties": {
"aed_per_crossing": {
"type": "number"
},
"days": {
"enum": [
"mon_sat",
"sun"
],
"type": "string"
},
"hours": {
"items": {
"$ref": "#/$defs/TimeRange"
},
"type": "array"
},
"period": {
"enum": [
"peak",
"off_peak",
"late_night"
],
"type": "string"
}
},
"required": [
"days",
"period",
"hours",
"aed_per_crossing"
],
"type": "object"
},
"type": "array"
},
"status": {
"enum": [
"ok",
"paused"
],
"type": "string"
}
},
"required": [
"operator_id",
"operator_name",
"emirate",
"status",
"notice",
"paused_since",
"effective_on",
"gate_count",
"gates_named",
"schedule",
"notes",
"provenance"
],
"type": "object"
},
"TollTariffListResponse": {
"additionalProperties": false,
"properties": {
"context": {
"$ref": "#/$defs/TransportReferenceContext"
},
"data": {
"items": {
"$ref": "#/$defs/TollTariff"
},
"type": "array"
},
"links": {
"$ref": "#/$defs/Links"
},
"meta": {
"$ref": "#/$defs/ResponseMeta"
}
},
"required": [
"meta",
"data",
"links"
],
"type": "object"
},
"ToolFailure": {
"additionalProperties": false,
"properties": {
"error": {
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"retry_after_s": {
"type": [
"integer",
"null"
]
},
"retryable": {
"type": "boolean"
}
},
"required": [
"code",
"message",
"retryable",
"retry_after_s"
],
"type": "object"
},
"request_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"error",
"request_id"
],
"type": "object"
},
"TransportReferenceContext": {
"additionalProperties": true,
"required": [
"fuel"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"$ref": "#/$defs/TaxiFaresResponse"
},
{
"$ref": "#/$defs/PublicTransportFareListResponse"
},
{
"$ref": "#/$defs/ParkingTariffsResponse"
},
{
"$ref": "#/$defs/TollTariffListResponse"
},
{
"$ref": "#/$defs/ToolFailure"
}
],
"type": "object"
}
}
]
}Verify it yourself
curl -s https://api.teppi.xyz/v1/evidence/sha256:5bc2e51e893b653602a2017235e16a053ddf0370f2c152b8bab7cd44dca6501a | sha256sum