Solargis TMY API integration setup

In this guide, we will provide information about how to set up the TMY data API integration. The endpoint provided here is for integration purposes only and does not allow you to download location data from your live Solargis account.

Key points to remember before you proceed:

• Our Sales team must create an integration account for you. Contact them if you do not have one already.

• You will need to generate an API token to authenticate calls to the integration account.

• Calls to the integration API are free of charge.

• There is no testing facility (API console) provided in this knowledge base to test the integration API calls. You must use a third-party service such as Postman.

TMY integration endpoints

There is a separate integration testing request for every subscription (TMY Basic and TMY Pro).

Key parameters of the requests are:

• The endpoint URL is identical for both requests.

• API tokens are generated separately for TMY Basic and TMY Pro integrations.

• The body parameters differ for TMY Basic and TMY Pro. Ensure you use the correct one for your subscription type.

Integration setup parameters

When setting up your integration and executing the API calls, select the appropriate API parameters below according to your subscription type (TMY Basic or TMY Pro) to prevent errors.  

Important: Do not modify any of the request body parameters. The endpoint will only accept the parameters exactly as listed in the table; any changes will cause the call to fail.

TMY Basic integration setup

{
    "latitude": 48.61259,
    "longitude": 20.827079,
    "timeStep": "PT60M",
    "tmyScenario": "P50",
    "siteName": "Basic example Site",
    "fileLabel": "basic_01",
    "outputFormats": ["SOLARGIS_CSV", "SOLARGIS_JSON", "SAM", "HELIOSCOPE"]
}

TMY Pro integration setup

{
     "latitude": 48.61259,
     "longitude": 20.827079,
     "timeStep": "PT60M",
     "tmyScenario": "P50",
     "siteName": "Pro example Site",
     "fileLabel": "pro_01",
     "outputFormats": ["SOLARGIS_CSV", "SOLARGIS_JSON", "SAM", "HELIOSCOPE"]
}

Progressing from integration to production requests

Once you have set your integration and the response is successfully coming through, you can proceed to switch to the production servers and start downloading your data from your live Solargis account. Here are the key points to remember when switching to production requests:

• You need to change the integration endpoint (https://api.solargis.com/tmy-integration/data-request) to the production endpoint (https://api.solargis.com/tmy/data-request). Details are included in the TMY requestId and TMY get data guides.

• You will need to generate a new API token for your live account to get the data from your live project.

Production calls (paid calls) can be executed directly from this API documentation platform, and you can learn how to use it here.