sphinx-toolbox Demo - Instance Variables

class <{{ sig_prename_tag }} class="sig-prename descclassname"> tests.test_output.instancevar. <{{ sig_prename_tag }} class="sig-name descname"> OctoAPI ( api_key ) [source]

The primary interface to the Octopus Energy API.

Parameters{% if docutils_version >= (0, 18) %} : {% endif %}

api_key ( str ) – API key to access the Octopus Energy API.

If you are an Octopus Energy customer, you can generate an API key from your online dashboard .

<{{ sig_prename_tag }} class="sig-name descname"> API_BASE

Type: SlumberURL

The base URL of the Octopus Energy API.

<{{ sig_prename_tag }} class="sig-name descname"> API_KEY

Type: Union [ Secret , str , float ]

The API key to access the Octopus Energy API.