Battery capture-rate rankings
get_rankingsLeague table of merchant NEM batteries over a date range, ranked by capture rate by default (actual revenue as a share of the forecast-informed benchmark; capture_perfect_pct is the share of the perfect-foresight ceiling). Each row has rank, duid, station, region, capacity, duration_band, capture_fc_pct, capture_perfect_pct, rev_per_mw_day, rev_per_mwh_day, total_rev, cycles_per_day and movement against the previous period of equal length. total_rev is MLF-adjusted over LP-solved days (through lp_through), so it differs from get_battery_revenue's gross every-day total. Units still commissioning and CONTRACTED or TOLLED units are listed under excluded, not ranked, unless include_arrangement is true (their spot revenue is not their commercial return). Check unit_class and peer_comparable before reading a gap as performance. It scans the whole fleet twice, so keep the range to a month or less; it can be slow or time out on long ranges. For one unit's revenue use get_battery_revenue.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"date_from": "<date_from>",
"date_to": "<date_to>"
},
"name": "get_rankings"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Return only the top N ranked rows (default all); total_ranked gives the full count. | |
| region | No | NEM region code: NSW1, QLD1, SA1 (South Australia), TAS1 or VIC1. | |
| date_to | Yes | End date, YYYY-MM-DD (inclusive). | |
| sort_by | No | Ranking metric (default capture_fc). | |
| date_from | Yes | Start date, YYYY-MM-DD (inclusive). | |
| duration_band | No | Optional. Under 2 hours, 2 to 4 hours, or over 4 hours. | |
| include_arrangement | No | Rank CONTRACTED and TOLLED units too (default false). |