Skip to main content

User Tariff information

Endpoints for tariff information. Tariff information will be used during user savings calculation.

Electrical utility providers​

Get list of electrical utility providers.

GET /v2/electrical-utility-providers
X-Api-Key: <apiKey>
X-User-Id: <userId>

Response

["<string>"]

Read more

Get tariff information​

Tariff information is a part of location, please refer to Locations

Save tariff information​

Create or update tariff information.

Important note: Parameters not provided will be removed.

PUT /v2/hiven/users/:userId/locations/:locationId/tariff-info
X-Api-Key: <apiKey>
X-User-Id: <userId>

Payload

{
  "meterId": "<string>", // Optional
  "tariff": "<string>", // Optional
  "electricalUtilityProvider": "<string>" // Optional
}

Response (location)

{
  "id": "<string>",
  "name": "<string>",
  "coordinates": {
    "latitude": "<number>",
    "longitude": "<number>"
  },
  "countryCode": "<string>",
  "postalCode": "<string>",
  "streetAddress": "<string>",
  "city": "<string>",
  "spotPriceAreaId": "<string>",
  "tariffInfo": {
    "meterId": "<string>", // Optional
    "tariff": "<string>", // Optional
    "electricalUtilityProvider": "<string>" // Optional
  } // Optional
}

Read more