EnergyCharts SDK

Energy-Charts API client, generated from the OpenAPI spec.

Timestamp Format Options

When specifying timestamps, you can choose from the following three formats:

1. ISO 8601 Format:
   • This format includes the full date and time, with an optional timezon…

     Learn more about Energy-Charts API at energy-charts.info.

     This is an unofficial SDK for the Energy-Charts public API, generated by Voxgig with @voxgig/sdkgen. It is not affiliated with, endorsed by, or sponsored by the upstream API provider.

     Learn more about Voxgig SDKs at voxgig.com/sdk.

     Metadata kindly supplied by www.freepublicapis.com.

     TypeScript, Python, PHP, Golang, Ruby, Lua SDKs, a CLI, an interactive REPL, and an MCP server for AI agents — all generated from one OpenAPI spec by @voxgig/sdkgen.

     Entities, not endpoints

     This SDK exposes the API as a small set of semantic entities — CrossBorderModel, DailyAvgDict, Frequency, InstalledModel, Price, ProductionModel, PublicPowerForecast, RenShareModel, ShareModel and TrafficModel — that you call directly, instead of assembling URL paths and query strings. Entities are Capitalised to mark them as the primary surface, each with the operations they support (list, load):

     const client = new EnergyChartsSDK()
     const crossbordermodel = await client.CrossBorderModel().load()

     Thinking in entities keeps the mental model small — for people and AI agents alike — rather than reasoning about raw HTTP routes and query parameters.

     Offline unit testing

     Every SDK ships a built-in test mode that swaps the HTTP transport for an in-memory mock, so your unit tests run fully offline — no server, no network, and no credentials:

     TypeScript

     const client = EnergyChartsSDK.test()
     const crossbordermodel = await client.CrossBorderModel().load()
     // crossbordermodel is a bare CrossBorderModel populated with mock data
     console.log(crossbordermodel)

     Python

     client = EnergyChartsSDK.test()
     crossbordermodel = client.CrossBorderModel().load()
     print(crossbordermodel)

     PHP

     // Seed fixture data so offline calls resolve without a live server.
     $client = EnergyChartsSDK::test([
         "entity" => ["crossbordermodel" => ["test01" => []]],
     ]);
     $crossbordermodel = $client->CrossBorderModel()->load();

     Golang

     client := sdk.Test()
     result, err := client.CrossBorderModel(nil).Load(
         nil, nil,
     )

     Ruby

     # Seed fixture data so offline calls resolve without a live server.
     client = EnergyChartsSDK.test({
       "entity" => { "crossbordermodel" => { "test01" => {} } },
     })
     crossbordermodel = client.CrossBorderModel.load()

     Lua

     local client = sdk.test()
     local result, err = client:CrossBorderModel():load()

     Packages

     Language	Package	Install
     TypeScript	@voxgig-sdk/energy-charts	publish pending — install from git tag
     Python	voxgig-sdk-energy-charts	publish pending — install from git tag
     PHP	voxgig-sdk/energy-charts	publish pending — install from git tag
     Golang	github.com/voxgig-sdk/energy-charts-sdk/go	go get github.com/voxgig-sdk/energy-charts-sdk/go@latest
     Ruby	voxgig-sdk-energy-charts	publish pending — install from git tag
     Lua	voxgig-sdk-energy-charts	publish pending — install from git tag
     Go CLI	github.com/voxgig-sdk/energy-charts-sdk/go-cli	go install github.com/voxgig-sdk/energy-charts-sdk/go-cli/cmd/energy-charts@latest
     Go MCP server	github.com/voxgig-sdk/energy-charts-sdk/go-mcp	go get github.com/voxgig-sdk/energy-charts-sdk/go-mcp@latest

     Quickstart

     TypeScript

     import { EnergyChartsSDK } from '@voxgig-sdk/energy-charts'
     
     const client = new EnergyChartsSDK()
     
     // Load crossbordermodel data (returns a CrossBorderModel)
     const crossbordermodel = await client.CrossBorderModel().load()
     console.log(crossbordermodel)

     See the TypeScript README for the full guide.

     Surfaces

     Surface	Path
     SDK (TypeScript, Python, PHP, Golang, Ruby, Lua)	ts/ py/ php/ go/ rb/ lua/
     CLI	go-cli/
     MCP server	go-mcp/

     Use it from an AI agent (MCP)

     The generated MCP server exposes every operation in this SDK as an MCP tool that Claude, Cursor or Cline can call directly. Build and register it:

     cd go-mcp && go build -o energy-charts-mcp .

     Then add it to your agent’s MCP config (Claude Desktop, Cursor, etc.):

     {
       "mcpServers": {
         "energy-charts": {
           "command": "/abs/path/to/energy-charts-mcp"
         }
       }
     }

     Entities

     The API exposes 10 entities:

     Entity	Description	API path
     CrossBorderModel	The CrossBorderModel entity (load).	/cbet
     DailyAvgDict	The DailyAvgDict entity (list).	/ren_share_daily_avg
     Frequency	The Frequency entity (list).	/frequency
     InstalledModel	The InstalledModel entity (list).	/installed_power
     Price	The Price entity (load).	/price
     ProductionModel	The ProductionModel entity (load).	/public_power
     PublicPowerForecast	The PublicPowerForecast entity (list).	/public_power_forecast
     RenShareModel	The RenShareModel entity (list).	/ren_share_forecast
     ShareModel	The ShareModel entity (load).	/solar_share
     TrafficModel	The TrafficModel entity (list).	/signal

     The operations available across these entities are load, list — see each entity’s own list above for exactly which it supports.

     Quickstart in other languages

     Python

     from energycharts_sdk import EnergyChartsSDK
     
     client = EnergyChartsSDK()
     
     
     # Load a specific crossbordermodel (returns the record, raises on error)
     crossbordermodel = client.CrossBorderModel().load()
     print(crossbordermodel)

     PHP

     <?php
     require_once 'energycharts_sdk.php';
     
     $client = new EnergyChartsSDK();
     
     
     // Load a specific crossbordermodel (returns the bare record; throws on error)
     $crossbordermodel = $client->CrossBorderModel()->load();
     print_r($crossbordermodel);

     Golang

     import sdk "github.com/voxgig-sdk/energy-charts-sdk/go"
     
     client := sdk.New()
     
     // Load crossbordermodel data
     crossBorderModel, err := client.CrossBorderModel(nil).Load(nil, nil)
     if err != nil {
         panic(err)
     }
     fmt.Println(crossBorderModel)

     Ruby

     require_relative "EnergyCharts_sdk"
     
     client = EnergyChartsSDK.new
     
     
     # Load a specific crossbordermodel (returns the bare record; raises on error)
     crossbordermodel = client.CrossBorderModel.load()
     puts crossbordermodel

     Lua

     local sdk = require("energy-charts_sdk")
     
     local client = sdk.new()
     
     
     -- Load a specific crossbordermodel
     local crossbordermodel, err = client:CrossBorderModel():load()
     print(crossbordermodel)

     Direct and prepare

     For endpoints the entity model doesn’t cover, use the low-level methods:

     • direct(fetchargs) — build and send an HTTP request in one step.
     • prepare(fetchargs) — build the request without sending it.

     Both accept a map with path, method, params, query, headers, and body. See the How-to guides below.

     How-to guides

     Make a direct API call

     When the entity interface does not cover an endpoint, use direct:

     TypeScript:

     const result = await client.direct({
       path: '/api/resource/{id}',
       method: 'GET',
       params: { id: 'example' },
     })
     if (result instanceof Error) {
       throw result
     }
     console.log(result.data)

     Python:

     result = client.direct({
         "path": "/api/resource/{id}",
         "method": "GET",
         "params": {"id": "example"},
     })

     PHP:

     $result = $client->direct([
         "path" => "/api/resource/{id}",
         "method" => "GET",
         "params" => ["id" => "example"],
     ]);

     Go:

     result, err := client.Direct(map[string]any{
         "path":   "/api/resource/{id}",
         "method": "GET",
         "params": map[string]any{"id": "example"},
     })
     if err != nil {
         panic(err)
     }
     fmt.Println(result)

     Ruby:

     result = client.direct({
       "path" => "/api/resource/{id}",
       "method" => "GET",
       "params" => { "id" => "example" },
     })

     Lua:

     local result, err = client:direct({
       path = "/api/resource/{id}",
       method = "GET",
       params = { id = "example" },
     })

     Advanced

     Everyday use only needs the sections above. This explains the internals behind every call — relevant when writing custom features.

     Every SDK call runs the same five-stage pipeline:

     1. Point — resolve the API endpoint from the operation definition.
     2. Spec — build the HTTP specification (URL, method, headers, body).
     3. Request — send the HTTP request.
     4. Response — receive and parse the response.
     5. Result — extract the result data for the caller.

     A feature hook fires at each stage (e.g. PrePoint, PreSpec, PreRequest), so features can inspect or modify the pipeline without forking the SDK.

     Features

     Feature	Purpose
     TestFeature	In-memory mock transport for testing without a live server

     Pass custom features via the extend option at construction time.

     Per-language documentation

     • TypeScript
     • Python
     • PHP
     • Golang
     • Ruby
     • Lua

     Upstream API

     This SDK is generated from the upstream OpenAPI specification. It is an unofficial client and is not affiliated with the API provider.

     • Upstream API: https://energy-charts.info/contact.html

     Security

     Please report security issues to security@voxgig.com. See SECURITY.md. Do not open public issues for suspected vulnerabilities.

     ---

     Generated from the Energy-Charts API OpenAPI spec by @voxgig/sdkgen.