Eliq · Schema

FilterResponse

EnergyUtilitiesAnalyticsSustainabilityEnergy DataSmart MeterDisaggregationForecastingSegmentationConsumptionTariffsInsights

Properties

Name Type Description
summary object
locations arraynull
paging object
View JSON Schema on GitHub

JSON Schema

eliq-filter-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/eliq/main/json-schema/eliq-filter-response-schema.json",
  "title": "FilterResponse",
  "x-generated": "2026-10-20",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/eliq-locationsegmentation-api-openapi.yml#/components/schemas/FilterResponse",
  "type": "object",
  "properties": {
    "summary": {
      "$ref": "#/$defs/Summary"
    },
    "locations": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/$defs/FilterResponseItem"
      }
    },
    "paging": {
      "$ref": "#/$defs/Paging"
    }
  },
  "additionalProperties": false,
  "$defs": {
    "Assets": {
      "type": "object",
      "properties": {
        "electricVehicle": {
          "$ref": "#/$defs/ElectricVehicle"
        },
        "tariff": {
          "$ref": "#/$defs/Tariffs"
        },
        "pvDetails": {
          "$ref": "#/$defs/PvDetails"
        },
        "heatingDetails": {
          "$ref": "#/$defs/HeatingDetails"
        },
        "battery": {
          "$ref": "#/$defs/Battery"
        }
      },
      "additionalProperties": false
    },
    "Battery": {
      "type": "object",
      "properties": {
        "score": {
          "type": "number",
          "format": "double"
        }
      },
      "additionalProperties": false
    },
    "ElectricVehicle": {
      "type": "object",
      "properties": {
        "chargedKwh": {
          "type": "number",
          "format": "double"
        },
        "chargedPowerKw": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "number",
            "format": "double"
          }
        },
        "confidence": {
          "type": [
            "number",
            "null"
          ],
          "format": "double"
        }
      },
      "additionalProperties": false
    },
    "FilterResponseItem": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32"
        },
        "assets": {
          "$ref": "#/$defs/Assets"
        },
        "consumptionKwh": {
          "type": [
            "number",
            "null"
          ],
          "format": "double"
        },
        "totalGridImportKwh": {
          "type": [
            "number",
            "null"
          ],
          "format": "double"
        },
        "totalGridExportKwh": {
          "type": [
            "number",
            "null"
          ],
          "format": "double"
        },
        "locationExtRef": {
          "type": [
            "string",
            "null"
          ]
        },
        "userId": {
          "type": [
            "integer",
            "null"
          ],
          "format": "int32"
        },
        "userExtRef": {
          "type": [
            "string",
            "null"
          ]
        },
        "fromDate": {
          "type": "string",
          "format": "date"
        },
        "toDate": {
          "type": "string",
          "format": "date"
        }
      },
      "additionalProperties": false
    },
    "HeatingDetails": {
      "type": "object",
      "properties": {
        "estimatedGasHeatingKwh": {
          "type": [
            "number",
            "null"
          ],
          "format": "double"
        },
        "estimatedElecHeatingKwh": {
          "type": [
            "number",
            "null"
          ],
          "format": "double"
        },
        "primaryHeatingFuel": {
          "type": [
            "string",
            "null"
          ]
        },
        "otherHeatingFuels": {
          "$ref": "#/$defs/HeatingFuelFlags"
        }
      },
      "additionalProperties": false
    },
    "HeatingFuelFlags": {
      "type": "object",
      "properties": {
        "elec": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "gas": {
          "type": [
            "boolean",
            "null"
          ]
        }
      },
      "additionalProperties": false
    },
    "Paging": {
      "type": "object",
      "properties": {
        "currentPage": {
          "type": "integer",
          "format": "int32"
        },
        "pages": {
          "type": "integer",
          "format": "int32"
        },
        "pageSize": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "PvDetails": {
      "type": "object",
      "properties": {
        "estimatedProductionKwh": {
          "type": [
            "number",
            "null"
          ],
          "format": "double"
        },
        "selfConsumptionPercentage": {
          "type": [
            "number",
            "null"
          ],
          "format": "double"
        },
        "detectionSource": {
          "$ref": "#/$defs/PvDetectionSource"
        },
        "confidence": {
          "type": [
            "number",
            "null"
          ],
          "format": "double"
        }
      },
      "additionalProperties": false
    },
    "PvDetectionSource": {
      "enum": [
        "disaggregation",
        "import_regression"
      ],
      "type": "string"
    },
    "Summary": {
      "type": "object",
      "properties": {
        "totalLocations": {
          "type": "integer",
          "format": "int64"
        },
        "filteredLocations": {
          "type": "integer",
          "format": "int64"
        },
        "optimalTariffs": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/TariffCount"
          }
        },
        "electricVehicles": {
          "type": "integer",
          "format": "int64"
        },
        "pv": {
          "type": "integer",
          "format": "int64"
        },
        "gasHeating": {
          "type": "integer",
          "format": "int64"
        },
        "elecHeating": {
          "type": "integer",
          "format": "int64"
        },
        "battery": {
          "type": "integer",
          "format": "int64"
        }
      },
      "additionalProperties": false
    },
    "TariffCount": {
      "type": "object",
      "properties": {
        "tariffId": {
          "type": [
            "string",
            "null"
          ]
        },
        "count": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "TariffSummary": {
      "type": "object",
      "properties": {
        "tariffId": {
          "type": [
            "string",
            "null"
          ]
        },
        "tariffName": {
          "type": [
            "string",
            "null"
          ]
        },
        "annualSavings": {
          "type": "number",
          "format": "double"
        },
        "annualCosts": {
          "type": "number",
          "format": "double"
        }
      },
      "additionalProperties": false
    },
    "Tariffs": {
      "type": "object",
      "properties": {
        "optimalTariff": {
          "$ref": "#/$defs/TariffSummary"
        }
      },
      "additionalProperties": false
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/eliq-filter-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.