Using the API console

Solargis API documentation platform offers an API console where you can test the integrations or execute calls to retrieve your location data. Integrations can be tested using the API console in the respective API integration guides, and direct data downloads for your location can be done using the API consoles in the production API guides.

Key facts about the API console:

• It is provided by default on every and document page for quick access.

• The integration guides API consoles are connected to the integration account and can not be used to download your location data.

• The production guides API consoles are connected to the production servers and can be used only with paid subscriptions.

• You will need an API token and requestId depending on the request call.

Working with the API console

You can execute the calls using the API console to the right:

1. Enter your API token into the TMYToken field. If you already have the requestId and are requesting the data download, you will need to add the requestId to the respective field below the API token.

2. Amend the body parameters to get the data for your location (see body parameters scheme below for permitted values for each field). The default body parameters are set to work without any amendments.

3. Click the “Try it and see response” button to send the request.

4. If the request is accepted and you requested the requestId,  it will pop up in the response window. If you have requested your data, the URL will be provided in the response after processing.

Important: Please keep in mind that, due to the limitations of the testing facility capabilities, the response content in formats other than SOLARGIS_JSON will not be shown. To view other formats, we recommend you to test the requests in third-party testing tools such as Postman.