Veritaset

{
  "type": "object",
  "required": [
    "country"
  ],
  "properties": {
    "limit": {
      "type": "number",
      "description": "Number of results, default 5, max 20."
    },
    "region": {
      "type": "string",
      "description": "Province, state or region (e.g. Wallonia, Friesland, Texas). Regional operators are matched on it."
    },
    "autopay": {
      "type": "boolean",
      "description": "US: false = the household won't use AutoPay / paperless billing; advertised AutoPay discounts are added back. Default true."
    },
    "country": {
      "enum": [
        "BE",
        "NL",
        "DE",
        "FR",
        "GB",
        "IT",
        "ES",
        "RO",
        "SI",
        "MT",
        "CY",
        "EE",
        "SK",
        "HU",
        "HR",
        "LV",
        "AT",
        "CH",
        "LU",
        "IS",
        "LI",
        "US",
        "BG",
        "CZ",
        "DK",
        "FI",
        "GR",
        "IE",
        "LT",
        "NO",
        "PL",
        "PT",
        "SE",
        "CA"
      ],
      "type": "string",
      "description": "Market, ISO 3166-1 alpha-2."
    },
    "wants_tv": {
      "type": "boolean"
    },
    "technology": {
      "enum": [
        "fibre",
        "cable",
        "dsl",
        "fwa",
        "satellite"
      ],
      "type": "string",
      "description": "Only offers sold on this technology."
    },
    "max_monthly": {
      "type": "number",
      "description": "Budget per month in the market's currency, averaged over the horizon."
    },
    "wants_mobile": {
      "type": "boolean",
      "description": "True if offers that include mobile lines may be shown."
    },
    "data_gb_month": {
      "type": "number",
      "description": "Monthly data use in GB; plans with a lower data cap don't fit (most US fixed plans state unlimited data)."
    },
    "horizon_months": {
      "type": "number",
      "description": "Months to average costs over. Default 24."
    },
    "unlimited_data": {
      "type": "boolean",
      "description": "True = only plans without a data cap."
    },
    "wants_landline": {
      "type": "boolean"
    },
    "accept_contract": {
      "type": "boolean",
      "description": "false = only offers without a minimum term."
    },
    "has_mobile_with": {
      "type": "string",
      "description": "Operator or group the household has mobile with (e.g. Telenet, Proximus, KPN); counts that operator's bundle discounts."
    },
    "max_term_months": {
      "type": "number",
      "description": "Longest minimum term accepted, in months."
    },
    "upload_mbps_min": {
      "type": "number",
      "description": "Minimum advertised upload speed in Mbps."
    },
    "download_mbps_min": {
      "type": "number",
      "description": "Minimum advertised download speed in Mbps."
    },
    "wants_mobile_with": {
      "type": "string",
      "description": "Operator the household would take mobile from as well; counts that operator's bundle discounts."
    },
    "special_eligibility": {
      "type": "boolean",
      "description": "True if the household qualifies for social tariffs or other restricted offers."
    }
  }
}

