project_rankings#
The project_rankings function retrieves project rankings based on various criteria. You can get information such as likelihood of a plant construction. This is a function without parameters that sends a GET request to the Vulcan V2 Rankings endpoint to return the most recent ranking information.
In the Formula Builder, select Vulcan 2.0, theen choose the project_rankings function from the Enter Function dropdown. Once selected, click Insert to automatically add the formula to Excel.
Syntax#
=SMXV2.project_rankings()
Output Parameters#
When executed, this function returns project ranking data directly into the active Excel worksheet, displaying the output dataset with all relevant fields and records.
The returned Excel sheet includes the following data columns:
Field |
Description |
Example |
|---|---|---|
plant_id |
EIA plant id |
66684 |
generator_id |
EIA ID given to each generator for a given plant |
HL002 |
final_rank |
Indicates the likelihood of a plant’s construction. Values range from 0-7, a higher-ranking number indicates a higher likelihood of plant construction. |
1.392199993 |
date_vulcan_proposed_online |
Forecasted online date for a given plant using a conservative build outlook similar to the last 5 years. |
3/26/2030 |
date_updated |
Date on which the project rank was last updated |
11/20/2024 |
date_vulcan_proposed_v2_online |
Forecasted online date for a given plant incoporating seasonal factors and build outlook similar to the last 2 years. |
|
synmax_id |
Unique key of plant id and generator id |
66684-HL002 |
created_at |
ISO date on which the record was created |
TBD |
modified_at |
ISO date on which the record was last modified |
TBD |
Example Output#
plant_id |
generator_id |
final_rank |
date_vulcan_proposed_online |
date_updated |
date_vulcan_proposed_v2_online |
synmax_id |
created_at |
modified_at |
|---|---|---|---|---|---|---|---|---|
66685 |
WH003 |
1.329900026 |
10/12/2028 |
11/20/2024 |
66685-WH003 |
TBD |
TBD |
|
60206 |
HCCA1 |
1.414399981 |
5/17/2027 |
11/20/2024 |
60206-HCCA1 |
TBD |
TBD |
|
62400 |
NA1 |
1.508999944 |
4/18/2030 |
11/20/2024 |
62400-NA1 |
TBD |
TBD |
|
66478 |
GEN2 |
1.850700021 |
11/10/2027 |
11/20/2024 |
66478-GEN2 |
TBD |
TBD |
Errors#
Functions may return the following error messages:
Error |
Description |
|---|---|
#VALUE! |
Input parameters are invalid or cannot be parsed. |
#REF! |
The function cannot retrieve data from the SynMaxax API due to a network or connectivity issue. |
!!! EXCEPTION |
Invalid input parameters. Make sure dates are enclosed in quotes. Check if the API key is valid. To know more about how to use an API key, please check the section on authentication. |
#No Data |
Input data is invalid or does not exist. |
Note
You can also check the logs for more information on errors. You can access the logs by clicking on SynMax Commodities on the Excel ribbon and then clicking on Logs.