envoy_curl_queries.sh

#!/bin/bash

#This script requires a valid Java Web Token (JWT) for your Enphase Envoy.
#It creates a header file with the JWT in it and saves it in a file called 'header'
#in the directory that the script was started from. It is inserted into the curl query with
#the '-H @header' option in the curl query where the information afte the @ is the filename.

#It queries all available API endpoints on the envoy and returns the data to standard out.
#You can use one or a combination of these queries as you see fit, I have only included them
#all in this script as a proof of concept.

#Refer to https://enphase.com/download/iq-gateway-access-using-local-apis-or-local-ui-token-based-authentication-tech-brief
#for further details. Above link valid as of June of 2024.


#Variables#

envoy='' #either the ip or FQDN of your envoy
jwt_location='' #path to active envoy access token

#Create header for curl command#
jwt=`cat $jwt_location`
file=`echo "Authorization: Bearer $jwt" > header`

#Query all API endpoints

echo ivp meters
curl -s -f -k -H 'Accept: application/json' -H @header -X GET https://$envoy/ivp/meters
echo ivp meters readings
curl -s -f -k -H 'Accept: application/json' -H @header -X GET https://$envoy/ivp/meters/readings
echo api v1 production inverters
curl -s -f -k -H 'Accept: application/json' -H @header -X GET https://$envoy/api/v1/production/inverters
echo ivp livedata status
curl -s -f -k -H 'Accept: application/json' -H @header -X GET https://$envoy/ivp/livedata/status
echo ivp meters reports consumption
curl -s -f -k -H 'Accept: application/json' -H @header -X GET https://$envoy/ivp/meters/reports/consumption
echo production.json
curl -s -f -k -H 'Accept: application/json' -H @header -X GET https://$envoy/production.json

rm header