EmissionsResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/freightutils-com/json-schema/freightutils-com-emissions-response-schema.json",
  "title": "EmissionsResponse",
  "description": "Freight emissions result. available:true carries inputs/tonne_km/factor/emissions/_source; available:false carries message/available_for. methodology + disclaimer are always present.",
  "x-generated": "2026-11-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/freightutils-com-openapi.json#/components/schemas/EmissionsResponse",
  "type": "object",
  "properties": {
    "available": {
      "type": "boolean"
    },
    "methodology": {
      "type": "string"
    },
    "disclaimer": {
      "type": "string"
    },
    "inputs": {
      "type": "object",
      "properties": {
        "mass": {
          "type": "number"
        },
        "mass_unit": {
          "type": "string"
        },
        "mass_tonnes": {
          "type": "number"
        },
        "distance_km": {
          "type": "number"
        },
        "mode": {
          "type": "string"
        },
        "sub_mode": {
          "type": "string"
        },
        "region": {
          "type": "string"
        },
        "basis": {
          "type": "string"
        }
      }
    },
    "tonne_km": {
      "type": "number"
    },
    "factor": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "mode": {
          "type": "string"
        },
        "sub_mode": {
          "type": "string"
        },
        "authority": {
          "type": "string"
        },
        "edition": {
          "type": "string"
        },
        "region": {
          "type": "string"
        },
        "unit": {
          "type": "string"
        },
        "wtw": {
          "type": [
            "number",
            "null"
          ]
        },
        "ttw": {
          "type": [
            "number",
            "null"
          ]
        },
        "fu_id": {
          "$ref": "#/$defs/FuId"
        },
        "fu_version_id": {
          "$ref": "#/$defs/FuVersionId"
        }
      }
    },
    "emissions": {
      "type": "object",
      "properties": {
        "wtw_kgco2e": {
          "type": [
            "number",
            "null"
          ]
        },
        "ttw_kgco2e": {
          "type": [
            "number",
            "null"
          ]
        },
        "primary_kgco2e": {
          "type": "number"
        },
        "basis_used": {
          "type": "string"
        }
      }
    },
    "summary": {
      "type": "string",
      "description": "Primary human-readable one-line result — carries the empty-running + actual-gross-mass notes and, for sea/air, a high-variance warning."
    },
    "mass_basis": {
      "type": "string",
      "description": "Mass basis the factor expects: always \"actual_gross_mass\" — not chargeable/volumetric weight."
    },
    "empty_running": {
      "type": "string",
      "description": "\"sector_average_included\" (fleet-average empty running already in the factor — do not add your own empty-return leg) or \"see_source\"."
    },
    "representativeness": {
      "type": "string",
      "description": "\"low\" for sea/air (high real-world variance by vessel/aircraft type, load, routing); \"medium\" for road/rail/inland."
    },
    "confidence": {
      "type": "string",
      "description": "Human-readable confidence label for representativeness."
    },
    "_source": {
      "type": "object",
      "description": "Citability envelope: ISO method + the exact open factor used.",
      "properties": {
        "type": {
          "type": "string"
        },
        "standard": {
          "type": "string"
        },
        "reference": {
          "type": "string"
        },
        "source_url": {
          "type": "string"
        },
        "computed_by": {
          "type": "string"
        },
        "factor": {
          "type": "object",
          "properties": {
            "authority": {
              "type": "string"
            },
            "edition": {
              "type": "string"
            },
            "value": {
              "type": "number"
            },
            "unit": {
              "type": "string"
            },
            "basis": {
              "type": "string"
            },
            "last_verified": {
              "type": "string",
              "description": "Date the factor was last verified against its cited source (YYYY-MM-DD)."
            },
            "source_url": {
              "type": "string"
            },
            "licence": {
              "type": "string"
            }
          }
        }
      }
    },
    "message": {
      "type": "string"
    },
    "available_for": {
      "type": "object",
      "properties": {
        "modes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "regions_for_mode": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "sub_modes": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "region": {
                "type": "string"
              },
              "id": {
                "type": "string"
              },
              "sub_mode": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  },
  "required": [
    "available",
    "methodology",
    "disclaimer"
  ],
  "$defs": {
    "FuId": {
      "type": "string",
      "pattern": "^fu:[a-z][a-z0-9-]*(?::(?:[A-Za-z0-9._~()+-]|%[0-9A-F]{2})+)+$",
      "description": "Stable, edition-free identifier of this record: fu:<namespace>:<segment>[:<segment>…]. A join key, the same in every edition, kept in an append-only ledger. Not a regulatory reference, a citation or a promise the content never changes. GET /api/resolve?q=<fu_id> returns it."
    },
    "FuVersionId": {
      "type": "string",
      "pattern": "^(fu:[a-z][a-z0-9-]*(?::(?:[A-Za-z0-9._~()+-]|%[0-9A-F]{2})+)+)@([A-Za-z0-9._-]+)$",
      "description": "The identifier of this edition's record: <fu_id>@<edition token>. Present only where the dataset has editions (ADR, HS, UN/LOCODE, airports, Incoterms, ADR codes, ICS2, emission factors); airlines, ULDs, containers, vehicles and pallets have none."
    }
  }
}