List Node Options

Returns the valid pricing nodes for a market region as value/label options.

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

Supports ?search= for fuzzy matching on node name, and ?limit=/?offset= for paging (count always reflects the full list).

This endpoint supersedes GET /nodes/.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path 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 benchmark node list is returned.

Allowed:
Query Params

Fuzzy match on node name.

integer
1 to 500

Cap the number of options returned; omit for all.

integer
≥ 0
Defaults to 0

Skip this many options before the first returned; pair with limit to page.

Responses

400

Invalid list_type or paging params. Valid list_type values: forecast, benchmark.

401

Missing or invalid X-token.

404

Unknown market region. Valid values: caiso, ercot, gb, germany, isone, italy, miso, nem, nyiso, pjm, poland, spain, spp.

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