URL: /sdk/overview

---
title: 'Overview'
icon: 'house'
sidebarTitle: 'Introduction'
---

Open Electricity provides SDKs to access the API in TypeScript / JavaScript or Python.

# Typescript SDK

The Typescript SDK is available on [NPM](https://www.npmjs.com/package/openelectricity).

It supports accessing the API synchronously and asynchronously, and includes a built in data and record table tools for analysing data.


## Installation

The Typescript SDK is [available on NPM at openelectricity](https://www.npmjs.com/package/openelectricity).

Install the SDK using your preferred package manager:


<CodeGroup>
```bash npm
npm install openelectricity
```

```bash yarn
yarn add openelectricity
```

```bash pnpm
pnpm add openelectricity
```

```bash bun
bun add openelectricity
```
</CodeGroup>

## Quick Start

```typescript
import { OpenElectricityClient } from 'openelectricity'

// Initialize the client
const client = new OpenElectricityClient()

// Get energy data for the NEM
const { datatable } = await client.getNetworkData('NEM', ['energy'], {
  interval: '1h',
  dateStart: '2024-01-01T00:00:00',
  dateEnd: '2024-01-02T00:00:00',
  primaryGrouping: 'network_region',
})

// Analyze the data
console.table(datatable.toConsole())
```


# Python SDK

The Python SDK is available on [PyPI](https://pypi.org/project/openelectricity/).

It supports accessing the API synchronously and asynchronously, and exporting results to either pandas or polars DataFrames.

## Installation

The Python SDK is [available on PyPI at openelectricity](https://pypi.org/project/openelectricity/).

Install the SDK using your preferred package manager:


<CodeGroup>
```bash pip
pip install openelectricity
```

```bash uv
uv add openelectricity
```
</CodeGroup>

## Quick Start

```python
from openelectricity import OpenElectricityClient

# Initialize the client
client = OpenElectricityClient()

# Get energy data for the NEM
datatable = client.get_network_data('NEM', ['energy'], {
  interval: '1h',
  dateStart: '2024-01-01T00:00:00',
  dateEnd: '2024-01-02T00:00:00',
  primaryGrouping: 'network_region',
})
```


<CardGroup cols={2}>
  <Card
    title="Python SDK"
    icon="python"
    href="/sdk/python/overview"
  >
    Open Electricity Python SDK
  </Card>
  <Card
    title="TypeScript SDK"
    icon="js"
    href="/sdk/typescript/overview"
  >
    Open Electricity TypeScript SDK
  </Card>
</CardGroup>