Solagis TS API integration setup

In this guide, we will explain how to set up the Solargis Time Series API integration.

To setup the integration, we recommend using our FREE dedicated API integration setup endpoint defined in this guide to perform testing calls. This will help you set up your API without spending any subscription credits.

You will need an API token to connect to the platform. To get one, our sales team must create an integration account for you where you will generate the API tokens. They are generated in the company admin section, and you can learn how to generate one here.

Tip: If your integration has already been set, you can learn how to obtain the requestId for your Time Series data here.

Integration setup endpoint parameters

Use the parameters below to configure your request. The endpoint is free to access and does not incur any charges to your account. You will need to generate an API token to include in the request for authorisation. You can learn how to generate one here.

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.

{
  "site": {
    "latitude": 48.88375,
    "longitude": 20.159472,
    "siteName": "Basic example Site"
  },
  "timeStep": "PT15M",
  "columns": [
    "GHI",
    "DNI",
    "DIF",
    "GHI_NOSHD",
    "DNI_NOSHD",
    "DIF_NOSHD",
    "GTI_NOSHD",
    "GTI",
    "CI_FLAG",
    "SUN_ELEVATION",
    "SUN_AZIMUTH",
    "PANEL_AZIMUTH",
    "PANEL_TILT",
    "PANEL_INC",
    "TEMP",
    "WS",
    "WD",
    "WG",
    "RH",
    "AP",
    "PWAT",
    "PREC",
    "TD",
    "WBT",
    "SDWE",
    "SFWE"
  ],
  "fromDate": "AUTODETECT",
  "toDate": "2023-12-31",
  "utcOffset": "+01:00",
  "outputFormat": "SOLARGIS_JSON",
  "timeAlignment": "CENTER",
  "terrainShading": true,
  "environment": {
    "surfaceAlbedo": 0.12,
    "horizon": {
      "azimuth": [
        0,
        37.5,
        60,
        82.5,
        105,
        127.5,
        150,
        172.5,
        195,
        217.5,
        240,
        262.5,
        285,
        307.5,
        330,
        352.5
      ],
      "height": [
        0.705,
        1.0588235,
        1.058894,
        1.428,
        0.70588764,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ]
    }
  },
  "gtiConfiguration": {
    "layout": {
      "mounting": {
        "type": "FIXED_ONE_ANGLE",
        "tilt": 39
      }
    }
  },
  "fileLabel": "Integration_example",
  "compressOutput": false
}

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. Here are the key points to remember when switching to production requests:

• You need to change the integration endpoint (https://api.solargis.com/ts-integration/data-request) to the production endpoint (https://api.solargis.com/ts/data-request).

• You will need to generate your own API token linked to your Solargis account and use that in every production call.

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