--- title: "Introduction" slug: "introduction" updated: 2026-11-04T07:37:50Z published: 2026-11-04T07:37:50Z canonical: "kb.solargis.com/introduction" --- > ## Documentation Index > Fetch the complete documentation index at: https://kb.solargis.com/llms.txt > Use this file to discover all available pages before exploring further. # Introduction ## **Solargis API documentation** Solargis API is designed for solar project developers, analysts, consultants, and system integrators who require precise solar and meteorological data for a variety of applications. Our platform offers several API endpoints and data delivery methods, accommodating various scenarios. Each API relates to a Solargis product, and is described below together with links to the related product documentation and the API technical guides. For a business-level overview of all API services, see [Solargis API data services](https://kb.solargis.com/docs/solargis-api-data-services). ## Getting started To start using Solargis APIs, you need to: - Have a Solargis account with an active API subscription. You can purchase an API subscription by [contacting us](https://solargis.com/contact-us) directly or reaching out to your account manager. - Obtain an [API authentication token](https://kb.solargis.com/apidocs/generating-api-tokens) - required for every API request call. - Optionally, test the endpoints directly in the API documentation using the [API console](https://kb.solargis.com/apidocs/testing-the-endpoints). ## APIs by product ### Solargis Monitor & Forecast Related product documentation: [Introduction to Monitor](https://kb.solargis.com/docs/monitor-introduction), [Introduction to Forecast](https://kb.solargis.com/docs/introduction-to-forecast) - **Solargis Monitor & Forecast API endpoint**- lets you download Solargis Monitor and Forecast time series data using the synchronous method, suitable for monitoring and forecasting applications. This API uses XML format for communication. Links to related documentation: - [Solargis Monitor API](https://kb.solargis.com/docs/monitor-data-api) and [Solargis Forecast API](https://kb.solargis.com/docs/forecast-api-service) service introductions - [Monitor](https://kb.solargis.com/docs/monitor-subscription-details-1) and [Forecast](https://kb.solargis.com/docs/forecast-subscriptions-details) subscription parameters - [Technical guide](https://kb.solargis.com/apidocs/monitor-forecast-api-endpoint) - **Push Delivery for Solargis Monitor & Forecast**- automates the delivery of Solargis Monitor and Forecast datasets in CSV format directly to your remote SFTP folder at regular intervals. You define your locations and parameters in a data request file, and Solargis sets up the delivery for you. Suitable for large-scale monitoring and forecasting setups. Links to related documentation: - [Technical guide](https://kb.solargis.com/apidocs/push-delivery-for-solargis-forecast) To explore the data coverage for these services, view data coverage maps for [Monitor](https://storymaps.solargis.com/monitor-coverage) and [Forecast](https://storymaps.solargis.com/forecast-coverage). ### Solargis Prospect Related product documentation: [Introduction to Prospect](https://kb.solargis.com/docs/introduction-to-prospect) - **Solargis Long-term averages (LTA) API endpoint**- similar to the Solargis Monitor & Forecast endpoint. Uses XML for communication and lets you download Long-term averages (LTA) data using the synchronous method. Links to related documentation: - [Long-term averages API](https://kb.solargis.com/docs/solargis-long-term-averages-api) service introduction - [LTA API subscription details](https://kb.solargis.com/docs/lta-subscription-details) - [Technical guide](https://kb.solargis.com/apidocs/lta-api-endpoint) To view the data coverage for various regions, see the [Prospect data coverage map](https://storymaps.solargis.com/prospect-years). ### Solargis Evaluate Related product documentation: [Introduction to Evaluate](https://kb.solargis.com/docs/evaluate-overview) - **Solargis Time Series and TMY API endpoints** - dedicated to downloading Solargis **Time Series** (TS) and **Typical Meteorological Year**(TMY) data for specific locations, using the asynchronous method and JSON format. The TMY data is also suitable for usage in 3rd-party applications such as PVsyst. Links to related documentation: - [Time Series and TMY API](https://kb.solargis.com/docs/solargis-time-series-and-tmy-api) service introduction - [Time Series](https://kb.solargis.com/docs/time-series-subscription-details) and [TMY](https://kb.solargis.com/docs/tmy-subscription-details) API subscription details - Time Series [integration guide](https://kb.solargis.com/apidocs/solargis-ts-api-integration-setup) and [technical guide](https://kb.solargis.com/apidocs/get-requestid-for-timeseries-data) - TMY [integration guide](https://kb.solargis.com/apidocs/solargis-tmy-api-integration-setup) and [technical guide](https://kb.solargis.com/apidocs/get-requestid-for-tmy-data) - Python code example on how to integrate the async Time Series API on our [GitHub](https://github.com/solargis/solargis-python) Each data type has a dedicated API endpoint. The types of data you can access and the level of detail (granularity) depend on your API subscription plan. When setting up your integration for the first time, take advantage of our **free integration setup endpoints**, which you can use for test calls while building your integration. The setup guide is provided in the respective integration setup document of each API. To view the data coverage for various regions, see the [Evaluate data coverage map](https://storymaps.solargis.com/prospect-years). Note:The Solargis Time Series and TMY data APIs operate **asynchronously**. This means that when you submit a data request, the API does not return the results immediately. Instead, the initial request registers your query, and you must perform a follow-up call to check the status of the calculation and retrieve your data once processing is complete. This asynchronous workflow is designed to handle potentially large and complex data queries efficiently, allowing you to track progress and download results when they are ready. ### Solargis PV components catalog Related product documentation: [Introduction to the catalog](https://kb.solargis.com/docs/pvcc-introduction) - **PV components catalog API endpoints**- use these endpoints to access PV modules, inverters, and batteries from the PV components catalog, and the related codebook values. Links to related documentation: - [Catalog API access and Solargis Evaluate connection](https://kb.solargis.com/docs/pvcc-api-integration) (API key generation) - Technical guides: [PV Components](https://kb.solargis.com/apidocs/pv-components) and [Codebook](https://kb.solargis.com/apidocs/codebook) endpoints ### Solargis account - **Subscription details API endpoint**- use this endpoint to download information about your API subscription and usage history. Calls to this endpoint are free of charge. Links to related documentation: - [Technical guide](https://kb.solargis.com/apidocs/get-subscription-details-1) ## Technical specification | Field | Value / Description | | --- | --- | | **Type** | - Asynchronous REST API (Solargis Time Series and TMY APIs) - Synchronous API (Solargis LTA and Solargis Monitor & Forecast APIs) - Scheduled file delivery to SFTP (Push Delivery for Solargis Monitor & Forecast) | | **Format** | JSON (Time Series and TMY) XML (Monitor, Forecast, and LTA) CSV (Push Delivery for Monitor & Forecast) | | **Authentication** | [API token](https://kb.solargis.com/apidocs/generating-api-tokens) PV components catalog API: [catalog API key](https://kb.solargis.com/docs/pvcc-api-integration) | | **Endpoints** | Separate endpoints for: - [Solargis Time Series API](https://kb.solargis.com/apidocs/get-requestid-for-timeseries-data) - [Solargis TMY API](https://kb.solargis.com/apidocs/get-requestid-for-tmy-data) - [Solargis LTA API](https://kb.solargis.com/apidocs/lta-api-endpoint) - [Solargis Monitor & Forecast API](https://kb.solargis.com/apidocs/monitor-forecast-api-endpoint) - [Push Delivery for Solargis Monitor & Forecast](https://kb.solargis.com/apidocs/push-delivery-for-solargis-forecast) - [PV components catalog API](https://kb.solargis.com/apidocs/pv-components) - [Subscription details](https://kb.solargis.com/apidocs/get-subscription-details-1) | | **Time Resolution** | 1-minute, 15-minute, hourly, daily, monthly, yearly (depending on the API and subscription plan) | | **Geographic Coverage** | Global (excluding polar regions) | | **Historical data** | Available from 1994 to the present, depending on the region | | **Subscription plans and parameters** | [Time Series](https://kb.solargis.com/docs/time-series-subscription-details) - Yearly, Monthly, Daily, Hourly and 15-minute, 1-minute, Enterprise [TMY](https://kb.solargis.com/docs/tmy-subscription-details) - Hourly, 15-minute, 1-minute [Monitor](https://kb.solargis.com/docs/monitor-subscription-details-1) - Basic, Professional/Enterprise, Real-time [Forecast](https://kb.solargis.com/docs/forecast-subscriptions-details) - Basic, Professional/Enterprise, Historical period, Portfolio aggregation [Long-term averages](https://kb.solargis.com/docs/lta-subscription-details) | | **Rate Limits** | Defined by subscription; usage tracked via custom HTTP headers | | **Supported Use Cases** | Feasibility analysis, site assessment, PV system design, performance benchmarking, monitoring, forecasting | | **Integration** | Designed for automated integration with PV simulation and monitoring platforms | | **Error Handling** | Standard HTTP status codes and error messages |