@factset/sdk-factsetpowerutilities
v0.1.0
Published
FactSet Power & Utilities client library for JavaScript
Readme
FactSet Power & Utilities client library for JavaScript
The FactSet Power & Utilities API provides comprehensive global power generation and energy market data. Coverage includes power plant metadata and technical specifications, balancing authority supply and demand, power spot and forward prices, spark spreads, capacity prices, and hourly and monthly plant-level generation and emissions.
Note: Plant metadata and reference/mapping endpoints (Plants, ISO/TSO mapping, zone mapping) reflect current data only — historical or point-in-time values are not retained. The exception is GET /reference/entity-history, which provides historical entity and ownership records. Unit-level mapping information (unit names, EIA codes, project grades, and regional mappings) are included in the /units/details metadata response.
Key Features:
- Global power plant metadata including ownership, location, pipeline connections, and fuel-specific technical specifications (solar, wind, thermal)
- Balancing authority-level generation (by fuel type), demand, and net interchange data
- Power spot prices, spark spreads, capacity auction clearing prices, and forward power curves
- Hourly and monthly plant-level net generation with CO₂, N₂O, and SO₂ emissions data
- Reference data for ISO/TSO codes, price zones and hubs, and entity/ownership history
Units and abbreviations used throughout this API:
MW— megawatt (unit of instantaneous power capacity)MWh— megawatt-hour (unit of energy; one MW delivered for one hour)$/MWh— US dollars per megawatt-hour (power price unit)$/MW-day— US dollars per megawatt per day (capacity market price unit)MMBtu— million British thermal units (heat input unit)Dth— dekatherm (one million BTU; unit for natural gas interconnection capacity)CO₂— carbon dioxide; reported in metric tonsSO₂— sulfur dioxide; reported in metric tons (hourly) or short tons (monthly)N₂O— nitrous oxide; reported in metric tons (hourly) or short tons (monthly)BA— Balancing Authority; a grid operator responsible for balancing generation and load within its areaISO/TSO— Independent System Operator / Transmission System OperatorEIA— US Energy Information Administration
This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- SDK version: 0.1.0
- Build package: com.factset.sdk.codegen.FactSetJavascriptClientCodegen
For more information, please visit https://developer.factset.com/contact
Requirements
- Node.js >= 18
Installation
npm
npm install @factset/sdk-utils @factset/[email protected]yarn
yarn add @factset/sdk-utils @factset/[email protected]Usage
- Generate authentication credentials.
- Setup Node.js environment
Install and activate Node.js >=18. If you're using nvm:
nvm install 18 nvm use 18(optional) Install yarn.
- Install dependencies.
- Run the following:
[!IMPORTANT] The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.
Example Code
const { ApiClient, UnitsApi } = require('@factset/sdk-factsetpowerutilities');
const { ConfidentialClient } = require('@factset/sdk-utils');
const apiClient = ApiClient.instance;
// Examples for each supported authentication method are below,
// choose one that satisfies your use case.
// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');
// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';
const apiInstance = new UnitsApi();
const plantUnitsRequest = new factsetpowerutilities.PlantUnitsRequest(); // PlantUnitsRequest |
// Call api endpoint
apiInstance.listPlantUnits(plantUnitsRequest).then(
data => {
console.log('API called successfully. Returned data:');
console.log(data);
},
error => {
console.error(error);
},
);
Using a Proxy
To add a HTTP proxy for the API client, you can set the proxyUrl for the ApiClient instance:
const { ApiClient } = require('@factset/sdk-factsetpowerutilities');
const apiClient = ApiClient.instance;
apiClient.setProxyUrl('http://username:[email protected]:8080');Documentation for API Endpoints
All URIs are relative to https://api.factset.com/content/factset-power-utilities/v1
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- factsetpowerutilities.GenerationEmissionsApi | listHourlyGenerationUnits | POST /generation/hourly/units | Returns hourly plant unit generation and emissions factsetpowerutilities.GenerationEmissionsApi | listMonthlyGeneration | POST /generation/monthly | Returns monthly plant generation and emissions factsetpowerutilities.MarketDataApi | listMarketData | POST /market-data | Returns balancing authority generation, demand, or interchange factsetpowerutilities.MarketDataApi | listMarketDataCoverage | GET /market-data/coverage | Returns balancing authority coverage factsetpowerutilities.PlantsApi | listPlantIds | GET /plants/ids | Returns discoverable power plant IDs factsetpowerutilities.PricesApi | listPrices | POST /prices | Returns power spot prices, spark spreads, capacity prices, or forward prices factsetpowerutilities.ReferenceApi | listEntityHistory | GET /reference/entity-history | Returns entity and security history records factsetpowerutilities.ReferenceApi | listIsoMapping | GET /reference/iso-mapping | Returns ISO/TSO mapping data factsetpowerutilities.ReferenceApi | listLocationMapping | GET /reference/location-mapping | Returns power price location mapping data factsetpowerutilities.ReferenceApi | listZoneMapping | GET /reference/zone-mapping | Returns price zone and hub mapping data factsetpowerutilities.UnitsApi | listPlantUnits | POST /units/details | Returns power plant unit metadata and technical details factsetpowerutilities.UnitsApi | listUnitsOwnership | POST /units/ownership | Returns power plant unit ownership details
Documentation for Models
- factsetpowerutilities.BalancingAuthorityCoverage
- factsetpowerutilities.CapacityPriceData
- factsetpowerutilities.CapacityPriceRecord
- factsetpowerutilities.CapacityPriceRecordAllOf
- factsetpowerutilities.CategoryCapacity
- factsetpowerutilities.CategoryDemand
- factsetpowerutilities.CategoryForward
- factsetpowerutilities.CategoryGeneration
- factsetpowerutilities.CategoryInterchange
- factsetpowerutilities.CategoryMetadata
- factsetpowerutilities.CategoryPipeline
- factsetpowerutilities.CategoryPower
- factsetpowerutilities.CategorySolar
- factsetpowerutilities.CategorySparkSpread
- factsetpowerutilities.CategoryThermal
- factsetpowerutilities.CategoryWind
- factsetpowerutilities.CollectionResponseMeta
- factsetpowerutilities.EntityHistoryRecord
- factsetpowerutilities.EntityHistoryResponse
- factsetpowerutilities.ErrorObject
- factsetpowerutilities.ErrorObjectLinks
- factsetpowerutilities.ErrorResponse
- factsetpowerutilities.ForwardPriceData
- factsetpowerutilities.ForwardPriceRecord
- factsetpowerutilities.ForwardPriceRecordAllOf
- factsetpowerutilities.HourlyGenerationRecord
- factsetpowerutilities.HourlyGenerationRequest
- factsetpowerutilities.HourlyGenerationRequestData
- factsetpowerutilities.HourlyGenerationResponse
- factsetpowerutilities.IsoMappingRecord
- factsetpowerutilities.IsoMappingResponse
- factsetpowerutilities.LocationMappingRecord
- factsetpowerutilities.LocationMappingResponse
- factsetpowerutilities.MarketDataCoverageResponse
- factsetpowerutilities.MarketDataDemandData
- factsetpowerutilities.MarketDataGenerationData
- factsetpowerutilities.MarketDataInterchangeData
- factsetpowerutilities.MarketDataRecord
- factsetpowerutilities.MarketDataRequest
- factsetpowerutilities.MarketDataRequestData
- factsetpowerutilities.MarketDataResponse
- factsetpowerutilities.MonthlyGenerationRecord
- factsetpowerutilities.MonthlyGenerationRequest
- factsetpowerutilities.MonthlyGenerationRequestData
- factsetpowerutilities.MonthlyGenerationResponse
- factsetpowerutilities.PlantIdRecord
- factsetpowerutilities.PlantIdsResponse
- factsetpowerutilities.PlantMetadataData
- factsetpowerutilities.PlantMetadataDetail
- factsetpowerutilities.PlantPipelineData
- factsetpowerutilities.PlantPipelineDetail
- factsetpowerutilities.PlantSolarData
- factsetpowerutilities.PlantSolarDetail
- factsetpowerutilities.PlantThermalData
- factsetpowerutilities.PlantThermalDetail
- factsetpowerutilities.PlantUnitDetail
- factsetpowerutilities.PlantUnitsRequest
- factsetpowerutilities.PlantUnitsRequestData
- factsetpowerutilities.PlantUnitsResponse
- factsetpowerutilities.PlantWindData
- factsetpowerutilities.PlantWindDetail
- factsetpowerutilities.PowerPriceData
- factsetpowerutilities.PowerPriceRecord
- factsetpowerutilities.PowerPriceRecordAllOf
- factsetpowerutilities.PriceRecord
- factsetpowerutilities.PriceRecordBase
- factsetpowerutilities.PricesRequest
- factsetpowerutilities.PricesRequestData
- factsetpowerutilities.PricesResponse
- factsetpowerutilities.RequestMeta
- factsetpowerutilities.RequestPagination
- factsetpowerutilities.ResponseMeta
- factsetpowerutilities.ResponsePagination
- factsetpowerutilities.SparkSpreadData
- factsetpowerutilities.SparkSpreadPriceRecord
- factsetpowerutilities.SparkSpreadPriceRecordAllOf
- factsetpowerutilities.SparkSpreadPricesMwh
- factsetpowerutilities.UnitsOwnershipDetail
- factsetpowerutilities.UnitsOwnershipRequest
- factsetpowerutilities.UnitsOwnershipRequestData
- factsetpowerutilities.UnitsOwnershipResponse
- factsetpowerutilities.ZoneMappingRecord
- factsetpowerutilities.ZoneMappingResponse
Documentation for Authorization
FactSetApiKey
- Type: HTTP basic authentication
FactSetOAuth2
- Type: OAuth
- Flow: application
- Authorization URL:
- Scopes: N/A
Contributing
Please refer to the contributing guide.
Copyright
Copyright 2026 FactSet Research Systems Inc
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
