RESTful Sensor with GraphQL payload

Elgaker · October 6, 2021, 9:07am

I’m trying to configure a RESTful Sensor that pulls data from a service that consumes Graphql queries. As far as I can tell the service returns an error which leads me to assume that the query (in the payload) is not formatted correctly. The same query works fine from other tools.

My configuration:

sensor:
  - platform: rest
    name: Tibber prices
    resource: https://api.tibber.com/v1-beta/gql
    method: POST
    payload: "{ viewer { homes { currentSubscription { priceInfo { today { total startsAt }}}}}}"
    json_attributes_path: "$.data.viewer.homes[0].currentSubscription.priceInfo"
    json_attributes: 
      - today
    value_template: Ok
    headers:
      Authorization: !secret tibber_token
      Content-Type: application/json
      User-Agent: REST

The log gives me this:

2021-10-06 08:13:02 DEBUG (MainThread) [homeassistant.components.rest.sensor] Data fetched from resource: {“error”:“syntax error”}
2021-10-06 08:13:02 WARNING (MainThread) [homeassistant.components.rest.sensor] JSON result was not a dictionary or list with 0th element a dictionary

Please advice

koying · October 6, 2021, 10:57am

Prove it with curl

According to https://graphql.org/learn/serving-over-http/ , graphql with POST should use proper JSON, not the GQL syntax.

Elgaker · October 6, 2021, 11:34am

Many thanks @koying , changing the post body to proper JSON solved the problem.

payload: ‘{ “query”: “{ viewer { homes { currentSubscription { priceInfo { today { total startsAt }}}}}}” }’

You saved my day!

Danielhiversen · October 7, 2021, 11:52am

Why not use the Tibber integration? Tibber - Home Assistant

Elgaker · November 3, 2021, 8:56pm

@Danielhiversen, as far as I understand the Tibber integration delivers the prices in “real time” as a sensor. Using the method above I’m able to load future prices for the whole day and plot them in advance like below.

Mario2 · November 17, 2021, 8:32pm

Thanks a lot!

I’ve been looking for a nice way to solve this. Future price is quite handy when planning when to consume power the coming day.

magnus.overli · December 15, 2021, 12:14pm

How do you get the price data represented in HA? I get a proper sensor that only holds the state OK (value_template)…

magnus.overli · December 17, 2021, 8:44am

I get the following log message: [homeassistant.components.rest.sensor] JSON result was not a dictionary or list with 0th element a dictionary

I do get a proper response from the API using this curl command:
curl -H "Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" -H "Content-Type: application/json" -X POST -d '{ "query": "{viewer {homes {currentSubscription {priceInfo {current {total energy tax startsAt }}}}}}" }' https://api.tibber.com/v1-beta/gql

Any ideas?

koying · December 17, 2021, 2:04pm

And what is it?

magnus.overli · December 17, 2021, 7:39pm

Yeah, sorry about that…

