---
title: "Index Breakdown - GB"
method: GET
path: "/gb/modo/benchmarking/leaderboard-live"
tags: ["Assets"]
---

# Index Breakdown - GB

`GET /gb/modo/benchmarking/leaderboard-live`

## Request

- Base URL: `https://api.modoenergy.com/pub/v1`
- URL: `https://api.modoenergy.com/pub/v1/gb/modo/benchmarking/leaderboard-live`
- Auth: one of:
  - API key in header `X-Token`
  - none
- TypeScript: <https://skmtc.dev/modoenergy/apis/modo-energy-api/docs/gb/modo/benchmarking/leaderboard-live/get.ts> (a function with typed inputs; its response is checked against the schema)

Live Leaderboard data for individual GB battery assets.

## Query parameters

- `settlement_date_from` string, date, required
- `settlement_date_to` string, date, required
- `asset_name` string
- `limit` integer
- `offset` integer

## Response `200`

Success

- object
  - `count` integer, required
  - `next` string, uri, nullable
  - `previous` string, uri, nullable
  - `results` GBAssetAggregation[], required
    - `id` integer
    - `settlement_date` string, date, required
    - `settlement_period` integer, required
    - `asset` string, nullable
    - `market` string, required
    - `rated_power` number, required
    - `energy_capacity` number, required
    - `export_mwh` number, required
    - `import_mwh` number, required
    - `revenue` number, required
    - `contract_capacity` number, required
    - `buy_price_mwh` number, required
    - `sell_price_mwh` number, required
    - `revspermw` number, required
    - `revspermwh` number, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `429`: Too Many Requests

---

[API](https://skmtc.dev/modoenergy/apis/modo-energy-api.md) - [All operations](https://skmtc.dev/modoenergy/apis/modo-energy-api/llms.txt) - [OpenAPI document](https://skmtc.dev/modoenergy/apis/modo-energy-api/revisions/7d9d1bd6ee06?raw)