{
  "type": "object",
  "required": [
    "data_gb_month"
  ],
  "properties": {
    "age": {
      "type": "number",
      "description": "Only needed for youth and senior plans."
    },
    "limit": {
      "type": "number",
      "description": "Number of results, default 5, max 20."
    },
    "lines": {
      "type": "number",
      "description": "Number of lines (e.g. a family of 4). Default 1. Costs are then the total for all lines; each line has the data/minutes need above."
    },
    "travel": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "country"
        ],
        "properties": {
          "country": {
            "type": "string",
            "description": "Destination, ISO 3166-1 alpha-2 (e.g. FR, US, MA)."
          },
          "days_per_year": {
            "type": "number"
          },
          "data_gb_per_day": {
            "type": "number",
            "description": "Omit if unknown; don't guess it, since omitting it changes how the trip is ranked (see travel's description)."
          }
        }
      },
      "description": "Specific trips per year, when the person knows them. Takes precedence over travel_profile and roaming_gb_month. Omit all three if unknown (the result then lists travel under missing_inputs); pass [] if the person does not travel. A trip with both days_per_year and data_gb_per_day is costed exactly; a trip missing either (e.g. just the country) only requires the plan to offer roaming there — no size or cost is assumed."
    },
    "autopay": {
      "type": "boolean",
      "description": "false = the person won't use AutoPay; advertised AutoPay discounts are added back. Default true."
    },
    "country": {
      "enum": [
        "BE",
        "NL",
        "LU",
        "FR",
        "IS",
        "HU",
        "FI",
        "SI",
        "IE",
        "SK",
        "EE",
        "LV",
        "HR",
        "GR",
        "MT",
        "LI",
        "PT",
        "LT",
        "RO",
        "BG",
        "CY",
        "CZ",
        "NO",
        "SE",
        "AT",
        "PL",
        "IT",
        "DK",
        "GB",
        "CH",
        "ES",
        "DE",
        "US",
        "CA"
      ],
      "type": "string",
      "description": "Market, ISO 3166-1 alpha-2 (BE, NL, LU, FR, IS, HU, FI, SI, IE, SK, EE, LV, HR, GR, MT, LI, PT, LT, RO, BG, CY, CZ, NO, SE, AT, PL, IT, DK, GB, CH, ES, DE, US, CA). Prices are in that market's currency."
    },
    "network": {
      "enum": [
        "att",
        "verizon",
        "tmobile"
      ],
      "type": "string",
      "description": "US: the network the plan must run on, if the person asks for one. Plans where the customer picks the network at signup fit when it is one of the choices."
    },
    "needs_5g": {
      "type": "boolean"
    },
    "province": {
      "type": "string",
      "description": "Canada: the province or territory (name or code, e.g. Quebec, ON) where the line will be used. Plans whose source lists other provinces don't fit."
    },
    "sms_month": {
      "type": [
        "number",
        "null"
      ],
      "description": "National SMS per month; null = unlimited. Default 0. Plans that charge per SMS beyond their allowance are costed at the stated rate, so a rough figure is fine."
    },
    "needs_esim": {
      "type": "boolean"
    },
    "intl_minutes": {
      "type": "object",
      "description": "Calls a month to other countries, e.g. {\"MX\": 300}. Plans fit only if the source states those calls included or priced per minute.",
      "additionalProperties": {
        "type": "number"
      }
    },
    "data_gb_month": {
      "type": [
        "number",
        "string"
      ],
      "description": "Mobile data the person uses per month, in GB, or \"unlimited\"."
    },
    "minutes_month": {
      "type": [
        "number",
        "null"
      ],
      "description": "Minutes of calls a month you need; null = unlimited. Omit or 0 if you don't need calls."
    },
    "accept_prepaid": {
      "type": "boolean"
    },
    "horizon_months": {
      "type": "number",
      "description": "Months to average costs over, including promos. Default 12."
    },
    "travel_profile": {
      "enum": [
        "none",
        "eu_occasional",
        "eu_frequent"
      ],
      "type": "string",
      "description": "How the person travels, when they describe it loosely: eu_occasional or eu_frequent = EU travel with no stated amount. Only requires the plan to offer EU roaming; no trip size or cost is assumed. Give roaming_gb_month, or travel with days_per_year and data_gb_per_day, to cost a specific amount instead."
    },
    "accept_contract": {
      "type": "boolean",
      "description": "false = only plans without a minimum contract. Prepaid packs paid several months up front are not contracts (each result says so); use max_term_months to limit them."
    },
    "max_monthly_eur": {
      "type": "number",
      "description": "Budget per month in the market's currency (despite the name), as advertised; for all lines together."
    },
    "max_term_months": {
      "type": "number",
      "description": "Longest term the person accepts, in months: a contract or months paid up front (e.g. an annual prepaid pack). 1 = month to month only; 12, 24, 36… Omit for any."
    },
    "hotspot_gb_month": {
      "type": "number",
      "description": "Mobile hotspot (tethering) data needed per month, in GB. Plans that don't state enough hotspot data don't fit."
    },
    "roaming_gb_month": {
      "type": "number",
      "description": "Optional EU roaming need in GB per month; omit if unknown."
    },
    "travels_outside_eu": {
      "type": "boolean",
      "description": "True if the person sometimes travels outside the EU. Each result then lists the plan's own options there (passes, included countries, pay-per-use rate) without costing a specific trip."
    },
    "special_eligibility": {
      "type": "boolean",
      "description": "True if the person qualifies for offers limited to some customers (students, social tariffs, porting from a named operator, existing customers of another service). Default false: such plans are listed as not fitting, with the condition."
    },
    "has_home_internet_with": {
      "type": "string",
      "description": "Operator group the person has home internet with (e.g. Proximus, Orange or Telenet in Belgium), which unlocks bundle prices."
    }
  }
}

