Developer Network NREL NREL Developer Network

REDE Technical Potential

This API provides access to a Technical Potential analyses model developed at NREL in conjunction with USAID. The tool estimates the technical potential of specific renewable electricity generation technologies taking into account a variety of user supplied filters and other inputs. These are technology-specific estimates of energy generation potential based on renewable resource availability and quality, technical system performance, topographic limitations, environmental, and land-use constraints only. The estimates do not consider economic or market constraints, and therefore do not represent a level of renewable generation that might actually be deployed. Details on the application and use of this tool, as well as the methodology employed can be found at REexplorer Training and Renewable Energy Technical Potentials: A GIS-Based Analysis.

    Endpoints


    The REDE Technical Potential API provides a total of two endpoints, hosted from the base developer.nrel.gov/api/opencarto/rede/.


    v1/technical-potential/config
    Provides a JSON response detailing the input parameters, including data formats, limitations on acceptable ranges, and dependencies with related parameters for the country or countries matching the provided countries or well known text value.

    Query parameters include:
    • api_key
    • countries
    • wkt
    Examples:
    GET  https://developer.nrel.gov/api/opencarto/rede/v1/technical-potential/config?countries=Indonesia,Bangladesh&api_key={key}
    GET  https://developer.nrel.gov/api/opencarto/rede/v1/technical-potential/config?wkt=POINT(77.216 28.644)&api_key={key}

    v1/technical-potential
    Provides access to all functions for performing and managing a single analysis scenario. This endpoint respects HTTP verbs to provide the following features.

    POST
    Full documentation for submitting a POST request containing the desired job parameters can be found in the [do stuff section]. If a valid job is submitted this endpoint will return a jobId that can be used in subsequent calls for fetching job status and results.

    GET
    Retrieves the status of a job while processing, or the results of a job once complete. Query parameters include:
    • api_key
    • jobId
    Example:
    GET  https://developer.nrel.gov/api/opencarto/rede/v1/technical-potential?jobId=tpot_result_singapore_2251&api_key={key}

    DELETE
    Destroys the database and mapping assets created by an analysis job. The job summary data is never deleted. Query parameters include:
    • api_key
    • jobId
    Example:
    DELETE  https://developer.nrel.gov/api/opencarto/rede/v1/technical-potential?jobId=tpot_result_singapore_2251&api_key={key}

    User Workflow


    To use this API, first load the analysis configuration for the location(s) of interest. Then create a REDE Technical Potential analysis job by posting a set input parameters in JSON format as described below to the v1/technical-potential endpoint along with your API key.

    At the time of job submission, a Technical Potential analysis is scheduled and a unique job identifier is returned as part of the API response. To check on the job status, the job identifier is submitted to the v1/technical-potential endpoint (where the <jobId> is the response from the job creation POST). If the task has completed, the status indicator (found in the outputs > status response) will read 'finished' and the results will be returned. Otherwise, the status indicator will note that the job is still in process or has encountered errors.

    The v1/technical-potential endpoint can be polled on a continuing basis until the status is updated and results are returned.

    Note, an API key is required on all API requests. See API key usage for more information.

    Loading Scenario Configuration for Location
    GET  https://developer.nrel.gov/api/opencarto/rede/v1/technical-potential/config?wkt=POINT(77.216 28.644)&api_key={key}

    Creating an Analysis Job
    POST  https://developer.nrel.gov/api/opencarto/rede/v1/technical-potential?api_key={key}
    
        -data {"region": "6", "resource": "32", "excludeProtectedAreas": "true", ...}

    Checking Results
    GET  https://developer.nrel.gov/api/opencarto/rede/v1/technical-potential?jobId={thejobid}&api_key={key}

    Formatting and Posting a Job


    The v1/technical-potential endpoint accepts a JSON post of a Technical Potential Scenario, a set of nested input parameters. The possible scenario inputs for a given country/region will vary depending on the data resources available to perform this analysis for each region. It is necessary to inspect the configuration data to identify the full range of possible scenario inputs.

    Examples

    Below is an example of a Technical Potential configuration response for a given country/region.

    
      {
        "metadata": {
            "version": "1.0.0",
            "resultset": {
                "count": 1
            }
        },
        "inputs": {
            "wkt": "POINT(77.216 28.644)"
        },
        "outputs": [
            {
                "id": 6,
                "region": {
                    "id": 6,
                    "label": "India"
                },
                "availableResources": [
                    {
                        "resource": {
                            "id": 14,
                            "key": "fixlat",
                            "label": "Fixed Tilt PV System",
                            "defaultPowerDensity": 36
                        },
                        "inputFields": [
                            {
                                "fieldId": 3,
                                "fieldName": "excludeProtectedAreas",
                                "dataType": "boolean"
                            },
                            {
                                "fieldId": 7,
                                "fieldName": "limitBySlope",
                                "dataType": "min and/or max as number"
                            },
                            {
                                "fieldId": 6,
                                "fieldName": "limitToTransmissionCorridors",
                                "dataType": "distance as number and units as one of kilometers or miles",
                                "fieldValues": {
                                    "distance": [
                                        1,
                                        5,
                                        10,
                                        15,
                                        20,
                                        50,
                                        100
                                    ],
                                    "units": [
                                        "kilometers"
                                    ]
                                }
                            },
                            {
                                "fieldId": 17,
                                "fieldName": "powerDensity",
                                "dataType": "number"
                            },
                            {
                                "fieldId": 18,
                                "fieldName": "limitBySolarResource",
                                "dataType": "min and/or max as number",
                                "defaultValue": {
                                    "min": 2,
                                    "max": 9
                                }
                            },
                            {
                                "fieldId": 5,
                                "fieldName": "limitToRoadCorridors",
                                "dataType": "distance as number and units as one of kilometers or miles",
                                "fieldValues": {
                                    "distance": [
                                        1,
                                        5,
                                        10,
                                        15,
                                        20,
                                        50,
                                        100
                                    ],
                                    "units": [
                                        "kilometers"
                                    ]
                                }
                            },
                            {
                                "fieldId": 8,
                                "fieldName": "limitByGeographicExtent",
                                "dataType": "array of strings including only provided geographic extents",
                                "fieldValues": [
                                    "Andaman and Nicobar",
                                    "Andhra Pradesh",
                                    "Arunachal Pradesh",
                                    "Assam",
                                    "Bihar",
                                    "Chandigarh",
                                    "Chhattisgarh",
                                    "Dadra and Nagar Haveli",
                                    "Daman and Diu",
                                    "Delhi",
                                    "Goa",
                                    "Gujarat",
                                    "Haryana",
                                    "Himachal Pradesh",
                                    "Jammu & Kashmir",
                                    "Jharkhand",
                                    "Karnataka",
                                    "Kerala",
                                    "Lakshadweep",
                                    "Madhya Pradesh",
                                    "Maharashtra",
                                    "Manipur",
                                    "Meghalaya",
                                    "Mizoram",
                                    "Nagaland",
                                    "Orissa",
                                    "Puducherry",
                                    "Punjab",
                                    "Rajasthan",
                                    "Sikkim",
                                    "Tamil Nadu",
                                    "Telangana",
                                    "Tripura",
                                    "Uttarakhand",
                                    "Uttar Pradesh",
                                    "West Bengal"
                                ]
                            },
                            {
                                "fieldId": 4,
                                "fieldName": "limitByLandUse",
                                "dataType": "array of strings including only provided land use types",
                                "fieldValues": [
                                    "Barren or Sparsely Vegetated",
                                    "Cropland/Grassland Mosaic",
                                    "Cropland/Woodland Mosaic",
                                    "Deciduous Broadleaf Forest",
                                    "Dryland Cropland and Pasture",
                                    "Evergreen Broadleaf Forest",
                                    "Evergreen Needleleaf Forest",
                                    "Grassland",
                                    "Herbaceous Wetland",
                                    "Irrigated Cropland and Pasture",
                                    "Mixed Forest",
                                    "Mixed Shrubland/Grassland",
                                    "Mixed Tundra",
                                    "Savanna",
                                    "Shrubland",
                                    "Snow or Ice",
                                    "Urban and Built-Up Land",
                                    "Water Bodies",
                                    "Wooded Tundra",
                                    "Wooded Wetland"
                                ]
                            }
                        ]
                    },
                    {
                        "resource": {
                            "id": 15,
                            "key": "csp",
                            "label": "CSP",
                            "defaultPowerDensity": 29
                        },
                        "inputFields": [
                            {
                                "fieldId": 3,
                                "fieldName": "excludeProtectedAreas",
                                "dataType": "boolean"
                            },
                            {
                                "fieldId": 7,
                                "fieldName": "limitBySlope",
                                "dataType": "min and/or max as number"
                            },
                            {
                                "fieldId": 6,
                                "fieldName": "limitToTransmissionCorridors",
                                "dataType": "distance as number and units as one of kilometers or miles",
                                "fieldValues": {
                                    "distance": [
                                        1,
                                        5,
                                        10,
                                        15,
                                        20,
                                        50,
                                        100
                                    ],
                                    "units": [
                                        "kilometers"
                                    ]
                                }
                            },
                            {
                                "fieldId": 2,
                                "fieldName": "limitBySolarResource",
                                "dataType": "min and/or max as number",
                                "defaultValue": {
                                    "min": 2,
                                    "max": 9
                                }
                            },
                            {
                                "fieldId": 17,
                                "fieldName": "powerDensity",
                                "dataType": "number"
                            },
                            {
                                "fieldId": 5,
                                "fieldName": "limitToRoadCorridors",
                                "dataType": "distance as number and units as one of kilometers or miles",
                                "fieldValues": {
                                    "distance": [
                                        1,
                                        5,
                                        10,
                                        15,
                                        20,
                                        50,
                                        100
                                    ],
                                    "units": [
                                        "kilometers"
                                    ]
                                }
                            },
                            {
                                "fieldId": 8,
                                "fieldName": "limitByGeographicExtent",
                                "dataType": "array of strings including only provided geographic extents",
                                "fieldValues": [
                                    "Andaman and Nicobar",
                                    "Andhra Pradesh",
                                    "Arunachal Pradesh",
                                    "Assam",
                                    "Bihar",
                                    "Chandigarh",
                                    "Chhattisgarh",
                                    "Dadra and Nagar Haveli",
                                    "Daman and Diu",
                                    "Delhi",
                                    "Goa",
                                    "Gujarat",
                                    "Haryana",
                                    "Himachal Pradesh",
                                    "Jammu & Kashmir",
                                    "Jharkhand",
                                    "Karnataka",
                                    "Kerala",
                                    "Lakshadweep",
                                    "Madhya Pradesh",
                                    "Maharashtra",
                                    "Manipur",
                                    "Meghalaya",
                                    "Mizoram",
                                    "Nagaland",
                                    "Orissa",
                                    "Puducherry",
                                    "Punjab",
                                    "Rajasthan",
                                    "Sikkim",
                                    "Tamil Nadu",
                                    "Telangana",
                                    "Tripura",
                                    "Uttarakhand",
                                    "Uttar Pradesh",
                                    "West Bengal"
                                ]
                            },
                            {
                                "fieldId": 4,
                                "fieldName": "limitByLandUse",
                                "dataType": "array of strings including only provided land use types",
                                "fieldValues": [
                                    "Barren or Sparsely Vegetated",
                                    "Cropland/Grassland Mosaic",
                                    "Cropland/Woodland Mosaic",
                                    "Deciduous Broadleaf Forest",
                                    "Dryland Cropland and Pasture",
                                    "Evergreen Broadleaf Forest",
                                    "Evergreen Needleleaf Forest",
                                    "Grassland",
                                    "Herbaceous Wetland",
                                    "Irrigated Cropland and Pasture",
                                    "Mixed Forest",
                                    "Mixed Shrubland/Grassland",
                                    "Mixed Tundra",
                                    "Savanna",
                                    "Shrubland",
                                    "Snow or Ice",
                                    "Urban and Built-Up Land",
                                    "Water Bodies",
                                    "Wooded Tundra",
                                    "Wooded Wetland"
                                ]
                            }
                        ]
                    },
                    {
                        "resource": {
                            "id": 13,
                            "key": "axis1",
                            "label": "1 Axis Tracking PV System",
                            "defaultPowerDensity": 31
                        },
                        "inputFields": [
                            {
                                "fieldId": 3,
                                "fieldName": "excludeProtectedAreas",
                                "dataType": "boolean"
                            },
                            {
                                "fieldId": 7,
                                "fieldName": "limitBySlope",
                                "dataType": "min and/or max as number"
                            },
                            {
                                "fieldId": 6,
                                "fieldName": "limitToTransmissionCorridors",
                                "dataType": "distance as number and units as one of kilometers or miles",
                                "fieldValues": {
                                    "distance": [
                                        1,
                                        5,
                                        10,
                                        15,
                                        20,
                                        50,
                                        100
                                    ],
                                    "units": [
                                        "kilometers"
                                    ]
                                }
                            },
                            {
                                "fieldId": 17,
                                "fieldName": "powerDensity",
                                "dataType": "number"
                            },
                            {
                                "fieldId": 18,
                                "fieldName": "limitBySolarResource",
                                "dataType": "min and/or max as number",
                                "defaultValue": {
                                    "min": 2,
                                    "max": 9
                                }
                            },
                            {
                                "fieldId": 5,
                                "fieldName": "limitToRoadCorridors",
                                "dataType": "distance as number and units as one of kilometers or miles",
                                "fieldValues": {
                                    "distance": [
                                        1,
                                        5,
                                        10,
                                        15,
                                        20,
                                        50,
                                        100
                                    ],
                                    "units": [
                                        "kilometers"
                                    ]
                                }
                            },
                            {
                                "fieldId": 8,
                                "fieldName": "limitByGeographicExtent",
                                "dataType": "array of strings including only provided geographic extents",
                                "fieldValues": [
                                    "Andaman and Nicobar",
                                    "Andhra Pradesh",
                                    "Arunachal Pradesh",
                                    "Assam",
                                    "Bihar",
                                    "Chandigarh",
                                    "Chhattisgarh",
                                    "Dadra and Nagar Haveli",
                                    "Daman and Diu",
                                    "Delhi",
                                    "Goa",
                                    "Gujarat",
                                    "Haryana",
                                    "Himachal Pradesh",
                                    "Jammu & Kashmir",
                                    "Jharkhand",
                                    "Karnataka",
                                    "Kerala",
                                    "Lakshadweep",
                                    "Madhya Pradesh",
                                    "Maharashtra",
                                    "Manipur",
                                    "Meghalaya",
                                    "Mizoram",
                                    "Nagaland",
                                    "Orissa",
                                    "Puducherry",
                                    "Punjab",
                                    "Rajasthan",
                                    "Sikkim",
                                    "Tamil Nadu",
                                    "Telangana",
                                    "Tripura",
                                    "Uttarakhand",
                                    "Uttar Pradesh",
                                    "West Bengal"
                                ]
                            },
                            {
                                "fieldId": 4,
                                "fieldName": "limitByLandUse",
                                "dataType": "array of strings including only provided land use types",
                                "fieldValues": [
                                    "Barren or Sparsely Vegetated",
                                    "Cropland/Grassland Mosaic",
                                    "Cropland/Woodland Mosaic",
                                    "Deciduous Broadleaf Forest",
                                    "Dryland Cropland and Pasture",
                                    "Evergreen Broadleaf Forest",
                                    "Evergreen Needleleaf Forest",
                                    "Grassland",
                                    "Herbaceous Wetland",
                                    "Irrigated Cropland and Pasture",
                                    "Mixed Forest",
                                    "Mixed Shrubland/Grassland",
                                    "Mixed Tundra",
                                    "Savanna",
                                    "Shrubland",
                                    "Snow or Ice",
                                    "Urban and Built-Up Land",
                                    "Water Bodies",
                                    "Wooded Tundra",
                                    "Wooded Wetland"
                                ]
                            }
                        ]
                    },
                    {
                        "resource": {
                            "id": 32,
                            "key": "wind_t200",
                            "label": "Wind T-200",
                            "defaultPowerDensity": 3
                        },
                        "inputFields": [
                            {
                                "fieldId": 3,
                                "fieldName": "excludeProtectedAreas",
                                "dataType": "boolean"
                            },
                            {
                                "fieldId": 7,
                                "fieldName": "limitBySlope",
                                "dataType": "min and/or max as number"
                            },
                            {
                                "fieldId": 6,
                                "fieldName": "limitToTransmissionCorridors",
                                "dataType": "distance as number and units as one of kilometers or miles",
                                "fieldValues": {
                                    "distance": [
                                        1,
                                        5,
                                        10,
                                        15,
                                        20,
                                        50,
                                        100
                                    ],
                                    "units": [
                                        "kilometers"
                                    ]
                                }
                            },
                            {
                                "fieldId": 17,
                                "fieldName": "powerDensity",
                                "dataType": "number"
                            },
                            {
                                "fieldId": 5,
                                "fieldName": "limitToRoadCorridors",
                                "dataType": "distance as number and units as one of kilometers or miles",
                                "fieldValues": {
                                    "distance": [
                                        1,
                                        5,
                                        10,
                                        15,
                                        20,
                                        50,
                                        100
                                    ],
                                    "units": [
                                        "kilometers"
                                    ]
                                }
                            },
                            {
                                "fieldId": 21,
                                "fieldName": "limitByWindSpeed",
                                "dataType": "min and/or max as number",
                                "defaultValue": {
                                    "min": 3,
                                    "max": null
                                }
                            },
                            {
                                "fieldId": 8,
                                "fieldName": "limitByGeographicExtent",
                                "dataType": "array of strings including only provided geographic extents",
                                "fieldValues": [
                                    "Andaman and Nicobar",
                                    "Andhra Pradesh",
                                    "Arunachal Pradesh",
                                    "Assam",
                                    "Bihar",
                                    "Chandigarh",
                                    "Chhattisgarh",
                                    "Dadra and Nagar Haveli",
                                    "Daman and Diu",
                                    "Delhi",
                                    "Goa",
                                    "Gujarat",
                                    "Haryana",
                                    "Himachal Pradesh",
                                    "Jammu & Kashmir",
                                    "Jharkhand",
                                    "Karnataka",
                                    "Kerala",
                                    "Lakshadweep",
                                    "Madhya Pradesh",
                                    "Maharashtra",
                                    "Manipur",
                                    "Meghalaya",
                                    "Mizoram",
                                    "Nagaland",
                                    "Orissa",
                                    "Puducherry",
                                    "Punjab",
                                    "Rajasthan",
                                    "Sikkim",
                                    "Tamil Nadu",
                                    "Telangana",
                                    "Tripura",
                                    "Uttarakhand",
                                    "Uttar Pradesh",
                                    "West Bengal"
                                ]
                            },
                            {
                                "fieldId": 4,
                                "fieldName": "limitByLandUse",
                                "dataType": "array of strings including only provided land use types",
                                "fieldValues": [
                                    "Barren or Sparsely Vegetated",
                                    "Cropland/Grassland Mosaic",
                                    "Cropland/Woodland Mosaic",
                                    "Deciduous Broadleaf Forest",
                                    "Dryland Cropland and Pasture",
                                    "Evergreen Broadleaf Forest",
                                    "Evergreen Needleleaf Forest",
                                    "Grassland",
                                    "Herbaceous Wetland",
                                    "Irrigated Cropland and Pasture",
                                    "Mixed Forest",
                                    "Mixed Shrubland/Grassland",
                                    "Mixed Tundra",
                                    "Savanna",
                                    "Shrubland",
                                    "Snow or Ice",
                                    "Urban and Built-Up Land",
                                    "Water Bodies",
                                    "Wooded Tundra",
                                    "Wooded Wetland"
                                ]
                            }
                        ]
                    },
                    {
                        "resource": {
                            "id": 35,
                            "key": "wind_t255",
                            "label": "Wind T-255",
                            "defaultPowerDensity": 3
                        },
                        "inputFields": [
                            {
                                "fieldId": 3,
                                "fieldName": "excludeProtectedAreas",
                                "dataType": "boolean"
                            },
                            {
                                "fieldId": 7,
                                "fieldName": "limitBySlope",
                                "dataType": "min and/or max as number"
                            },
                            {
                                "fieldId": 6,
                                "fieldName": "limitToTransmissionCorridors",
                                "dataType": "distance as number and units as one of kilometers or miles",
                                "fieldValues": {
                                    "distance": [
                                        1,
                                        5,
                                        10,
                                        15,
                                        20,
                                        50,
                                        100
                                    ],
                                    "units": [
                                        "kilometers"
                                    ]
                                }
                            },
                            {
                                "fieldId": 17,
                                "fieldName": "powerDensity",
                                "dataType": "number"
                            },
                            {
                                "fieldId": 5,
                                "fieldName": "limitToRoadCorridors",
                                "dataType": "distance as number and units as one of kilometers or miles",
                                "fieldValues": {
                                    "distance": [
                                        1,
                                        5,
                                        10,
                                        15,
                                        20,
                                        50,
                                        100
                                    ],
                                    "units": [
                                        "kilometers"
                                    ]
                                }
                            },
                            {
                                "fieldId": 21,
                                "fieldName": "limitByWindSpeed",
                                "dataType": "min and/or max as number",
                                "defaultValue": {
                                    "min": 3,
                                    "max": null
                                }
                            },
                            {
                                "fieldId": 8,
                                "fieldName": "limitByGeographicExtent",
                                "dataType": "array of strings including only provided geographic extents",
                                "fieldValues": [
                                    "Andaman and Nicobar",
                                    "Andhra Pradesh",
                                    "Arunachal Pradesh",
                                    "Assam",
                                    "Bihar",
                                    "Chandigarh",
                                    "Chhattisgarh",
                                    "Dadra and Nagar Haveli",
                                    "Daman and Diu",
                                    "Delhi",
                                    "Goa",
                                    "Gujarat",
                                    "Haryana",
                                    "Himachal Pradesh",
                                    "Jammu & Kashmir",
                                    "Jharkhand",
                                    "Karnataka",
                                    "Kerala",
                                    "Lakshadweep",
                                    "Madhya Pradesh",
                                    "Maharashtra",
                                    "Manipur",
                                    "Meghalaya",
                                    "Mizoram",
                                    "Nagaland",
                                    "Orissa",
                                    "Puducherry",
                                    "Punjab",
                                    "Rajasthan",
                                    "Sikkim",
                                    "Tamil Nadu",
                                    "Telangana",
                                    "Tripura",
                                    "Uttarakhand",
                                    "Uttar Pradesh",
                                    "West Bengal"
                                ]
                            },
                            {
                                "fieldId": 4,
                                "fieldName": "limitByLandUse",
                                "dataType": "array of strings including only provided land use types",
                                "fieldValues": [
                                    "Barren or Sparsely Vegetated",
                                    "Cropland/Grassland Mosaic",
                                    "Cropland/Woodland Mosaic",
                                    "Deciduous Broadleaf Forest",
                                    "Dryland Cropland and Pasture",
                                    "Evergreen Broadleaf Forest",
                                    "Evergreen Needleleaf Forest",
                                    "Grassland",
                                    "Herbaceous Wetland",
                                    "Irrigated Cropland and Pasture",
                                    "Mixed Forest",
                                    "Mixed Shrubland/Grassland",
                                    "Mixed Tundra",
                                    "Savanna",
                                    "Shrubland",
                                    "Snow or Ice",
                                    "Urban and Built-Up Land",
                                    "Water Bodies",
                                    "Wooded Tundra",
                                    "Wooded Wetland"
                                ]
                            }
                        ]
                    },
                    {
                        "resource": {
                            "id": 34,
                            "key": "wind_t245",
                            "label": "Wind T-245",
                            "defaultPowerDensity": 3
                        },
                        "inputFields": [
                            {
                                "fieldId": 3,
                                "fieldName": "excludeProtectedAreas",
                                "dataType": "boolean"
                            },
                            {
                                "fieldId": 7,
                                "fieldName": "limitBySlope",
                                "dataType": "min and/or max as number"
                            },
                            {
                                "fieldId": 6,
                                "fieldName": "limitToTransmissionCorridors",
                                "dataType": "distance as number and units as one of kilometers or miles",
                                "fieldValues": {
                                    "distance": [
                                        1,
                                        5,
                                        10,
                                        15,
                                        20,
                                        50,
                                        100
                                    ],
                                    "units": [
                                        "kilometers"
                                    ]
                                }
                            },
                            {
                                "fieldId": 17,
                                "fieldName": "powerDensity",
                                "dataType": "number"
                            },
                            {
                                "fieldId": 5,
                                "fieldName": "limitToRoadCorridors",
                                "dataType": "distance as number and units as one of kilometers or miles",
                                "fieldValues": {
                                    "distance": [
                                        1,
                                        5,
                                        10,
                                        15,
                                        20,
                                        50,
                                        100
                                    ],
                                    "units": [
                                        "kilometers"
                                    ]
                                }
                            },
                            {
                                "fieldId": 21,
                                "fieldName": "limitByWindSpeed",
                                "dataType": "min and/or max as number",
                                "defaultValue": {
                                    "min": 3,
                                    "max": null
                                }
                            },
                            {
                                "fieldId": 8,
                                "fieldName": "limitByGeographicExtent",
                                "dataType": "array of strings including only provided geographic extents",
                                "fieldValues": [
                                    "Andaman and Nicobar",
                                    "Andhra Pradesh",
                                    "Arunachal Pradesh",
                                    "Assam",
                                    "Bihar",
                                    "Chandigarh",
                                    "Chhattisgarh",
                                    "Dadra and Nagar Haveli",
                                    "Daman and Diu",
                                    "Delhi",
                                    "Goa",
                                    "Gujarat",
                                    "Haryana",
                                    "Himachal Pradesh",
                                    "Jammu & Kashmir",
                                    "Jharkhand",
                                    "Karnataka",
                                    "Kerala",
                                    "Lakshadweep",
                                    "Madhya Pradesh",
                                    "Maharashtra",
                                    "Manipur",
                                    "Meghalaya",
                                    "Mizoram",
                                    "Nagaland",
                                    "Orissa",
                                    "Puducherry",
                                    "Punjab",
                                    "Rajasthan",
                                    "Sikkim",
                                    "Tamil Nadu",
                                    "Telangana",
                                    "Tripura",
                                    "Uttarakhand",
                                    "Uttar Pradesh",
                                    "West Bengal"
                                ]
                            },
                            {
                                "fieldId": 4,
                                "fieldName": "limitByLandUse",
                                "dataType": "array of strings including only provided land use types",
                                "fieldValues": [
                                    "Barren or Sparsely Vegetated",
                                    "Cropland/Grassland Mosaic",
                                    "Cropland/Woodland Mosaic",
                                    "Deciduous Broadleaf Forest",
                                    "Dryland Cropland and Pasture",
                                    "Evergreen Broadleaf Forest",
                                    "Evergreen Needleleaf Forest",
                                    "Grassland",
                                    "Herbaceous Wetland",
                                    "Irrigated Cropland and Pasture",
                                    "Mixed Forest",
                                    "Mixed Shrubland/Grassland",
                                    "Mixed Tundra",
                                    "Savanna",
                                    "Shrubland",
                                    "Snow or Ice",
                                    "Urban and Built-Up Land",
                                    "Water Bodies",
                                    "Wooded Tundra",
                                    "Wooded Wetland"
                                ]
                            }
                        ]
                    },
                    {
                        "resource": {
                            "id": 33,
                            "key": "wind_t237",
                            "label": "Wind T-237",
                            "defaultPowerDensity": 3
                        },
                        "inputFields": [
                            {
                                "fieldId": 3,
                                "fieldName": "excludeProtectedAreas",
                                "dataType": "boolean"
                            },
                            {
                                "fieldId": 7,
                                "fieldName": "limitBySlope",
                                "dataType": "min and/or max as number"
                            },
                            {
                                "fieldId": 6,
                                "fieldName": "limitToTransmissionCorridors",
                                "dataType": "distance as number and units as one of kilometers or miles",
                                "fieldValues": {
                                    "distance": [
                                        1,
                                        5,
                                        10,
                                        15,
                                        20,
                                        50,
                                        100
                                    ],
                                    "units": [
                                        "kilometers"
                                    ]
                                }
                            },
                            {
                                "fieldId": 17,
                                "fieldName": "powerDensity",
                                "dataType": "number"
                            },
                            {
                                "fieldId": 5,
                                "fieldName": "limitToRoadCorridors",
                                "dataType": "distance as number and units as one of kilometers or miles",
                                "fieldValues": {
                                    "distance": [
                                        1,
                                        5,
                                        10,
                                        15,
                                        20,
                                        50,
                                        100
                                    ],
                                    "units": [
                                        "kilometers"
                                    ]
                                }
                            },
                            {
                                "fieldId": 21,
                                "fieldName": "limitByWindSpeed",
                                "dataType": "min and/or max as number",
                                "defaultValue": {
                                    "min": 3,
                                    "max": null
                                }
                            },
                            {
                                "fieldId": 8,
                                "fieldName": "limitByGeographicExtent",
                                "dataType": "array of strings including only provided geographic extents",
                                "fieldValues": [
                                    "Andaman and Nicobar",
                                    "Andhra Pradesh",
                                    "Arunachal Pradesh",
                                    "Assam",
                                    "Bihar",
                                    "Chandigarh",
                                    "Chhattisgarh",
                                    "Dadra and Nagar Haveli",
                                    "Daman and Diu",
                                    "Delhi",
                                    "Goa",
                                    "Gujarat",
                                    "Haryana",
                                    "Himachal Pradesh",
                                    "Jammu & Kashmir",
                                    "Jharkhand",
                                    "Karnataka",
                                    "Kerala",
                                    "Lakshadweep",
                                    "Madhya Pradesh",
                                    "Maharashtra",
                                    "Manipur",
                                    "Meghalaya",
                                    "Mizoram",
                                    "Nagaland",
                                    "Orissa",
                                    "Puducherry",
                                    "Punjab",
                                    "Rajasthan",
                                    "Sikkim",
                                    "Tamil Nadu",
                                    "Telangana",
                                    "Tripura",
                                    "Uttarakhand",
                                    "Uttar Pradesh",
                                    "West Bengal"
                                ]
                            },
                            {
                                "fieldId": 4,
                                "fieldName": "limitByLandUse",
                                "dataType": "array of strings including only provided land use types",
                                "fieldValues": [
                                    "Barren or Sparsely Vegetated",
                                    "Cropland/Grassland Mosaic",
                                    "Cropland/Woodland Mosaic",
                                    "Deciduous Broadleaf Forest",
                                    "Dryland Cropland and Pasture",
                                    "Evergreen Broadleaf Forest",
                                    "Evergreen Needleleaf Forest",
                                    "Grassland",
                                    "Herbaceous Wetland",
                                    "Irrigated Cropland and Pasture",
                                    "Mixed Forest",
                                    "Mixed Shrubland/Grassland",
                                    "Mixed Tundra",
                                    "Savanna",
                                    "Shrubland",
                                    "Snow or Ice",
                                    "Urban and Built-Up Land",
                                    "Water Bodies",
                                    "Wooded Tundra",
                                    "Wooded Wetland"
                                ]
                            }
                        ]
                    },
                    {
                        "resource": {
                            "id": 36,
                            "key": "wind_t325",
                            "label": "Wind T-325",
                            "defaultPowerDensity": 3
                        },
                        "inputFields": [
                            {
                                "fieldId": 3,
                                "fieldName": "excludeProtectedAreas",
                                "dataType": "boolean"
                            },
                            {
                                "fieldId": 7,
                                "fieldName": "limitBySlope",
                                "dataType": "min and/or max as number"
                            },
                            {
                                "fieldId": 6,
                                "fieldName": "limitToTransmissionCorridors",
                                "dataType": "distance as number and units as one of kilometers or miles",
                                "fieldValues": {
                                    "distance": [
                                        1,
                                        5,
                                        10,
                                        15,
                                        20,
                                        50,
                                        100
                                    ],
                                    "units": [
                                        "kilometers"
                                    ]
                                }
                            },
                            {
                                "fieldId": 17,
                                "fieldName": "powerDensity",
                                "dataType": "number"
                            },
                            {
                                "fieldId": 5,
                                "fieldName": "limitToRoadCorridors",
                                "dataType": "distance as number and units as one of kilometers or miles",
                                "fieldValues": {
                                    "distance": [
                                        1,
                                        5,
                                        10,
                                        15,
                                        20,
                                        50,
                                        100
                                    ],
                                    "units": [
                                        "kilometers"
                                    ]
                                }
                            },
                            {
                                "fieldId": 21,
                                "fieldName": "limitByWindSpeed",
                                "dataType": "min and/or max as number",
                                "defaultValue": {
                                    "min": 3,
                                    "max": null
                                }
                            },
                            {
                                "fieldId": 8,
                                "fieldName": "limitByGeographicExtent",
                                "dataType": "array of strings including only provided geographic extents",
                                "fieldValues": [
                                    "Andaman and Nicobar",
                                    "Andhra Pradesh",
                                    "Arunachal Pradesh",
                                    "Assam",
                                    "Bihar",
                                    "Chandigarh",
                                    "Chhattisgarh",
                                    "Dadra and Nagar Haveli",
                                    "Daman and Diu",
                                    "Delhi",
                                    "Goa",
                                    "Gujarat",
                                    "Haryana",
                                    "Himachal Pradesh",
                                    "Jammu & Kashmir",
                                    "Jharkhand",
                                    "Karnataka",
                                    "Kerala",
                                    "Lakshadweep",
                                    "Madhya Pradesh",
                                    "Maharashtra",
                                    "Manipur",
                                    "Meghalaya",
                                    "Mizoram",
                                    "Nagaland",
                                    "Orissa",
                                    "Puducherry",
                                    "Punjab",
                                    "Rajasthan",
                                    "Sikkim",
                                    "Tamil Nadu",
                                    "Telangana",
                                    "Tripura",
                                    "Uttarakhand",
                                    "Uttar Pradesh",
                                    "West Bengal"
                                ]
                            },
                            {
                                "fieldId": 4,
                                "fieldName": "limitByLandUse",
                                "dataType": "array of strings including only provided land use types",
                                "fieldValues": [
                                    "Barren or Sparsely Vegetated",
                                    "Cropland/Grassland Mosaic",
                                    "Cropland/Woodland Mosaic",
                                    "Deciduous Broadleaf Forest",
                                    "Dryland Cropland and Pasture",
                                    "Evergreen Broadleaf Forest",
                                    "Evergreen Needleleaf Forest",
                                    "Grassland",
                                    "Herbaceous Wetland",
                                    "Irrigated Cropland and Pasture",
                                    "Mixed Forest",
                                    "Mixed Shrubland/Grassland",
                                    "Mixed Tundra",
                                    "Savanna",
                                    "Shrubland",
                                    "Snow or Ice",
                                    "Urban and Built-Up Land",
                                    "Water Bodies",
                                    "Wooded Tundra",
                                    "Wooded Wetland"
                                ]
                            }
                        ]
                    }
                ]
            }
        ],
        "errors": [],
        "status": 200
    }
      

    Here is an example of a valid Technical Potential input scenario to POST

    
    {
        "region": "6",
        "resource": "32",
        "excludeProtectedAreas": "true",
        "limitBySlope": {
            "min": "1",
            "max": "12"
        },
        "limitToTransmissionCorridors": {
            "distance": "50",
            "units": "kilometers"
        },
        "powerDensity": "3",
        "limitToRoadCorridors": {
            "distance": "50",
            "units": "kilometers"
        },
        "limitByWindSpeed": {
            "min": "3",
            "max": "20"
        },
        "limitByGeographicExtent": [
            "Andaman and Nicobar",
            "Chhattisgarh"
        ],
        "limitByLandUse": [
            "Urban and Built-Up Land",
            "Water Bodies",
            "Wooded Wetland"
        ]
    }
    

    API Response

    The v1/technical-potential endpoint replies with a JSON consisting of the unique identifier of the new job in the outputs > jobId field.

     {
        "metadata": {
            "version": "1.0.0",
            "resultset": {
                "count": 1
            }
        },
        "inputs": {...},
        "outputs": {
            "jobId": "tpot_result_india_3513",
            "status": "queued"
        },
        "errors": [],
        "status": 200
      }
                    

    Input Object Data Format

    The v1/technical-potential/config endpoint replies with a JSON defining the possible inputs for a given location. The description of the fields is detailed in the table below including where each field would be used in forming a valid JSON request object when running an analysis job. For reference, the example above has one instance of each type of input field.

    Input Field Name Value Field Name used in POST request body
    outputs An array of configuration objects, one per relevant country/region The id field is used as the region field in the POST body
    availableResources An array of configuration objects, one per supported resource type in the country/region The id field is used as the resource field in the POST body
    inputFields An array of configuration objects, each defining a valid analysis input for the given resource in the given country/region
    • The fieldName field is used as the input key in the POST body
    • The dataType field defines the data type of the input field
    • The fieldValues field is an optional set of possible values for this field
    • The defaultValue field is an optional value showing a reasonable default value for this field

    Getting Results


    The v1/technical-potential endpoint replies to a GET request containing a query string specifying the jobId for which to retrieve results.

    GET https://developer.nrel.gov/api/opencarto/rede/v1/technical-potential?jobId=tpot_result_india_3513&api_key={key}

    API Response

    If results are not ready, the v1/technical-potential endpoint will respond with the message shown below. The outputs > status field will indicate queued or started. The URL can be polled at regular intervals, without rate-limiting, until the status changes to 'finished' indicating that results are ready.

    {
      "metadata": {
        "version": "1.0.0",
        "resultset": {
          "count": 1
        }
      },
      "inputs": {
        "jobId": "tpot_result_india_3513"
      },
      "outputs": {
        "disposition": "started",
        "status": "started",
        "runtime_seconds": 26.98
      },
      "errors": [],
      "status": 200
    }
        

    If results are ready, the Results URL returns a JSON containing inputs, outputs and messages. The Scenario directory will contain a 'status' designated as optimal.

    {
      "inputs": {
        "jobId": "tpot_result_india_3513"
      },
      "metadata": {
        "version": "1.0.0",
        "resultset": {
          "count": 1
        }
      },
      "status": 200,
      "outputs": {
        "disposition": "finished",
        "status": "finished",
        "map_data_deleted": true,
        "runtime_seconds": 33,
        "results": {
          "cumulative_stats": {
            "total_nameplate_capacity_mw": 159505.72,
            "total_ac_generation_mwh": 186734332.23,
            "total_land_area_sq_km": 53168.58,
            "min": 0,
            "max": 6,
            "classes": [
              {
                "nameplate_capacity_mw": 18032.3,
                "ac_generation_mwh": 13315479.02,
                "land_area_sq_km": 6010.77,
                "min": 0.001,
                "max": 4
              },
              {
                "nameplate_capacity_mw": 84262.49,
                "ac_generation_mwh": 89380648.56,
                "land_area_sq_km": 28087.5,
                "min": 4,
                "max": 4.5
              },
              {
                "nameplate_capacity_mw": 51030.66,
                "ac_generation_mwh": 72680604.54,
                "land_area_sq_km": 17010.22,
                "min": 4.5,
                "max": 5
              },
              {
                "nameplate_capacity_mw": 5897.27,
                "ac_generation_mwh": 10723113.91,
                "land_area_sq_km": 1965.76,
                "min": 5,
                "max": 5.5
              },
              {
                "nameplate_capacity_mw": 279.28,
                "ac_generation_mwh": 624751.38,
                "land_area_sq_km": 93.09,
                "min": 5.5,
                "max": 6
              },
              {
                "nameplate_capacity_mw": 3.72,
                "ac_generation_mwh": 9734.82,
                "land_area_sq_km": 1.24,
                "min": 6,
                "max": 6.5
              }
            ]
          },
          "regional_stats": {
            "Chhattisgarh": {
              "total_nameplate_capacity_mw": 159505.72,
              "total_ac_generation_mwh": 186734332.23,
              "total_land_area_sq_km": 53168.58,
              "regional_min": 1,
              "regional_max": 6,
              "classes": [
                {
                  "nameplate_capacity_mw": 18032.3,
                  "ac_generation_mwh": 13315479.02,
                  "land_area_sq_km": 6010.77,
                  "min": 0.001,
                  "max": 4
                },
                {
                  "nameplate_capacity_mw": 84262.49,
                  "ac_generation_mwh": 89380648.56,
                  "land_area_sq_km": 28087.5,
                  "min": 4,
                  "max": 4.5
                },
                {
                  "nameplate_capacity_mw": 51030.66,
                  "ac_generation_mwh": 72680604.54,
                  "land_area_sq_km": 17010.22,
                  "min": 4.5,
                  "max": 5
                },
                {
                  "nameplate_capacity_mw": 5897.27,
                  "ac_generation_mwh": 10723113.91,
                  "land_area_sq_km": 1965.76,
                  "min": 5,
                  "max": 5.5
                },
                {
                  "nameplate_capacity_mw": 279.28,
                  "ac_generation_mwh": 624751.38,
                  "land_area_sq_km": 93.09,
                  "min": 5.5,
                  "max": 6
                },
                {
                  "nameplate_capacity_mw": 3.72,
                  "ac_generation_mwh": 9734.82,
                  "land_area_sq_km": 1.24,
                  "min": 6,
                  "max": 6.5
                }
              ]
            }
          },
          "resource_data": {
            "type": "wind_t200",
            "units": "kWh/m2/day"
          }
        }
      },
      "errors": []
    }
      

    Inputs

    Inputs echoes back the JSON representation of the Technical Potential scenario inputs provided to create this analysis job</a>.


    Outputs

    Outputs provides the results of the anlaysis.

    Output Field Name Value
    results Location of the analysis results
    cumulative_stats Aggregated outputs for the entire set of selected sub-regions
    regional_stats Calculated outputs for each of the individually selected sub-regions
    classes Logical binning of outputs for ease of charting and mapping
    resource_data Metadata defining the resource that was the subject of the analysis (type of solar or wind generator)

    Metadata

    The metadata section contains tool versioning and other high level information.


    Errors

    The errors section contains messages detailing any errors should they have occurred.

    POST request example


    An example of a valid POST request made using the cUrl command line tool.

            
    curl -X POST \
      https://developer.nrel.gov/api/opencarto/rede/v1/technical-potential?api_key={KEY} \
      -H 'Content-Type: application/json' \
      -H 'Pragma: no-cache' \
      -H 'cache-control: no-cache' \
      -d '{
        "region": "6",
        "resource": "32",
        "excludeProtectedAreas": "true",
        "limitBySlope": {
            "min": "1",
            "max": "12"
        },
        "limitToTransmissionCorridors": {
            "distance": "50",
            "units": "kilometers"
        },
        "powerDensity": "3",
        "limitToRoadCorridors": {
            "distance": "50",
            "units": "kilometers"
        },
        "limitByWindSpeed": {
            "min": "3",
            "max": "20"
        },
        "limitByGeographicExtent": [
            "Andaman and Nicobar",
            "Chhattisgarh"
        ],
        "limitByLandUse": [
            "Urban and Built-Up Land",
            "Water Bodies",
            "Wooded Wetland"
        ]
    }'
            
        
    Help Improve this Content