API TMY data

  • Updated on Dec 20, 2024
  • Published on Dec 19, 2024
  • 2 minute(s) read
  • MK

In this document

You will learn how to set up API access to TMY data and generate tokens.

Subscription to API TMY

Only account administrators are allowed to manage subscriptions. If you are a standard user please contact your administrator who can grant you access to API TMY Subscriptions.

Log into your company account at apps.solargis.com.

If you are logged into your personal account, please follow the instructions below to switch to your company account:

  1. Click on the icon in the top right corner to see the drop-down menu

  2. From the options that appear below, please select the account related to your API TMY

Now you can see the Solargis Dashboard and applications available to your company. Click on the main menu and select Company Admin.

You are redirected to the administration section of the account. Select APIs Subscriptions. By clicking on Manage, you will be able to create tokens, add a subscription name, or check the subscription validity.

Difference between API TMY basic and professional

The Basic version differs from the Professional one in the number of parameters and temporal resolution.

API TMY Basic

  • Parameters: GHI, DNI, DIF, SUN_ELEVATION, SUN_AZIMUTH, TEMP, WS, WD

  • Time step: hourly data

API TMY Professional

  • Parameters: GHI, DNI, DIF, SUN_ELEVATION, SUN_AZIMUTH, TEMP, WS, WD, RH, AP, PWAT

  • Time step: 15-minute data

Creating tokens

To create a TMY data request, you need to generate a token for communication. A token is a piece of secure information, like a password. Once a token is generated, it needs to be securely stored and handled. It is not possible to retrieve a previously generated token after the generation window is closed. In case of loss or any misuse of the generated token, it is recommended that the token be deleted and a new one be generated. Each user can generate multiple tokens and use them at the same time.

Solargis supports the generation of two types of tokens: user tokens and userless tokens and they are generated on the Company admin > APIs Subscriptions > Manage page.

User token

The user token is directly connected to the user for whom it has been generated.

To generate a user token, you need to assign a user to the subscription. Check the box next to the user and click on SAVE. The system will activate the option to “Generate token” for the selected user. By selecting this option, the system displays a modal window with the generated token. For security reasons, the admin can either copy the token to the clipboard or download the token in CSV format. The generated token cannot be retrieved again. It is important to store it before closing the modal window with the generated token.

Userless token

Userless tokens are anonymous tokens. They have the same functionality as user tokens, but they are not tied to a user.

To create a userless token, please click on “New token.” The new token will be generated. For security reasons, the admin can either copy the token to the clipboard or download the token in CSV format. The generated token cannot be retrieved again. It is important to store it before closing the modal window with the generated token.

The token ID will always be visible.

Token Management

To enhance the user experience, the token contains information about the company, subscription, and user identification (in the case of a user token). You do not need to provide that information explicitly in any TMY API-related request.

Additionally, you can add a name to each token for better organization. Navigate to API subscriptions, click on Manage, and add a subscription name.

The usage history

The usage of the created tokens can be monitored in the Usage history section. The results will be available after the first request.