{
  "type": "object",
  "properties": {
    "age": {
      "type": "number",
      "description": "Only needed for youth and senior plans."
    },
    "limit": {
      "type": "number",
      "description": "Number of results, default 5, max 20."
    },
    "lines": {
      "type": "number",
      "description": "Number of lines (e.g. a family of 4). Default 1. Costs are then the total for all lines; each line has the data/minutes need above."
    },
    "autopay": {
      "type": "boolean",
      "description": "false = the person won't use AutoPay; advertised AutoPay discounts are added back. Default true."
    },
    "country": {
      "enum": [
        "BE",
        "NL",
        "LU",
        "FR",
        "IS",
        "HU",
        "FI",
        "SI",
        "IE",
        "SK",
        "EE",
        "LV",
        "HR",
        "GR",
        "MT",
        "LI",
        "PT",
        "LT",
        "RO",
        "BG",
        "CY",
        "CZ",
        "NO",
        "SE",
        "AT",
        "PL",
        "IT",
        "DK",
        "GB",
        "CH",
        "ES",
        "DE",
        "US",
        "CA"
      ],
      "type": "string",
      "description": "Market, ISO 3166-1 alpha-2 (BE, NL, LU, FR, IS, HU, FI, SI, IE, SK, EE, LV, HR, GR, MT, LI, PT, LT, RO, BG, CY, CZ, NO, SE, AT, PL, IT, DK, GB, CH, ES, DE, US, CA). Prices are in that market's currency."
    },
    "needs_5g": {
      "type": "boolean"
    },
    "province": {
      "type": "string",
      "description": "Canada: the province or territory (name or code, e.g. Quebec, ON) where the line will be used. Plans whose source lists other provinces don't fit."
    },
    "needs_esim": {
      "type": "boolean"
    },
    "usage_daily": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "date"
        ],
        "properties": {
          "date": {
            "type": "string",
            "description": "YYYY-MM-DD"
          },
          "country": {
            "type": "string",
            "description": "Two-letter code where it was used, if abroad; omit at home."
          },
          "data_gb": {
            "type": "number"
          },
          "data_mb": {
            "type": "number",
            "description": "Mobile data used, MB (or give data_gb)."
          },
          "minutes": {
            "type": "number",
            "description": "Outgoing national call minutes."
          }
        }
      },
      "description": "Alternative to usage_months: usage per day (or per session) as read from the operator's download, e.g. a usage specification. Veritaset adds it up per calendar month and leaves out months the download only partly covers. Numbers only."
    },
    "usage_months": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "data_gb": {
            "type": "number",
            "description": "Mobile data used that month, GB."
          },
          "minutes": {
            "type": "number",
            "description": "National call minutes that month."
          },
          "roaming": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "country",
                "days"
              ],
              "properties": {
                "days": {
                  "type": "number"
                },
                "country": {
                  "type": "string"
                },
                "data_gb": {
                  "type": "number"
                }
              }
            },
            "description": "Days abroad that month."
          }
        }
      },
      "description": "One entry per month, most recent first if known."
    },
    "travel_profile": {
      "enum": [
        "none",
        "eu_occasional",
        "eu_frequent"
      ],
      "type": "string",
      "description": "How the person travels, when they describe it loosely: eu_occasional or eu_frequent = EU travel with no stated amount. Only requires the plan to offer EU roaming; no trip size or cost is assumed. Give roaming_gb_month, or travel with days_per_year and data_gb_per_day, to cost a specific amount instead."
    },
    "accept_contract": {
      "type": "boolean",
      "description": "false = only plans without a minimum contract. Prepaid packs paid several months up front are not contracts (each result says so); use max_term_months to limit them."
    },
    "max_term_months": {
      "type": "number",
      "description": "Longest term the person accepts, in months: a contract or months paid up front (e.g. an annual prepaid pack). 1 = month to month only; 12, 24, 36… Omit for any."
    },
    "current_offer_id": {
      "type": "string",
      "description": "Veritaset offer_id of the current plan, if it can be identified (see get_mobile_plan_details / compare results)."
    },
    "hotspot_gb_month": {
      "type": "number",
      "description": "Mobile hotspot (tethering) data needed per month, in GB. Plans that don't state enough hotspot data don't fit."
    },
    "roaming_gb_month": {
      "type": "number",
      "description": "Optional EU roaming need in GB per month; omit if unknown."
    },
    "current_bundle_gb": {
      "type": "number",
      "description": "Data in the current plan per month, GB, if known: the result then says how often the person went over it and how much of it they use on average."
    },
    "current_plan_name": {
      "type": "string",
      "description": "Current operator and plan name as on the bill, e.g. 'Proximus Mobile Smart'."
    },
    "travels_outside_eu": {
      "type": "boolean",
      "description": "True if the person sometimes travels outside the EU. Each result then lists the plan's own options there (passes, included countries, pay-per-use rate) without costing a specific trip."
    },
    "current_price_month": {
      "type": "number",
      "description": "What the person pays per month today, in the market's currency as advertised, if the plan can't be identified."
    },
    "special_eligibility": {
      "type": "boolean",
      "description": "True if the person qualifies for offers limited to some customers (students, social tariffs, porting from a named operator, existing customers of another service). Default false: such plans are listed as not fitting, with the condition."
    },
    "has_home_internet_with": {
      "type": "string",
      "description": "Operator group the person has home internet with (e.g. Proximus, Orange or Telenet in Belgium), which unlocks bundle prices."
    }
  }
}

