The Verdigris DataAPI allows for the fetching of data collected by your Verdigris system.


The only way to authenticate with the API is to pass in an Authorization http header as shown in the example below:

$ curl -i -H "Authorization: Token token=<access token>"

Access Token

To request your access token, email

Client Errors

  1. Authentication ErrorA valid access_token must be provided in the Authorization headers.HTTP/1.1 404 Not Found{"error":"Couldn't find ApiKey with access_token = <invalid access_token>"}

  2. Resource ErrorThis error could be due to the fact that the resource requested is not accessible by the access_token specified. HTTP/1.1 404 Not Found {"error":"Couldn't find Circuit with id=<circuit_id> [WHERE "memberships"."user_id" = <user_id>]"}


  1. The api is rate limited to 5 requests per second for any resource listed. Example error message: HTTP/1.1 429 Too Many Requests Retry Later

  2. Each request for energy data is limited to a total of 1,500 data points across models. (i.e. 1 circuit and 1,500 data points is allowed, 2 circuits and 750 datapoints each is also allowed, and so on)Example error message: HTTP/1.1 400 Bad Request {"error":"Invalid parameter 'ids, start_time, end_time' value ["1,2", "2017-01-01T00:00:00.000Z", "2017-03-01T00:00:00.000Z"]: requested too many datapoints"}

Did this answer your question?