Fram API (1.0.0)

Download OpenAPI specification:

All endpoints are available at https://api.framenergy.com/api/v1. For example, to list organizations, use GET https://api.framenergy.com/api/v1/organizations.

Authentication

To access the API, obtain an access token using:

curl --request POST \
  --url https://auth.framenergy.com/oauth/token \
  --header 'content-type: application/json' \
  --data '{
    "client_id":"<your_client_id>",
    "client_secret":"<your_client_secret>",
    "audience":"https://api.framenergy.com", 
    "grant_type":"client_credentials"
  }'

You can retrieve your client_id and client_secret from Fram.

The response will be:

{"access_token":"<access_token>","expires_in":86400,"token_type":"Bearer"}

Pass the token in the Authorization header for all requests:

Authorization: Bearer <access_token>

List organizations

Authorizations:
bearerAuth
query Parameters
page
integer
Default: 1
limit
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get organization by ID

Authorizations:
bearerAuth
path Parameters
organization_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "name": "string"
}

List projects

Authorizations:
bearerAuth
query Parameters
page
integer
Default: 1
limit
integer
organization_id
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get project by ID

Authorizations:
bearerAuth
path Parameters
project_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "name": "string",
  • "address": "string"
}

List users

Authorizations:
bearerAuth
query Parameters
page
integer
Default: 1
limit
integer
project_id
string <uuid>
organization_id
string <uuid>

Responses

Response samples

Content type
application/json
[
  • null
]

List units

Authorizations:
bearerAuth
query Parameters
page
integer
Default: 1
limit
integer
project_id
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get unit by ID

Authorizations:
bearerAuth
path Parameters
unit_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "unit_id": "5becc822-b69e-4e66-a762-ad8e868dcab6",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "unit_number": "string"
}

List aggregated utility rates

Authorizations:
bearerAuth
query Parameters
page
integer
Default: 1
limit
integer
Default: 10
billing_code
string
generation_supplier
string
bypass_limit
boolean
Default: false
target_date
string <date>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get aggregated utility rate by ID

Authorizations:
bearerAuth
path Parameters
aggregated_utility_rate_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "aggregated_utility_rate_id": "72a1d190-c3ac-405c-98c5-ebaab356583c",
  • "utility": "string",
  • "billing_code": "string",
  • "effective_date": "2019-08-24",
  • "end_date": "2019-08-24"
}