{
  "type": "object",
  "required": [
    "answer_id"
  ],
  "properties": {
    "client": {
      "type": "string",
      "description": "The agent or app name, as the agent declares it (not verified)."
    },
    "comment": {
      "type": "string",
      "maxLength": 500,
      "description": "Free text, up to 500 characters. Published; e-mail addresses, phone numbers and links are removed."
    },
    "accuracy": {
      "type": "integer",
      "maximum": 5,
      "minimum": 1,
      "description": "1–5: were the facts correct where checked?"
    },
    "coverage": {
      "type": "integer",
      "maximum": 5,
      "minimum": 1,
      "description": "1–5: were the relevant operators and plans included?"
    },
    "offer_id": {
      "type": "string",
      "description": "The plan or offer the feedback concerns, if any."
    },
    "answer_id": {
      "type": "string",
      "description": "The answer_id field of the Veritaset answer being rated."
    },
    "freshness": {
      "type": "integer",
      "maximum": 5,
      "minimum": 1,
      "description": "1–5: were the facts current?"
    },
    "usefulness": {
      "type": "integer",
      "maximum": 5,
      "minimum": 1,
      "description": "1–5: did the answer help with the question?"
    },
    "error_report": {
      "type": "object",
      "properties": {
        "seen": {
          "type": "string",
          "description": "What the agent saw on the operator's page."
        },
        "field": {
          "type": "string",
          "description": "e.g. price_month, data, roaming"
        },
        "offer_id": {
          "type": "string"
        },
        "source_url": {
          "type": "string",
          "description": "The operator page where it was seen."
        }
      },
      "description": "A suspected data error, reviewed by a person before any change."
    }
  }
}