Overview

The Verdigris API allows for fetching of data collected by buds in the Verdigris ecosystem.

Current Version

The current version of the api is v1.

Client Errors

  1. Authentication Error

    A 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 Error

    This 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>]"}


Authentication

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

$ curl -i https://app.verdigris.co/api/v1/circuits/1765/ -H "Authorization: Token token=<access token>"

Resources

Circuits

Resource Description
GET /api/v2/circuits/energy Energy data for circuits