api.invoket.com

{
  "properties": {
    "data": {
      "properties": {
        "co2": {
          "description": "Best-effort EU CO2 block (core of /vehicle/co2), keyed by the decoded make, model and model year — hence ALWAYS match_level 'model_year' with its p10/p90 dispersion: a European VIN carries no type-approval variant, a limit never worked around with a single figure. Model absent from the registry, year outside the ingested window or dataset not deployed: block out, motivated in coverage.missing, never an error of the report",
          "properties": {
            "co2": {
              "properties": {
                "low_sample": {
                  "type": "boolean"
                },
                "nedc": {
                  "type": "integer"
                },
                "sample_size": {
                  "type": "integer"
                },
                "unit": {
                  "type": "string"
                },
                "wltp": {
                  "properties": {
                    "p10": {
                      "type": "integer"
                    },
                    "p50": {
                      "type": "integer"
                    },
                    "p90": {
                      "type": "integer"
                    }
                  },
                  "required": [
                    "p50"
                  ],
                  "type": "object"
                }
              },
              "required": [
                "low_sample",
                "sample_size",
                "unit"
              ],
              "type": "object"
            },
            "coverage": {
              "type": "object"
            },
            "limits": {
              "description": "Reading limits of the CO2 figures, returned verbatim as on /vehicle/co2 (elided from this example only, to keep the 402 header small)",
              "type": "array"
            },
            "match_level": {
              "type": "string"
            },
            "provenance": {
              "properties": {
                "fetched_at": {
                  "type": "string"
                },
                "freshness": {
                  "properties": {
                    "as_of": {
                      "type": "string"
                    },
                    "kind": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "as_of",
                    "kind"
                  ],
                  "type": "object"
                },
                "source": {
                  "type": "string"
                }
              },
              "required": [
                "fetched_at",
                "freshness",
                "source"
              ],
              "type": "object"
            },
            "vehicle": {
              "properties": {
                "commercial_name": {
                  "type": "string"
                },
                "engine_capacity_cm3": {
                  "type": "integer"
                },
                "engine_power_kw": {
                  "type": "integer"
                },
                "fuel": {
                  "type": "string"
                },
                "make": {
                  "type": "string"
                },
                "mass_kg": {
                  "type": "integer"
                },
                "year": {
                  "type": "integer"
                }
              },
              "required": [
                "make"
              ],
              "type": "object"
            }
          },
          "required": [
            "co2",
            "match_level",
            "provenance",
            "vehicle"
          ],
          "type": "object"
        },
        "coverage": {
          "description": "Honest coverage of the secondary blocks: complete=false as soon as one is missing, each named with its reason — never an invented block, never a silent error. The tax costing is not listed here: that block is always present and carries its own coverage",
          "properties": {
            "complete": {
              "type": "boolean"
            },
            "missing": {
              "type": "array"
            }
          },
          "required": [
            "complete",
            "missing"
          ],
          "type": "object"
        },
        "critair": {
          "description": "Best-effort Crit'Air block (core and rules of /vehicle/critair): present as soon as the declared characteristics allow a class — a battery electric needs neither norm nor date — otherwise in coverage.missing with its reason, never a 5xx",
          "properties": {
            "critair_class": {
              "type": "string"
            },
            "derivation": {
              "properties": {
                "euro_norm": {
                  "type": "string"
                },
                "fuel": {
                  "type": "string"
                },
                "via": {
                  "type": "string"
                }
              },
              "required": [
                "fuel",
                "via"
              ],
              "type": "object"
            },
            "euro_norm": {
              "type": "string"
            },
            "first_registration": {
              "type": "string"
            },
            "fuel": {
              "type": "string"
            },
            "notes": {
              "description": "Modelling limits of the ZFE reference data, returned verbatim as on /vehicle/critair (elided from this example only, to keep the 402 header small)",
              "type": "string"
            },
            "provenance": {
              "properties": {
                "fetched_at": {
                  "type": "string"
                },
                "freshness": {
                  "properties": {
                    "as_of": {
                      "type": "string"
                    },
                    "kind": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "as_of",
                    "kind"
                  ],
                  "type": "object"
                },
                "source": {
                  "type": "string"
                }
              },
              "required": [
                "fetched_at",
                "freshness",
                "source"
              ],
              "type": "object"
            },
            "regulation": {
              "properties": {
                "as_of": {
                  "type": "string"
                },
                "reference": {
                  "type": "string"
                }
              },
              "required": [
                "as_of",
                "reference"
              ],
              "type": "object"
            },
            "vehicle_class": {
              "type": "string"
            },
            "zfe_restrictions": {
              "type": "array"
            }
          },
          "required": [
            "critair_class",
            "derivation",
            "fuel",
            "provenance",
            "regulation",
            "vehicle_class",
            "zfe_restrictions"
          ],
          "type": "object"
        },
        "recalls": {
          "description": "Best-effort recall block: candidate campaigns matched by the decoded make and model year, with its own multi-source provenance; listed in coverage.missing when it cannot be produced, never a 5xx",
          "properties": {
            "coverage": {
              "properties": {
                "complete": {
                  "type": "boolean"
                },
                "reason": {
                  "type": "string"
                },
                "sources": {
                  "items": {
                    "properties": {
                      "as_of": {
                        "type": "string"
                      },
                      "fresh": {
                        "type": "boolean"
                      },
                      "name": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "as_of",
                      "fresh",
                      "name"
                    ],
                    "type": "object"
                  },
                  "type": "array"
                }
              },
              "required": [
                "complete",
                "reason",
                "sources"
              ],
              "type": "object"
            },
            "make": {
              "type": "string"
            },
            "provenance": {
              "properties": {
                "fetched_at": {
                  "type": "string"
                },
                "freshness": {
                  "properties": {
                    "as_of": {
                      "type": "string"
                    },
                    "kind": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "as_of",
                    "kind"
                  ],
                  "type": "object"
                },
                "source": {
                  "type": "string"
                }
              },
              "required": [
                "fetched_at",
                "freshness",
                "source"
              ],
              "type": "object"
            },
            "recalls": {
              "items": {
                "properties": {
                  "campaign_id": {
                    "type": "string"
                  },
                  "component": {
                    "type": "string"
                  },
                  "match": {
                    "properties": {
                      "make": {
                        "type": "string"
                      },
                      "years": {
                        "properties": {
                          "from": {
                            "type": "integer"
                          },
                          "to": {
                            "type": "integer"
                          }
                        },
                        "required": [
                          "from",
                          "to"
                        ],
                        "type": "object"
                      }
                    },
                    "required": [
                      "make"
                    ],
                    "type": "object"
                  },
                  "published_at": {
                    "type": "string"
                  },
                  "remedy": {
                    "type": "string"
                  },
                  "source": {
                    "type": "string"
                  },
                  "summary": {
                    "type": "string"
                  },
                  "url": {
                    "type": "string"
                  }
                },
                "required": [
                  "campaign_id",
                  "match",
                  "source",
                  "summary"
                ],
                "type": "object"
              },
              "type": "array"
            },
            "total": {
              "type": "integer"
            },
            "truncated": {
              "type": "boolean"
            },
            "vin": {
              "type": "object"
            },
            "year": {
              "type": "integer"
            }
          },
          "required": [
            "coverage",
            "make",
            "provenance",
            "recalls"
          ],
          "type": "object"
        },
        "registration_tax": {
          "description": "French registration tax block (core of /vehicle/tax), ALWAYS present with its own closed coverage: 'computed' (items, brackets, exemptions by article, total_eur) or 'insufficient_inputs' naming what is missing — never a partial total. Technical figures come from the CO2 block; add 'region' and 'fiscal_power' to the query for a costing ('registration_date' defaults to 'first_registration', else today; country implicitly FR)",
          "properties": {
            "coverage": {
              "type": "string"
            },
            "missing_inputs": {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "reason": {
              "type": "string"
            },
            "total_eur": {
              "description": "Sum of the tax items, on the computed branch only — and absent there too as soon as one item is undetermined: a partial total would be a wrong figure",
              "type": "number"
            }
          },
          "required": [
            "coverage"
          ],
          "type": "object"
        },
        "vin_decode": {
          "description": "Mandatory base block: the full VIN decode (/vehicle/vin/decode) with its own vPIC provenance",
          "properties": {
            "attributes": {
              "properties": {
                "Model": {
                  "type": "string"
                }
              },
              "required": [
                "Model"
              ],
              "type": "object"
            },
            "check_digit_valid": {
              "type": "boolean"
            },
            "country": {
              "type": "string"
            },
            "coverage": {
              "properties": {
                "complete": {
                  "type": "boolean"
                },
                "reason": {
                  "type": "string"
                }
              },
              "required": [
                "complete"
              ],
              "type": "object"
            },
            "make": {
              "type": "string"
            },
            "manufacturer": {
              "type": "string"
            },
            "model_year": {
              "type": "integer"
            },
            "model_year_ambiguous": {
              "type": "boolean"
            },
            "provenance": {
              "properties": {
                "fetched_at": {
                  "type": "string"
                },
                "freshness": {
                  "properties": {
                    "as_of": {
                      "type": "string"
                    },
                    "kind": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "as_of",
                    "kind"
                  ],
                  "type": "object"
                },
                "source": {
                  "type": "string"
                }
              },
              "required": [
                "fetched_at",
                "freshness",
                "source"
              ],
              "type": "object"
            },
            "region": {
              "type": "string"
            },
            "vin": {
              "type": "string"
            },
            "wmi": {
              "type": "string"
            }
          },
          "required": [
            "check_digit_valid",
            "coverage",
            "manufacturer",
            "provenance",
            "vin",
            "wmi"
          ],
          "type": "object"
        }
      },
      "required": [
        "coverage",
        "registration_tax",
        "vin_decode"
      ],
      "type": "object"
    },
    "provenance": {
      "properties": {
        "fetched_at": {
          "type": "string"
        },
        "freshness": {
          "properties": {
            "as_of": {
              "type": "string"
            },
            "kind": {
              "type": "string"
            }
          },
          "required": [
            "as_of",
            "kind"
          ],
          "type": "object"
        },
        "source": {
          "type": "string"
        }
      },
      "required": [
        "fetched_at",
        "freshness",
        "source"
      ],
      "type": "object"
    }
  },
  "required": [
    "data",
    "provenance"
  ],
  "type": "object"
}