Skip to main content
GET
Get all units at behind-the-meter gas plants
The BTM gas plant endpoints require the gas-plants scope on your API key. A key without it gets 403 INSUFFICIENT_SCOPE. Contact us to add it.

Overview

This endpoint returns the equipment at the plants in Gas Plants. Each record is one unit: one equipment model at one stage of a plant’s build, with its manufacturer (OEM), model, number of machines, capacity, status and year. A plant that uses two models has two units. So does a plant that installs the same model in two stages with different timelines. The plant’s developer and location are repeated on every record, so the table stands on its own. Pivot it by OEM, model, status, year or state. This is a “download link” style endpoint that returns all records in a single response. There is no pagination.

Equipment

  • oem and model are spelled the way the manufacturer sells them, like Siemens Energy SGT-800 or INNIO Jenbacher J624.
  • model is null when a document names the manufacturer but not the model. Cleanview doesn’t guess a model from the plant’s size.
  • model_family groups products built on the same machine: GE’s TM2500 and LM2500XPRESS are both LM2500. Use it to count every machine of a kind, however it was packaged.
  • version is the model’s rated version, when a document identifies it.

Configuration

equipment_type is the kind of machine: Gas turbine, Steam turbine, Reciprocating engine or Fuel cell. configuration is how it generates: A combined-cycle plant has combined_cycle records for its gas turbines and steam_turbine records for its steam turbines. Add both for the plant’s full combined-cycle capacity.

Capacity

nameplate_capacity_mw is the nameplate capacity of all the unit’s machines together: the number of machines times the manufacturer’s rating for each one. Manufacturers rate gas turbines at 59°F at sea level and engines at 77°F, so one machine has one rating wherever it’s installed. capacity_basis says where the number comes from:

Status

status uses the same five values as Gas Plants. Canceled units are included with status Canceled, and Gas Plants leaves them out of its capacity figures.

Example Requests

Returns all unit records in a single response.

Response Schema

Response Fields

Metadata Section

Unit Fields

Null Values: null means Cleanview doesn’t know the value yet, not zero. oem, model, model_family and version are null until they’re public; iso_rating_mw when the version isn’t known; equipment_type and configuration for the few units whose configuration isn’t known; unit_count, nameplate_capacity_mw and capacity_basis when the number or size of the machines isn’t public yet.

Authorizations

x-api-key
string
header
required

API key authentication using x-api-key header

Response

Successful response with all gas plant units

success
boolean
required

Always true for successful responses

Example:

true

metadata
object
required
customer
object
required

Customer information for the API key

data
object[]
required

Array of all gas plant units