{"info":{"_postman_id":"d7f43af2-7b35-48f2-bbe6-95a369f7db2d","name":"Gridcap Public API","description":"

API requests served from

{{gridcap_url}}\n\n

Authorization

All API requests require your User ID and API key in the request's headers. For Example:

import requests\nurl = \"{{gridcap_url}}/resources/organizations\"\nheaders = {\"user_id\": \"{{user_id}}\", \"Authorization\": \"{{api_key}}\"}\nresponse = requests.request(\"GET\", url, headers=headers)\nprint(response.text)\n\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"11039492","collectionId":"d7f43af2-7b35-48f2-bbe6-95a369f7db2d","publishedId":"2s93zFWJdW","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-07-05T20:56:50.000Z"},"item":[{"name":"rto-updates/all","id":"05e7d8a6-f079-42eb-9853-f043c8e753ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{gridcap_url}}/rto-updates/all","description":"

Returns a list of RTO's with the following format:

{\n  \"analysis\": {},\n  \"id\": rto.item_id,\n  \"peakPercent\": rto.peak_percent,\n  \"rto\": rto.name,\n  \"shed\": rto.shed,\n }\n\n

\n","urlObject":{"path":["rto-updates","all"],"host":["{{gridcap_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"05e7d8a6-f079-42eb-9853-f043c8e753ca"},{"name":"rto-updates/meter/{meter_id}","id":"aa8ddd0a-3669-4aeb-a3e2-ff2d9c2c5199","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{gridcap_url}}/rto-updates/meter/{{meter_id}}","description":"

Return the shed status of the meter if it's defined, otherwise returns the shed value of the meter's RTO:

{\n  \"meter_id\": meter.relation_id,\n  \"rto_id\": rto.item_id,\n  \"shed\": (True, False or None)\n}\n\n

\n","urlObject":{"path":["rto-updates","meter","{{meter_id}}"],"host":["{{gridcap_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"aa8ddd0a-3669-4aeb-a3e2-ff2d9c2c5199"},{"name":"licenses/desdemandresponse/{id}","id":"48d0d70f-2ac6-4ac1-80da-8670f82707df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{gridcap_url}}/licenses/desdemandresponse/{{org_id}}","description":"

Returns the Niagara instance of the given organization in the \"message\" key and list of the organizations' meters in \"meters\" key:

{\n  \"message\": {\n    \"active\": niagara.active,\n    \"devices\": [\n      # list of niagara devices\n    ],\n    \"id\": niagara.item_id,\n    \"name\": niagara.name,\n  },\n  \"meters\": [\n      ## ... list of meters in the organization\n  ],\n}\n\n

\n","urlObject":{"path":["licenses","desdemandresponse","{{org_id}}"],"host":["{{gridcap_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"48d0d70f-2ac6-4ac1-80da-8670f82707df"},{"name":"meter-data/new/{org_id}/{meter_id}","id":"ac58c750-1a6b-48ec-8894-049fd628b85d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"timestamp\": 1688590275, \"value\": 150}"},"url":"{{gridcap_url}}/meter-data/new/{{org_id}}/{{meter_id}}","description":"

Returns 200 if data ingested without errors

\n","urlObject":{"path":["meter-data","new","{{org_id}}","{{meter_id}}"],"host":["{{gridcap_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ac58c750-1a6b-48ec-8894-049fd628b85d"},{"name":"meter-data/latest/{meter_id}","id":"8d5a1bf8-86ad-4d40-998a-e35dddeec801","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{gridcap_url}}/meter-data/latest/{{meter_id}}","description":"

Checks the past hour of data for the given meter and returns the most recent datapoint in the following format:

{\n  \"meterId\": meter_id,\n  \"timestamp\": 1676494800,\n  \"value\": 124.265,\n }\n\n

\n","urlObject":{"path":["meter-data","latest","{{meter_id}}"],"host":["{{gridcap_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8d5a1bf8-86ad-4d40-998a-e35dddeec801"},{"name":"organizations","id":"3446325e-5fd4-4b65-a0a1-80b71a3d8511","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{gridcap_url}}/organizations","description":"

Returns all organizations

[\n  {\n    \"org_id\": org.org_id,\n    \"name\": org.name,\n    \"address\": org.address,\n    \"timezone\": {\n      \"zone\": \"America/New_York\",\n      \"name\": \"EDT\",\n      \"offset\": -4,\n    },\n    \"is_portfolio\": org.is_portfolio,\n  },\n  # ...\n]\n\n

\n","urlObject":{"path":["organizations"],"host":["{{gridcap_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3446325e-5fd4-4b65-a0a1-80b71a3d8511"},{"name":"organization sites","id":"21e5bd57-3ba5-45c0-a1e7-c7ec4ef12ca3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{gridcap_url}}/organizations/{{org_id}}/sites","description":"

Returns all sites for the given organization

[\n  {\n    \"site_id\": site.site_id,\n    \"org_id\": site.org_id,\n    \"name\": site.name,\n    \"address\": site.address,\n    \"timezone\": {\n      \"zone\": \"America/New_York\",\n      \"name\": \"EDT\",\n      \"offset\": -4,\n    }\n   },\n   # ...\n]\n\n

\n","urlObject":{"path":["organizations","{{org_id}}","sites"],"host":["{{gridcap_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"21e5bd57-3ba5-45c0-a1e7-c7ec4ef12ca3"},{"name":"organization meters","id":"d4e86ba5-6ab0-476f-8364-078b1a47e641","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{gridcap_url}}/organizations/{{org_id}}/meters","description":"

Returns all meters for the given organization

[\n  {\n    \"meter_id\": meter.meter_id,\n    \"site_id\": meter.site_id,\n    \"org_id\": meter.org_id,\n    \"rto_id\": meter.rto_id,\n    \"name\": meter.name,\n    \"shed\": False,\n   },\n   # ...\n]\n\n

\n","urlObject":{"path":["organizations","{{org_id}}","meters"],"host":["{{gridcap_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d4e86ba5-6ab0-476f-8364-078b1a47e641"},{"name":"organization alarms","id":"329f37e8-7491-40d5-b1ad-858949e59a44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{gridcap_url}}/organizations/{{org_id}}/alarms","description":"

Returns all alarms for the given organization

[\n  {\n    \"alarm_id\": alarm.alarm_id,\n    \"device_id\": alarm.device_id,\n    \"org_id\": alarm.org_id,\n    \"trigger_name\": alarm.trigger_id,\n    \"status\": alarm.status,\n    \"level\": alarm.level,\n    \"message\": alarm.message,\n    \"created_on\": 1676494800,\n    \"last_update\": 1676494800,\n },\n # ...\n]\n\n

\n","urlObject":{"path":["organizations","{{org_id}}","alarms"],"host":["{{gridcap_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"329f37e8-7491-40d5-b1ad-858949e59a44"},{"name":"meter alarms","id":"149bbea7-9994-405b-a3b3-4c5a0f0dd7a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{gridcap_url}}/organizations/{{org_id}}/{{meter_id}}/alarms","description":"

Returns all alarms for the given meter

[\n  {\n    \"alarm_id\": alarm.alarm_id,\n    \"device_id\": alarm.device_id,\n    \"org_id\": alarm.org_id,\n    \"trigger_name\": alarm.trigger_id,\n    \"status\": alarm.status,\n    \"level\": alarm.level,\n    \"message\": alarm.message,\n    \"created_on\": 1676494800,\n    \"last_update\": 1676494800,\n },\n # ...\n]\n\n\n

\n","urlObject":{"path":["organizations","{{org_id}}","{{meter_id}}","alarms"],"host":["{{gridcap_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"149bbea7-9994-405b-a3b3-4c5a0f0dd7a7"},{"name":"site meters","id":"5bf660eb-53f7-4e10-b4cd-9b73831663db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{gridcap_url}}/organizations/{{org_id}}/{{site_id}}/meters","description":"

Returns all meters for the given site

[\n  {\n    \"meter_id\": meter.meter_id,\n    \"site_id\": meter.site_id,\n    \"org_id\": meter.org_id,\n    \"rto_id\": meter.rto_id,\n    \"name\": meter.name,\n    \"shed\": False,\n   },\n   # ...\n]\n\n\n

\n","urlObject":{"path":["organizations","{{org_id}}","{{site_id}}","meters"],"host":["{{gridcap_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5bf660eb-53f7-4e10-b4cd-9b73831663db"},{"name":"meter demand","id":"0289dc74-d86f-4693-ab1b-b6bc08caefa2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{gridcap_url}}/organizations/{{org_id}}/meters/{{meter_id}}/demand/{{period}}?start_date={{start_date}}&end_date={{end_date}}","description":"

Demand data for a given meter in a given range, summed by the given period.

Period options:

all: 15-minute interval data
\n
day: demand summed by day
\n
month: demand summed by month
\n

[\n  {\n    \"meter_id\": meter.meter_id,\n    \"start_date\": 2024-05-01,\n    \"demand\": [\n      {\n        \"value\": 235.78,\n        \"timestamp\": 1714536000,\n      },\n      # ...\n    ]\n]\n\n

\n","urlObject":{"path":["organizations","{{org_id}}","meters","{{meter_id}}","demand","{{period}}"],"host":["{{gridcap_url}}"],"query":[{"key":"start_date","value":"{{start_date}}"},{"key":"end_date","value":"{{end_date}}"}],"variable":[]}},"response":[],"_postman_id":"0289dc74-d86f-4693-ab1b-b6bc08caefa2"}]}