List Nodes

Returns the list of valid pricing nodes for a market region.

Use the name field to populate the nodes field in your simulation_config when creating a nodal forecast run via POST /runs/.

Requires ?region= to select the market region and ?list_type= to select the forecast or backtest node list. Supports ?search= to filter nodes by name.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
required

Market region, case-insensitive. Uses the same vocabulary as simulation_config.market_region in POST /runs/.

string
enum
required

Selects whether the forecast or backtest node list is returned.

Allowed:
string

Filter nodes by name (case-insensitive substring match).

integer
≤ 100
Defaults to 50

Number of results per page.

integer
Defaults to 0

Offset for pagination.

Responses

400

Missing region, or missing or invalid list_type. Valid list_type values: forecast, backtest.

401

Missing or invalid X-token.

404

Unknown market region. Valid values: ercot, gb, germany, miso, nem, nyiso, pjm, spain, spp, wecc.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json