API Reference

Supported Independent System Operators (ISOs)

ISOBase
AESO	API client for Alberta Electric System Operator (AESO) data.
CAISO	California Independent System Operator (CAISO)
Ercot	Electric Reliability Council of Texas (ERCOT)
IESO	Independent Electricity System Operator (IESO)
ISONE	ISO New England (ISONE)
MISO	Midcontinent Independent System Operator (MISO)
NYISO	New York Independent System Operator (NYISO)
PJM	PJM
SPP	Southwest Power Pool (SPP)

ISO API Clients

Some ISOs provide official APIs that offer additional data or functionality beyond what’s available through web scraping. These API clients require authentication and are alternatives to the standard ISO classes above.

ErcotAPI	Class to authenticate with and make requests to the ERCOT Data API (api.ercot.com)
ISONEAPI	Class to authenticate with and make requests to the ISO New England API.
MISOAPI	Class for querying the MISO API. Currently supports only pricing data.

Other Data Sources

EIA	Initialize EIA API object

Utilities

get_iso(→ gridstatus.base.ISOBase)	Get an ISO by its id
list_isos(→ pandas.DataFrame)	List available ISOs
make_availability_table(→ str)
filter_lmp_locations(→ pandas.DataFrame)	Filters DataFrame by locations, which can be a list, "ALL" or None
load_folder(→ pandas.DataFrame)	Load a single DataFrame for same schema csv files in a folder

Enums and Data Classes

Markets	Names of LMP Markets
InterconnectionQueueStatus	Interconnection queue types
GridStatus

Exceptions

NotSupported	Common base class for all non-exit exceptions.
NoDataFoundException	Common base class for all non-exit exceptions.

Visualization

dam_heat_map(df)	Create a heat map of day-ahead location marginal prices.
load_over_time(df[, iso])	Create a line graph of load dataframe