Skip to content
/
List suppliers, sorted al...

List suppliers, sorted alphabetically by name.

Request

List all the energy suppliers known by the ev.energy system.

Use the available_for_user_id query parameter to narrow the list to only those relevant to a specific user.

Security
oauth2(Required scopes: tariff:read)
Query
pagenumber

The page number to return results for.

Example:page=2
page_sizeinteger, [ 1 .. 100 ]

Specify the number of results to return per page.

Default:25
Example:page_size=10
available_for_user_idstringuser[A-Z\d]{26}

Filter to only return resources available in the user's region and program.

Example:available_for_user_id=user01HN2NJ9NMRZBXT1H6FT9N7735
Headers
EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value:2
curl -i -X GET \
  'https://developers.ev.energy/_mock/ev.energy-api-v2/suppliers?page=2&page_size=10&available_for_user_id=user01HN2NJ9NMRZBXT1H6FT9N7735' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'EvEnergy-Version: 2'

Responses

Return a list of Suppliers.

Headers
EvEnergy-Versionnumber

Indicates the version of the API that generated this response. If EvEnergy-Version was not specified in the request, this will be your OAuth application's default version.

Value:2
X-RateLimit-Limitnumber

The maximum number of requests that can be made to this endpoint per hour. Defaults to 1000 but may vary per client.

Default:1000
X-RateLimit-Remainingnumber

The number of requests remaining until this client's rate limit is reached.

Default:999
RetryAfternumber

The number of seconds until this client's requests will not be rate limited.

Default:3600
Bodyapplication/json
Array [
idstringsupl[A-Z\d]{26}read-onlyrequired

Unique identifier for the given user.

Example:"supl01HN2NJ9NMRZBXT1H6FT9N7735"
urlstring, (uri)required
Example:"https://api.ev.energy/v2/suppliers/supl01HN2NJ9NMRZBXT1H6FT9N7735"
namestringrequired
Example:"Rivendell Renewables"
iconstring or null, (uri)required
Example:"https://cdn.example.com/rivendell_renewables.jpg"
highlightedboolean

A highlighted supplier is one that is often selected by users.

]
Response
[
  {
    "id": "supl01HN2NJ9NMRZBXT1H6FT9N7735",
    "url": "https://api.ev.energy/v2/suppliers/supl01HN2NJ9NMRZBXT1H6FT9N7735",
    "name": "Rivendell Renewables",
    "icon": "https://cdn.example.com/rivendell_renewables.jpg",
    "highlighted": true
  }
]