Getting Started with alitiq APIs π¶
Welcome to alitiqβs Forecasting Services, where innovation meets precision in solar PV and load forecasting (wind is coming soon ;). This guide provides an overview of alitiqβs APIs and a step-by-step approach to get started. Whether you're managing solar installations or planning for energy demand, alitiq offers robust solutions tailored to your needs.
Overview of alitiq APIs π οΈ¶
alitiq offers different services via api.alitiq.com:
1. Solar PV Forecasting API π¶
Designed for managing and forecasting solar power plants, this API provides:
- Portfolio Management: Add, update, or remove PV systems.
- Power Forecasting: Retrieve accurate solar power forecasts for individual locations or entire portfolios.
- Measurement Management: Push real-time or historical data for more precise forecasting.
The endpoint for this service is api.alitiq.com/solar
2. Load Forecasting API π¶
Optimized for heat, gas, and electricity forecasting, this API enables:
- Energy Load Predictions: Obtain detailed forecasts for individual locations.
- Measurement Inspection: Retrieve historical data for analysis.
- Custom Models: Leverage alitiqβs optimized forecasting models for enhanced accuracy.
The endpoint for this service is api.alitiq.com/load
3. Weather Forecasting API π€οΈ¶
Weather is our profession but not our business. Eitherways weather data is a basis for our enhanced forecasts. So we make available any kind of weather information via out Weather API.
- Weather Forecast: Obtain weather forecasts for individual locations from several leading national weather services.
- Weather Observations: Access a global network of weather observations ranging from remote sesnsing (radar, satellite) to point observations
The endpoint for this service is api.alitiq.com/weather
4. MCP Server for AI Assistants π€¶
Connect AI assistants such as Claude Code to your alitiq data via the Model Context Protocol (MCP) and ask questions in your own words:
- Your Portfolio: List your PV systems, wind parks and load locations.
- Forecasts & Measurements: Retrieve power and load forecasts and compare them with your measurements.
- Read-only & Secure: Uses your existing
x-api-key; assistants can read but never change your data.
The endpoint for this service is api.alitiq.com/mcp. See Connect AI assistants for the setup.
How to Get Access π¶
The standalone solar portal has been discontinued. Portfolio management is now available directly in the API GUI at https://api.alitiq.com/gui.
Solar PV | Wind Forecasting API + GUI π¶
- Step 1: Contact sales@alitiq.com for API access and pricing information.
- Step 2: Once approved, youβll receive your
x-api-keyand relevant details. - Step 3: Open https://api.alitiq.com/gui and authenticate with your API key.
- Step 4: Manage both your PV and wind portfolios directly in the GUI or use the endpoints via SDK/API.
Load | Weather Forecasting API π¶
- Step 1: Contact sales@alitiq.com for API access and pricing information.
- Step 2: Once approved, youβll receive your API key and documentation tailored to your energy needs.
- Step 3: Use the SDK or API to push measurements, retrieve forecasts, and manage demand analytics.
Security with x-api-key π¶
The alitiq Solar API uses the x-api-key for authentication and portfolio mapping. This key is unique to each user and is required to access the API. It ensures that:
- Portfolio Mapping: The
x-api-keylinks your requests to the correct portfolio, ensuring you access only your Solar PV systems and associated data. - Restricted Access: Only users with the correct
x-api-keycan access your portfolio.
Keep Your x-api-key Safe¶
To maintain the security and confidentiality of your portfolio:
- Do not share your API key with unauthorized individuals.
- Store it securely, such as in environment variables or a secure credentials manager.
- Regenerate your API key immediately if you suspect it has been compromised.
Your x-api-key is the gateway to your portfolioβkeep it protected to ensure your data stays safe.
Manage Your Token & Enable 2FA in the GUI π¶
The API GUI at https://api.alitiq.com/gui/user_management/ now includes a User Management section where you can:
- Regenerate your
x-api-keyat any time and choose an expiration of 30, 90, 180, or 365 days, or set it to never expire. - Enable optional two-factor authentication (2FA) for your GUI login via a QR code and any TOTP authenticator app (Google Authenticator, Authy, etc.). 2FA only protects the GUI login β it does not change how the
x-api-keyheader works for API requests, so existing integrations are unaffected. - Receive an email reminder 10 days before your token expires (only if you set an expiration β tokens set to "Never" don't trigger reminders), with a direct link back to the Token Management Center so you can regenerate it before it lapses.
See the Token Management Center & 2FA post for a walkthrough with screenshots.
Whatβs Next? π¶
Once you have your API key:
1. Install the alitiq-py SDK:
3. Explore the API Documentation (coming soon) for advanced use cases.
Need Help? π€¶
For further assistance:
- Contact us at support@alitiq.com for technical queries.
- Reach out to sales@alitiq.com for load forecast-related inquiries.
π Start forecasting smarter with alitiq today! π