Sign in

v1

latestOpenAPI 3.0.0BSD License2026-07-24228233924.5 KB
Assets

Monthly Leaderboard

GB Leaderboard results per calendar month

get/gb/modo/benchmarking/monthly-leaderboard

Query parameters

date_fromstring required

Month for the request. Ex: yyyy-mm

date_tostring required

Month for the request. Ex: yyyy-mm

asset_namestring

The name of individual battery energy storage assets.

group_bystring

Request a leaderboard for only one of: "asset", "owner" or "operator".

is_bmu'Yes' | 'No'

Would you like the data to contain only BMUs? If "Yes", only BMUs and their relative rankings will be included. If "No", all assets and their relative rankings will be included. If left blank, both lists will be included.

overall_units'GBP per hour per mw' | 'GBP per month per mw' | 'GBP per year per mw' | 'GBP per hour per mwh' | 'GBP per month per mwh' | 'GBP per year per mwh'

Units for data. Options: "GBP per hour per mw", "GBP per hour per mwh", "GBP per month per mw", "GBP per month per mwh", "GBP per year per mw", "GBP per year per mwh"

is_long_term'Yes' | 'No'

Include long term contract revenue in the data? If left blank, both lists will be included. Ex: "yes" or "no".

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

Response

Success

countinteger required
nextstring uri nullable
previousstring uri nullable