Fibre Compare

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['postcode'], 'properties': {'sort': {'enum': ['recommended', 'value', 'price', 'speed', 'site'], 'type': 'string', 'description': "Ordering: 'recommended' (default; fibrecompare.com's editorial ranking), 'value' (cheapest effective monthly cost), 'price' (cheapest headline monthly cost), 'speed' (fastest first) or 'site' (backend order)."}, 'uprn': {'type': 'string', 'description': 'Unique Property Reference Number for the exact premises, if known. Gives an address-level rather than postcode-level answer.'}, 'limit': {'type': 'integer', 'maximum': 100, 'minimum': 1, 'description': 'Maximum number of deals to return (default 5). The full list is always available at view_more_url.'}, 'udprn': {'type': 'string', 'description': 'Royal Mail Unique Delivery Point Reference Number, if known and no UPRN is available.'}, 'address': {'type': 'string', 'maxLength': 120, 'description': "House number/name and optionally street, e.g. '12', 'Flat 3, 12', 'Rose Cottage'. If it matches one premises at the postcode the check is done at address level in this same call."}, 'postcode': {'type': 'string', 'maxLength': 10, 'minLength': 5, 'description': "UK postcode to check, e.g. 'SW1A 1AA'. Spacing and case do not matter."}, 'provider': {'type': 'string', 'description': "Only return deals from providers whose name contains this text, e.g. 'BT', 'Hyperoptic'."}, 'visitor_id': {'type': 'string', 'maxLength': 20, 'description': 'The visitor_id from a previous result in this conversation. Reuse it so checks and deal clicks are attributed to the same visit. Omit on the first call.'}, 'address_key': {'type': 'string', 'description': "An address_key from a previous result's addresses list. Runs the check for that exact premises."}, 'min_download_mbps': {'type': 'number', 'minimum': 0, 'description': 'Only return deals whose average download speed is at least this many Mbps (e.g. 100, 500, 900).'}, 'max_contract_months': {'type': 'integer', 'minimum': 0, 'description': 'Only return deals with a contract of at most this many months (0 = rolling/no contract).'}, 'max_monthly_cost_gbp': {'type': 'number', 'minimum': 0, 'description': 'Only return deals costing at most this much per month in GBP.'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['postcode', 'address_level', 'total_deals', 'returned_deals', 'deals', 'view_more_url'], 'properties': {'uprn': {'type': 'string'}, 'deals': {'type': 'array', 'items': {'type': 'object', 'required': ['product_id', 'provider', 'name', 'title', 'technology', 'average_download_mbps', 'estimated_speed', 'data_allowance_gb', 'speed_class', 'monthly_cost_gbp', 'monthly_cost_after_contract_gbp', 'setup_cost_gbp', 'initial_cost_gbp', 'initial_period_months', 'contract_length_months', 'effective_monthly_cost_gbp', 'first_year_cost_gbp', 'total_contract_cost_gbp', 'cost_basis', 'pricing_summary', 'offer_ends', 'qualification', 'features', 'extras'], 'properties': {'name': {'type': 'string'}, 'title': {'type': 'string'}, 'extras': {'type': 'array', 'items': {'type': 'string'}}, 'deal_url': {'type': 'string'}, 'features': {'type': 'array', 'items': {'type': 'string'}}, 'provider': {'type': 'string'}, 'cost_basis': {'enum': ['backend', 'estimated'], 'type': 'string', 'description': "Whether the cost figures come from fibrecompare's computed pricing (models price rises) or are a local estimate."}, 'offer_ends': {'type': ['string', 'null']}, 'product_id': {'type': 'number'}, 'technology': {'type': 'array', 'items': {'type': 'string'}}, 'speed_class': {'type': ['string', 'null']}, 'provider_slug': {'type': 'string'}, 'qualification': {'type': ['string', 'null']}, 'setup_cost_gbp': {'type': ['number', 'null']}, 'estimated_speed': {'type': ['string', 'null']}, 'pricing_summary': {'type': ['string', 'null']}, 'initial_cost_gbp': {'type': ['number', 'null']}, 'monthly_cost_gbp': {'type': ['number', 'null']}, 'data_allowance_gb': {'type': ['number', 'null']}, 'provider_logo_url': {'type': 'string'}, 'first_year_cost_gbp': {'type': ['number', 'null']}, 'average_download_mbps': {'type': ['number', 'null']}, 'initial_period_months': {'type': ['number', 'null']}, 'contract_length_months': {'type': ['number', 'null']}, 'provider_accent_colour': {'type': 'string'}, 'total_contract_cost_gbp': {'type': ['number', 'null']}, 'effective_monthly_cost_gbp': {'type': ['number', 'null']}, 'monthly_cost_after_contract_gbp': {'type': ['number', 'null']}}, 'additionalProperties': False}}, 'udprn': {'type': 'string'}, 'postcode': {'type': 'string'}, 'addresses': {'type': 'array', 'items': {'type': 'object', 'required': ['address_key', 'address'], 'properties': {'address': {'type': 'string'}, 'address_key': {'type': 'string'}}, 'additionalProperties': False}, 'description': "For postcode-level results: the premises at this postcode. Pass one's address_key back to get an exact-address check."}, 'visitor_id': {'type': 'string', 'description': 'Pass back as visitor_id on later calls in this conversation.'}, 'total_deals': {'type': 'number'}, 'address_level': {'enum': ['premises', 'postcode'], 'type': 'string'}, 'view_more_url': {'type': 'string', 'description': 'fibrecompare.com results page for this address, listing every available deal.'}, 'addresses_note': {'type': 'string'}, 'returned_deals': {'type': 'number'}, 'display_address': {'type': 'string'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'string', 'description': "A deal id returned by search (format '<postcode>|<product_id>')."}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id', 'title', 'text', 'url'], 'properties': {'id': {'type': 'string'}, 'url': {'type': 'string'}, 'text': {'type': 'string'}, 'title': {'type': 'string'}, 'metadata': {'type': 'object', 'additionalProperties': {}}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['query'], 'properties': {'query': {'type': 'string', 'description': "Free-text query containing a UK postcode, e.g. 'fibre deals at SW1A 1AA' or 'Hyperoptic EC2A 1AA'."}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['results'], 'properties': {'results': {'type': 'array', 'items': {'type': 'object', 'required': ['id', 'title', 'url'], 'properties': {'id': {'type': 'string'}, 'url': {'type': 'string'}, 'title': {'type': 'string'}}, 'additionalProperties': False}}}, 'additionalProperties': False}