Get User Me

Get the current user

GET / v4 / me

Get the current user

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Responses

Successful Response

version string

OpenElectricity API version that produced this response.

created_at string (date-time)

UTC timestamp when this response was produced.

success boolean default: true

`true` if the request succeeded. Errors set this to `false` and populate `error`.

error string | null

Human-readable error message when `success` is `false`. `null` on success.

data object required

Public-facing user profile for /v4/me

total_records integer | null

Total number of records in `data` when paginated; `null` when not applicable.

curl --request GET \
  --url "https://api.openelectricity.org.au/v4/me" \
  --header "Authorization: Bearer YOUR_API_KEY"

const res = await fetch("https://api.openelectricity.org.au/v4/me", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY"
  },
});
const data = await res.json();

import requests

headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}

r = requests.get("https://api.openelectricity.org.au/v4/me", headers=headers)
r.raise_for_status()
data = r.json()

{
  "version": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "success": true,
  "error": "<string>",
  "data": {
    "id": "<string>",
    "full_name": "<string>",
    "email": "<string>",
    "plan": "COMMUNITY",
    "roles": [],
    "is_admin": true,
    "rate_limit": {
      "limit": 123,
      "remaining": 123,
      "reset": "2023-11-07T05:31:56Z"
    },
    "credits": {
      "remaining": 123,
      "reset": "2023-11-07T05:31:56Z"
    }
  },
  "total_records": 123
}

Edit this page