---
updatedAt: 2026-03-31T12:12:41.000Z
agentTools:
  projectIndex: https://api.net2grid.com/llms.txt
---

# /homestate/current

Returns the current household's zone along with the timestamp when it first entered that zone.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "NET2GRID Customer Engagement API",
    "description": "This is the B2C NET2GRID API that can be used by mobile and web apps to manage the accounts and the data that are provided by the NET2GRID Meter Data Analytics Platform.",
    "version": "13.6.0"
  },
  "servers": [
    {
      "url": "http://api.net2grid.docker",
      "description": "API server"
    }
  ],
  "paths": {
    "/v2/homestate/current": {
      "get": {
        "tags": [
          "Edge Analytics and Alerts"
        ],
        "summary": "/homestate/current",
        "description": "Returns the current household's zone along with the timestamp when it first entered that zone.",
        "operationId": "v2getHomestateCurrent",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HomestateCurrentResponseDTO"
                },
                "examples": {
                  "Homestate Current": {
                    "$ref": "#/components/examples/GetHomestateCurrent"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid request<br/>153: No valid meter found for user\n    <br/>290: Current home state not found\n    <br/>999: Unspecified Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDTO"
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "HomestateCurrentDTO": {
        "required": [
          "current_zone",
          "since"
        ],
        "properties": {
          "current_zone": {
            "description": "The ID of the home state zone:\n0: Chill\n1: Normal\n2: High\n3: Hyper\n4: Unknown",
            "type": "integer",
            "enum": [
              0,
              1,
              2,
              3,
              4
            ]
          },
          "since": {
            "description": "Last change of current_zone in ISO-8601 format.",
            "type": "string"
          }
        },
        "type": "object"
      },
      "HomestateCurrentResponseDTO": {
        "required": [
          "status",
          "data"
        ],
        "properties": {
          "status": {
            "type": "string"
          },
          "data": {
            "$ref": "#/components/schemas/HomestateCurrentDTO"
          }
        },
        "type": "object"
      },
      "ErrorDTO": {
        "properties": {
          "code": {
            "type": "integer"
          },
          "message": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "ErrorResponseDTO": {
        "properties": {
          "status": {
            "type": "string"
          },
          "error": {
            "$ref": "#/components/schemas/ErrorDTO"
          }
        },
        "type": "object"
      }
    },
    "examples": {
      "GetHomestateCurrent": {
        "summary": "Homestate Current",
        "value": {
          "status": "ok",
          "data": {
            "current_zone": 2,
            "since": "1980-11-07T10:07:03+02:00"
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "bearerFormat": "JWT",
        "scheme": "bearer"
      }
    }
  },
  "tags": [
    {
      "name": "Edge Analytics and Alerts"
    }
  ],
  "x-explorer-enabled": false
}
```