The response looks like this: {“data”:{“viewer”:{“homes”:[{“currentSubscription”:{“priceInfo”:{“current”:{“total”:2.5427,“energy”:2.0262,“tax”:0.5165,“startsAt”:“2021-12-17T09:00:00.000+01:00”}}}}]}}}`

koying · December 18, 2021, 9:42am

And what is your actual sensor definition?
Should work with the OP definition (after fixing the payload).

magnus.overli · December 18, 2021, 9:53pm

Here is the sensor config:

- platform: rest
  name: Tibber prices
  resource: https://api.tibber.com/v1-beta/gql
  method: POST
  payload: '{ “query”: “{ viewer { homes { currentSubscription { priceInfo { today { total startsAt }}}}}}” }'
  json_attributes_path: "$.data.viewer.homes[0].currentSubscription.priceInfo"
  json_attributes: 
    - today
  value_template: Ok
  headers:
    Authorization: !secret tibber_token
    Content-Type: application/json
    User-Agent: REST

koying · December 19, 2021, 12:00am

Oh, misunderstood you I think.
If you want the price as sensor state, you have to adapt value_template to extract it.

Bazillion examples in the forum and in the doc.

magnus.overli · December 20, 2021, 8:36am

Ahhh… OK.
Do I then have to create one sensor for each hour into the future?

intose · August 20, 2022, 2:01pm

I have been struggeling with this and get the same error in the logs, any idea as to what I am doing wrong?

My config

- platform: rest
    name: Elpris idag
    resource: https://api.tibber.com/v1-beta/gql
    method: POST
    payload: "{ 'query': '{ viewer { homes { currentSubscription { priceInfo { today { total startsAt }}}}}}' }"
    json_attributes_path: "$.data.viewer.homes[0].currentSubscription.priceInfo"
    json_attributes:
      - today
    value_template: Ok
    headers:
      Authorization: !secret tibber_token
      Content-Type: application/json
      User-Agent: REST

stefanschoemaker · October 13, 2022, 9:35am

I know this an old topic, but wanted to post here anyway. The following configuration is working for me:

in configuration.yaml create

rest: !include rest.yaml

rest.yaml

- resource: https://api.tibber.com/v1-beta/gql
  method: POST
  payload: '{ "query": "{ viewer { homes { currentSubscription { priceInfo { current { total energy tax startsAt }}}}}}" }'
  headers:
    Authorization: !secret tibber_api
    Content-Type: application/json
    User-Agent: REST
  sensor:
    - name: "Tibber energieprijs huidig"
      json_attributes_path: "$.data.viewer.homes[0].currentSubscription.priceInfo.current"
      value_template: "{{ value_json.data.viewer.homes[0].currentSubscription.priceInfo.current.total | float }}"
      json_attributes:
        - total
        - energy
        - tax
        - startsAt
      unit_of_measurement: EUR/kWh
      device_class: monetary
      state_class: measurement

Mariusthvdb · October 14, 2022, 2:33pm

finally I found a thread on graphQL… but I am still stuck

trying to configure a rest sensor for this Query and following https://graphql.org/learn/serving-over-http/#post-request:

query MarketPrices {
    marketPricesElectricity(startDate: "2021-10-01", endDate: "2021-10-30") {
    till
    from
    marketPrice
    priceIncludingMarkup
    }
    marketPricesGas(startDate: "2021-10-01", endDate: "2021-10-30") {
    from
    till
    marketPrice
    priceIncludingMarkup
  }
}

see: Get Frank Energie prices with Python and GraphQL

All I can stumble my way through is:

sensor:

  - platform: rest
    resource: https://graphcdn.frankenergie.nl
    name: Frank energie prijzen
    value_template: "ok"
    method: POST
#     params:
#       startDate: >
#         {{(now().strftime('%Y-%m-%d')}}
#       endDate: >
#         {{(now()+ timedelta(days=+1)).strftime('%Y-%m-%d')}}
    payload: >-
      {
        "query": "MarketPrices",
        "operationName": "marketPricesElectricity",
        "variables": { "startDate": "2022-10-13", "endDate":"2022-10-14"  }
      }

but that leaves out all the attributes

so I should maybe try

  - platform: rest
    resource: https://graphcdn.frankenergie.nl
    name: Frank energie prijzen
    value_template: "ok"
    method: POST
#     params:
#       startDate: >
#         {{(now().strftime('%Y-%m-%d')}}
#       endDate: >
#         {{(now()+ timedelta(days=+1)).strftime('%Y-%m-%d')}}
    payload: >-
      {
        "query": "MarketPrices",
        "operationName": "marketPricesElectricity",
        "variables": { "startDate": "2022-10-13", "endDate":"2022-10-14"  }
      }
    json_attributes:
      - from
      - till
      - marketPrice
      - priceIncludingMarkup

but would still need a path .

Please have a look if you can help me out, or at least get things going?
thanks!

xned · November 24, 2022, 6:54am

Looking to do something similar, would you care to share your sensor and what dashbord card you are using for representation?

xned · November 24, 2022, 6:57am

Nevermind, you start the thread with the sensor, to early and to little coffee