NZO Logo
NZO Logo
אודותינוצור קשרAPI
תחזיות והשוואותאנרגיות מתחדשותמשק החשמל
image

API

תיעוד API עבור גישה לנתוני אנרגיה, פליטות CO2, ונתוני שוק החשמל בישראל.

All date parameters use YYYY-MM-DD format. Omitted dates default to sensible ranges (usually last 365 days or last 1 day).

כללי

Base URL: https://api.open-energy.madebyomnis.com/

Authentication: API Key required (x-api-key header)

Formats Supported: JSON, Excel (for export endpoints)

רשימה של שיטות API

נקודות הקצה והפונקציונליות שלהן.

שיטהנקודת קצה / קודתאוּר
GETapi/v1/energy/overviewמקורות ייצור חשמל
GETapi/v1/energy/overview/detailsמקורות ייצור חשמל
GETapi/v1/energy/overview/exportייצוא מקורות ייצור חשמל
GETapi/v1/energy/production-mixתמהיל ייצור חשמל
GETapi/v1/energy/production-mix/exportייצוא תמהיל ייצור חשמל
GETapi/v1/energy/smp(SMP) התפתחות מחיר השוק הסיטונאי
GETapi/v1/energy/smp/exportייצוא (SMP) התפתחות מחיר השוק הסיטונאי
GETapi/v1/energy/smp-production-vs-marginal-priceמחיר השוק הסיטונאי (SMP) מול הביקוש לחשמל
GETapi/v1/energy/smp-production-vs-marginal-price/exportייצוא מחיר השוק הסיטונאי (SMP) מול הביקוש לחשמל
GETapi/v1/private-supplier-connected-consumersצרכנים המחוברים למספקיי חשמל פרטיים
GETapi/v1/private-supplier-connected-consumers/exportייצוא צרכנים המחוברים למספקיי חשמל פרטיים
GETapi/v1/private-supplier-connected-consumers/download-sourceצרכנים המחוברים למספקיי חשמל פרטיים
GETapi/v1/switching-requestsסטטוס בקשות ניוד / בקשות ניוד - סיבות דחיה
GETapi/v1/switching-requests/exportייצוא סטטוס בקשות ניוד
GETapi/v1/co2/emissions-savingsפליטות CO2 שנחסכו עקב השימוש באנרגיה מתחדשת
GETapi/v1/co2/emissions-ratioממקורות פוסיליים CO2 שיעור פליטות
GETapi/v1/co2/total-productionייצור חשמל
GETapi/v1/co2/emissions-mixתמהיל פליטות CO2
GETapi/v1/co2/emissions-mix/exportייצוא תמהיל פליטות CO2
GETapi/v1/co2/emissions-over-timeפליטות CO2 מייצור חשמל
GETapi/v1/co2/emissions-over-time/exportייצוא פליטות CO2 מייצור חשמל
GETapi/v1/co2/total-vs-ratioסך פליטות CO₂ מול יחס פליטות CO₂
GETapi/v1/renewables/installed-capacity/cumulativeהספק מותקן (מצטבר) של מתקנים לייצור אנרגיות מתחדשות
GETapi/v1/renewables/installed-capacity/cumulative/exportייצוא הספק מותקן (מצטבר) של מתקנים לייצור אנרגיות מתחדשות
GETapi/v1/renewables/installed-capacity/growthהספק מותקן שנתי של מתקנים לייצור אנרגיות מתחדשות
GETapi/v1/renewables/installed-capacity/growth/exportייצוא הספק מותקן שנתי של מתקנים לייצור אנרגיות מתחדשות
GETapi/v1/renewables/installed-capacity/by-facility-sizeמתקני ייצור אנרגיה מתחדשת מחוברים לרשת לפי גודל
GETapi/v1/renewables/installed-capacity/by-facility-size/exportייצוא מתקני ייצור אנרגיה מתחדשת מחוברים לרשת לפי גודל
GETapi/v1/renewables/response-capacity/by-periodתשובות מחלק לבקשות חיבור מתקנים לרשת
GETapi/v1/renewables/response-capacity/by-period/exportייצוא תשובות מחלק לבקשות חיבור מתקנים לרשת
GETapi/v1/renewables/response-capacity/by-sizeתשובות חיוביות לפי גודל
GETapi/v1/renewables/response-capacity/by-size/exportייצוא תשובות חיוביות לפי גודל
GETapi/v1/renewables/response-capacity/by-districtתשובות מחלק לפי מחוז
GETapi/v1/renewables/response-capacity/by-district/exportייצוא תשובות מחלק לפי מחוז
GETapi/v1/renewables/transitionשיעור הייצור ממקורות מתחדשים
GETapi/v1/renewables/transition/exportייצוא שיעור הייצור ממקורות מתחדשים
GETapi/v1/renewables/delivery-4/יעדים מול ייצור בפועל
GETapi/v1/renewables/delivery-4/renewable-forecast-israel/exportייצוא יעדים מול ייצור בפועל
GETapi/v1/renewables/delivery-4/international-renewable-comparisonהשוואה בין לאומית של יעדי מתחדשות וייצור אנרגיה סולארית
GETapi/v1/renewables/delivery-4/international-renewable-comparison/exportייצוא השוואה בין לאומית של יעדי מתחדשות וייצור אנרגיה סולארית
GETapi/v1/renewables/potential-by-industryשיעור הייצור ממקורות מתחדשים
GETapi/v1/renewables/potential-by-industry/exportייצוא שיעור הייצור ממקורות מתחדשים
GETapi/v1/renewables/production-mixתמהיל ייצור אנרגיה מתחדשת
GETapi/v1/renewables/production-mix/exportייצוא תמהיל ייצור אנרגיה מתחדשת
GETapi/v1/heat-load-vs-generationייצור חשמל אל מול עומס החום
GETapi/v1/heat-load-vs-generation/exportייצוא ייצור חשמל אל מול עומס החום
GETapi/v1/data-files/statusשוק מספקי חשמל פרטיים
POSTapi/v1/data-files/uploadשוק מספקי חשמל פרטיים
GETapi/v1/apis/קטלוג API

נקודות הקצה

:Сhart title

מקורות ייצור חשמל

Endpoint: GET /api/v1/energy/overview
Description: Hierarchical breakdown of energy sources with percentages
Method: GET
:Parameters
  • start_date (optional, YYYY-MM-DD)
  • end_date (optional, YYYY-MM-DD)
:Response Example
{
  "start_date": "2025-01-06",
  "end_date": "2026-01-06",
  "filter": "year",
  "categories": [...],
  "category_percentages": {
    "renewables": 15.11,
    "non_renewables": 82.89,
    "other": 2.0
  },
  "total": 80561884.0441667,
  "level1": {...},
  "level2": {...},
  "renewable_share_percent": 15.11
}

:Сhart title

מקורות ייצור חשמל

Endpoint: GET /api/v1/energy/overview/details
Description: Detailed hierarchical view for deep analysis
Method: GET
:Parameters
  • start_date (optional, YYYY-MM-DD)
  • end_date (optional, YYYY-MM-DD)

:Сhart title

ייצוא מקורות ייצור חשמל

Endpoint: GET /api/v1/energy/overview/export
Description: Export energy overview to Excel file
Method: GET
:Parameters
  • start_date (optional, YYYY-MM-DD)
  • end_date (optional, YYYY-MM-DD)
:Response Example
Streamed Excel file (energy_overview.xlsx)

:Сhart title

תמהיל ייצור חשמל

Endpoint: GET /api/v1/energy/production-mix
Description: Aggregated electricity production mix by source type (fossil, renewable, other)
Method: GET
:Parameters
  • start_date (optional, YYYY-MM-DD)
  • end_date (optional, YYYY-MM-DD)
  • granularity (optional, Day | Month | Year)
:Response Example
{
  "start_date": "2025-01-06",
  "end_date": "2026-01-06",
  "filter": "year",
  "level1": {
    "Non-renewables": 66781294.08,
    "Renewables": 12176723.06,
    "Other": 1608640.27
  },
  "level2": {...},
  "total_generation": 80566657.42,
  "renewable_share_percent": 15.11,
  "series": [...]
}

:Сhart title

ייצוא תמהיל ייצור חשמל

Endpoint: GET /api/v1/energy/production-mix/export
Description: Export production mix to Excel file
Method: GET
:Parameters
  • start_date (optional, YYYY-MM-DD)
  • end_date (optional, YYYY-MM-DD)
:Response Example
Streamed Excel file (production_mix.xlsx)

:Сhart title

(SMP) התפתחות מחיר השוק הסיטונאי

Endpoint: GET /api/v1/energy/smp
Description: System Marginal Price (electricity market clearing price) data
Method: GET
:Parameters
  • start_date (optional, YYYY-MM-DD, defaults to last 1 day)
  • end_date (optional, YYYY-MM-DD)
:Response Example
{
  "daily_average": [...],
  "monthly_average": [...],
  "chart_without_constraints": [...],
  "chart_with_constraints": [...],
  "correlation_view": [...],
  "samples": [...],
  "view": "day",
  "start_date": "2026-01-05",
  "end_date": "2026-01-06"
}

:Сhart title

ייצוא (SMP) התפתחות מחיר השוק הסיטונאי

Endpoint: GET /api/v1/energy/smp/export
Description: Export SMP data to Excel file
Method: GET
:Parameters
  • start_date (optional, YYYY-MM-DD)
  • end_date (optional, YYYY-MM-DD)
:Response Example
Streamed Excel file (smp-data.xlsx)

:Сhart title

מחיר השוק הסיטונאי (SMP) מול הביקוש לחשמל

Endpoint: GET /api/v1/energy/smp-production-vs-marginal-price
Description: Correlate electricity production with marginal pricing for market analysis
Method: GET
:Parameters
  • start_date (optional, YYYY-MM-DD)
  • end_date (optional, YYYY-MM-DD)
:Response Example
{
  "start_date": "2026-01-05",
  "end_date": "2026-01-06",
  "view": "day",
  "smp_series": [...],
  "net_demand_series": [...],
  "combined_series": [...],
  "correlation": [...],
  "daily_average": [...],
  "monthly_average": [...]
}

:Сhart title

ייצוא מחיר השוק הסיטונאי (SMP) מול הביקוש לחשמל

Endpoint: GET /api/v1/energy/smp-production-vs-marginal-price/export
Description: Export SMP production vs marginal price data to Excel file
Method: GET
:Parameters
  • start_date (optional, YYYY-MM-DD)
  • end_date (optional, YYYY-MM-DD)
:Response Example
Streamed Excel file (smp-production-vs-marginal-price.xlsx)

:Сhart title

צרכנים המחוברים למספקיי חשמל פרטיים

Endpoint: GET /api/v1/private-supplier-connected-consumers
Description: Monthly time series of consumers connected to private electricity suppliers
Method: GET
:Parameters
  • start_date (optional, MM-YYYY)
  • end_date (optional, MM-YYYY)
:Response Example
{
  "start_date": "2026-01-01",
  "end_date": "2026-01-01",
  "unit": "count",
  "data": [
    {
      "month": "2026-01",
      "total_consumers": 316929.0,
      "new_additions": 316929.0
    }
  ],
  "segments": {...}
}

:Сhart title

ייצוא צרכנים המחוברים למספקיי חשמל פרטיים

Endpoint: GET /api/v1/private-supplier-connected-consumers/export
Description: Export private suppliers data to Excel
Method: GET
:Parameters
  • start_date (optional)
  • end_date (optional)
:Response Example
Streamed Excel file (private_suppliers_consumers.xlsx)

:Сhart title

צרכנים המחוברים למספקיי חשמל פרטיים

Endpoint: GET /api/v1/private-supplier-connected-consumers/download-source
Description: Download raw source CSV file with all private supplier data
Method: GET
:Response Example
CSV file download

:Сhart title

סטטוס בקשות ניוד / בקשות ניוד - סיבות דחיה

Endpoint: GET /api/v1/switching-requests
Description: Consumer electricity supplier switching request data
Method: GET
:Parameters
  • customer_type (optional, residential | non_residential)
  • year (optional)
:Response Example
{
  "filter": {
    "customer_type": "all",
    "year": "all"
  },
  "available_years": [2021],
  "charts": {
    "requests_by_status": {...},
    "requests_by_customer_type": {...},
    "requests_by_regulation_type": {...},
    "requests_by_rejection_reason": {...}
  },
  "monthly_requests": [...],
  "total_requests": 888882,
  "total_rejections": 277708
}

:Сhart title

ייצוא סטטוס בקשות ניוד

Endpoint: GET /api/v1/switching-requests/export
Description: Export switching request data to Excel
Method: GET
:Parameters
  • year (optional)
:Response Example
Streamed Excel file (switching_requests_YYYY.xlsx)

:Сhart title

פליטות CO2 שנחסכו עקב השימוש באנרגיה מתחדשת

Endpoint: GET /api/v1/co2/emissions-savings
Description: Total CO2 emissions (coal + natural gas + diesel) for the selected period
Method: GET
:Parameters
  • start_date (optional, YYYY-MM-DD)
  • end_date (optional, YYYY-MM-DD)
:Response Example
{
  "total": 2505223.89,
  "unit": "tons CO2",
  "start_date": "2026-01-03",
  "end_date": "2026-02-02"
}

:Сhart title

ממקורות פוסיליים CO2 שיעור פליטות

Endpoint: GET /api/v1/co2/emissions-ratio
Description: Total CO2 emissions ratio (tons CO2 per MWh) for the selected period
Method: GET
:Parameters
  • start_date (optional, YYYY-MM-DD)
  • end_date (optional, YYYY-MM-DD)
:Response Example
{
  "total": 261.1633,
  "unit": "tons CO2/MWh",
  "start_date": "2026-01-03",
  "end_date": "2026-02-02"
}

:Сhart title

ייצור חשמל

Endpoint: GET /api/v1/co2/total-production
Description: Total system generation (MWh) for the selected period
Method: GET
:Parameters
  • start_date (optional, YYYY-MM-DD)
  • end_date (optional, YYYY-MM-DD)
:Response Example
{
  "total": 7036671.71,
  "unit": "MWh",
  "start_date": "2026-01-03",
  "end_date": "2026-02-02"
}

:Сhart title

תמהיל פליטות CO2

Endpoint: GET /api/v1/co2/emissions-mix
Description: CO2 emissions mix (pie chart + infographics + time series)
Method: GET
:Parameters
  • start_date (optional, YYYY-MM-DD)
  • end_date (optional, YYYY-MM-DD)
  • view (optional, day | month | year)
:Response Example
{
  "view": "month",
  "start_date": "2026-01-03",
  "end_date": "2026-02-02",
  "total_emissions": 2505223.89,
  "total_emissions_unit": "tons CO2",
  "pie_chart": {
    "coal": { "value": 391019.99, "percentage": 15.61 },
    "natural_gas": { "value": 2093868.51, "percentage": 83.58 },
    "diesel": { "value": 20335.38, "percentage": 0.81 }
  },
  "infographics": {...},
  "time_series": [...]
}

:Сhart title

ייצוא תמהיל פליטות CO2

Endpoint: GET /api/v1/co2/emissions-mix/export
Description: Export CO2 emissions mix to Excel file
Method: GET
:Parameters
  • start_date (optional, YYYY-MM-DD)
  • end_date (optional, YYYY-MM-DD)
  • view (optional, day | month | year)
:Response Example
Streamed Excel file (co2_emissions_mix_STARTDATE_to_ENDDATE.xlsx)

:Сhart title

פליטות CO2 מייצור חשמל

Endpoint: GET /api/v1/co2/emissions-over-time
Description: CO2 emissions over time (chart + infographics)
Method: GET
:Parameters
  • start_date (optional, YYYY-MM-DD)
  • end_date (optional, YYYY-MM-DD)
  • view (optional, month | year | custom)
:Response Example
{
  "view": "month",
  "start_date": "2026-01-03",
  "end_date": "2026-02-02",
  "infographics": {...},
  "chart_data": [
    {
      "period": "2026-01-03",
      "label": "03 Jan",
      "coal": 12431.86,
      "natural_gas": 64471.12,
      "diesel": 39.73,
      "total_emissions": 76942.7
    }
  ]
}

:Сhart title

ייצוא פליטות CO2 מייצור חשמל

Endpoint: GET /api/v1/co2/emissions-over-time/export
Description: Export CO2 emissions over time to Excel file
Method: GET
:Parameters
  • start_date (optional, YYYY-MM-DD)
  • end_date (optional, YYYY-MM-DD)
  • view (optional, month | year | custom)
:Response Example
Streamed Excel file (co2_emissions_over_time_STARTDATE_to_ENDDATE.xlsx)

:Сhart title

סך פליטות CO₂ מול יחס פליטות CO₂

Endpoint: GET /api/v1/co2/total-vs-ratio
Description: Total CO2 emissions vs CO2 emissions ratio (combined chart + infographics)
Method: GET
:Parameters
  • start_date (optional, YYYY-MM-DD)
  • end_date (optional, YYYY-MM-DD)
  • view (optional, month | year | custom)
:Response Example
{
  "view": "month",
  "start_date": "2026-01-03",
  "end_date": "2026-02-02",
  "infographics": {...},
  "chart_data": [
    {
      "period": "2026-01-03",
      "total_emissions": 76942.7,
      "emissions_ratio": 8.4958,
      "generation_mwh": 218258.07
    }
  ]
}

:Сhart title

שוק מספקי חשמל פרטיים

Endpoint: GET /api/v1/data-files/status
Description: Returns freshness status for both datasets (private_suppliers and switching_requests)
Method: GET
:Response Example
{
  "private_suppliers": {
    "dataset": "private_suppliers",
    "status": "fresh",
    "age_days": 0.002,
    "filename": "Files_Netunei_hashmal_mp_niyud_17-12-2025.csv"
  },
  "switching_requests": {
    "dataset": "switching_requests",
    "status": "fresh",
    "age_days": 0.0002,
    "filename": "Files_Netunei_hashmal_mp_tzarchan_17-12-2025.csv"
  }
}

:Сhart title

שוק מספקי חשמל פרטיים

Endpoint: POST /api/v1/data-files/upload
Description: Uploads a new data file for a specific source
Method: POST
:Parameters
  • source (required, private_suppliers | switching_requests)
  • file (required, UploadFile)
:Response Example
{
  "dataset": "private_suppliers",
  "stored_as": "some_file_name.csv",
  "message": "File uploaded. Re-run the target API to get the updated results."
}

:Сhart title

הספק מותקן (מצטבר) של מתקנים לייצור אנרגיות מתחדשות

Endpoint: GET /api/v1/renewables/installed-capacity/cumulative
Description: Returns the cumulative installed capacity time series with technology and district breakdowns
Method: GET
:Parameters
  • year (optional, int)
  • district (optional, Jerusalem|North|South|Haifa|Center|Tel Aviv|Judea & Samaria|Other)
  • technology (optional, Photovoltaic|Wind|Solar Thermal|Other)
:Response Example
{
  "title": "Installed Capacity (Cumulative) of Renewable Energy Facilities",
  "total_installed_mw": 7756.107,
  "total_facilities": 63687,
  "series": [
    {
      "period": "2012-01",
      "added_mw": 0.123,
      "cumulative_mw": 0.123
    }
  ],
  "technology_breakdown": {
    "Photovoltaic": 7200.0,
    "Wind": 300.0,
    "Solar Thermal": 150.0,
    "Other": 106.107
  },
  "district_breakdown": {
    "South": 3000.0,
    "North": 1500.0
  }
}

:Сhart title

ייצוא הספק מותקן (מצטבר) של מתקנים לייצור אנרגיות מתחדשות

Endpoint: GET /api/v1/renewables/installed-capacity/cumulative/export
Description: Export cumulative installed capacity data to Excel file
Method: GET
:Parameters
  • year (optional, int)
  • district (optional)
  • technology (optional)
:Response Example
Streamed Excel file (installed_capacity_cumulative.xlsx)

:Сhart title

הספק מותקן שנתי של מתקנים לייצור אנרגיות מתחדשות

Endpoint: GET /api/v1/renewables/installed-capacity/growth
Description: Reports yearly additions plus percentage growth on the cumulative series
Method: GET
:Parameters
  • district (optional)
  • technology (optional)
:Response Example
{
  "title": "Installed Capacity — Growth Rate",
  "series": [
    {
      "year": 2024,
      "added_mw": 420.0,
      "cumulative_mw": 7200.0,
      "growth_rate_percent": 6.2
    }
  ],
  "filters_applied": {
    "district": null,
    "technology": "Photovoltaic"
  }
}

:Сhart title

ייצוא הספק מותקן שנתי של מתקנים לייצור אנרגיות מתחדשות

Endpoint: GET /api/v1/renewables/installed-capacity/growth/export
Description: Export installed capacity growth data to Excel file
Method: GET
:Parameters
  • district (optional)
  • technology (optional)
:Response Example
Streamed Excel file (installed_capacity_growth.xlsx)

:Сhart title

מתקני ייצור אנרגיה מתחדשת מחוברים לרשת לפי גודל

Endpoint: GET /api/v1/renewables/installed-capacity/by-facility-size
Description: Returns installed capacity broken down by facility size brackets over time
Method: GET
:Parameters
  • district (optional, Jerusalem|North|South|Haifa|Center|Tel Aviv|Judea & Samaria|Other)
:Response Example
{
  "title": "Installed capacity by facility size",
  "total_mw": 7500.0,
  "size_bracket_definitions": [
    { "label": "0-200 kW", "min_mw": 0, "max_mw": 0.2 },
    { "label": "201-630 kW", "min_mw": 0.2, "max_mw": 0.63 },
    { "label": "631-5000 kW", "min_mw": 0.63, "max_mw": 5.0 },
    { "label": "5001 kW +", "min_mw": 5.0, "max_mw": null }
  ],
  "series": [
    {
      "year": 2024,
      "size_brackets": {
        "0-200 kW": { "total_mw": 120.5, "count": 900 },
        "201-630 kW": { "total_mw": 80.2, "count": 120 }
      }
    }
  ]
}

:Сhart title

ייצוא מתקני ייצור אנרגיה מתחדשת מחוברים לרשת לפי גודל

Endpoint: GET /api/v1/renewables/installed-capacity/by-facility-size/export
Description: Export installed capacity by facility size data to Excel file
Method: GET
:Parameters
  • district (optional)
:Response Example
Streamed Excel file (installed_capacity_by_facility_size.xlsx)

:Сhart title

תשובות מחלק לבקשות חיבור מתקנים לרשת

Endpoint: GET /api/v1/renewables/response-capacity/by-period
Description: Aggregated response capacity per time period with breakdowns by response type
Method: GET
:Parameters
  • year (optional, int)
  • district (optional, Jerusalem|North|South|Haifa|Center|Tel Aviv|Judea & Samaria|Other)
  • technology (optional, Photovoltaic|Wind|Other)
  • response_type (optional, Positive|Partial Positive|Limited Positive|Negative)
  • include_cancelled (optional, bool)
:Response Example
{
  "title": "Response Capacity Divided by Period",
  "total_mw": 18214.205,
  "series": [
    {
      "period": "2023-12",
      "total_mw": 320.5,
      "request_count": 820,
      "response_type_breakdown": {
        "Positive": 238.5,
        "Negative": 40.0,
        "Partial Positive": 30.0,
        "Limited Positive": 12.0
      }
    }
  ],
  "response_type_breakdown": {
    "Positive": 15000.0,
    "Negative": 1500.0,
    "Partial Positive": 1000.0,
    "Limited Positive": 714.0
  }
}

:Сhart title

ייצוא תשובות מחלק לבקשות חיבור מתקנים לרשת

Endpoint: GET /api/v1/renewables/response-capacity/by-period/export
Description: Export response capacity by period data to Excel file
Method: GET
:Parameters
  • year (optional, int)
  • district (optional)
  • technology (optional)
  • response_type (optional)
  • include_cancelled (optional, bool)
:Response Example
Streamed Excel file (response_capacity_by_period.xlsx)

:Сhart title

תשובות חיוביות לפי גודל

Endpoint: GET /api/v1/renewables/response-capacity/by-size
Description: Shows response MW split by size brackets plus yearly totals
Method: GET
:Parameters
  • year (optional, int)
  • district (optional, Jerusalem|North|South|Haifa|Center|Tel Aviv|Judea & Samaria|Other)
  • include_cancelled (optional, bool)
:Response Example
{
  "title": "Response Capacity Divided by Facility Size (Kilowatt)",
  "title_he": "הספק תשובת מחולק לפי גודל מתקן (קילוואט)",
  "total_mw": 5581.228,
  "total_requests": 59564,
  "filters_applied": {
    "year": null,
    "district": null,
    "include_cancelled": false
  },
  "size_bracket_definitions": [
    { "label": "0-200 kW", "min_mw": 0, "max_mw": 0.2 },
    { "label": "201-630 kW", "min_mw": 0.2, "max_mw": 0.63 },
    { "label": "631-5000 kW", "min_mw": 0.63, "max_mw": 5.0 },
    { "label": "5001 kW +", "min_mw": 5.0, "max_mw": null }
  ],
  "series": [
    { "size_bracket": "0-200 kW", "total_mw": 2185.133, "request_count": 53497 }
  ],
  "yearly_series": [
    {
      "year": 2024,
      "size_brackets": {
        "0-200 kW": { "total_mw": 427.761, "count": 10761 }
      }
    }
  ]
}

:Сhart title

ייצוא תשובות חיוביות לפי גודל

Endpoint: GET /api/v1/renewables/response-capacity/by-size/export
Description: Export response capacity by size data to Excel file
Method: GET
:Parameters
  • year (optional, int)
  • district (optional)
  • include_cancelled (optional, bool)
:Response Example
Streamed Excel file (response_capacity_by_size.xlsx)

:Сhart title

תשובות מחלק לפי מחוז

Endpoint: GET /api/v1/renewables/response-capacity/by-district
Description: Aggregates response capacity per district with a technology breakdown
Method: GET
:Parameters
  • year (optional, int)
  • technology (optional, Photovoltaic|Wind|Other)
  • include_cancelled (optional, bool)
:Response Example
{
  "title": "Response Capacity Divided by District",
  "series": [
    {
      "district": "South",
      "total_mw": 7200.0,
      "request_count": 2100,
      "technology_breakdown": {
        "Photovoltaic": 6800.0,
        "Wind": 400.0
      }
    }
  ],
  "district_technology_breakdown": {
    "South": {
      "Photovoltaic": 6800.0,
      "Wind": 400.0
    }
  }
}

:Сhart title

ייצוא תשובות מחלק לפי מחוז

Endpoint: GET /api/v1/renewables/response-capacity/by-district/export
Description: Export response capacity by district data to Excel file
Method: GET
:Parameters
  • year (optional, int)
  • technology (optional)
  • include_cancelled (optional, bool)
:Response Example
Streamed Excel file (response_capacity_by_district.xlsx)

:Сhart title

שיעור הייצור ממקורות מתחדשים

Endpoint: GET /api/v1/renewables/transition
Description: Shows the national transition to renewables month by month
Method: GET
:Parameters
  • year (optional, 4-digit year; defaults to the current year)
:Response Example
{
  "year": "2025",
  "renewable_share_percent": 16.2,
  "monthly_totals": [
    {
      "month": "2025-01",
      "renewable_mw": 4880.0,
      "total_mw": 28500.0,
      "renewable_share_percent": 17.1
    }
  ],
  "notes": "Share is calculated with 5-minute samples divided by 12 and grouped by month."
}

:Сhart title

ייצוא שיעור הייצור ממקורות מתחדשים

Endpoint: GET /api/v1/renewables/transition/export
Description: Export renewables transition data to Excel file
Method: GET
:Parameters
  • year (optional, 4-digit year)
:Response Example
Streamed Excel file (renewables_transition.xlsx)

:Сhart title

יעדים מול ייצור בפועל

Endpoint: GET /api/v1/renewables/delivery-4/
Description: Annual series: actual renewable rate, realistic forecast, ministry and NZO targets (values as fractions 0–1)
Method: GET
:Response Example
{
  "title": "Renewables forecast trajectory in Israel",
  "title_he": "תחזית שיעור אנרגיות מתחדשות בישראל",
  "value_unit": "fraction",
  "data": [{ "year": 2020, "renewable_rate": 0.063, "realistic_forecast": 0.063, "ministry_target": 0.1, "nzo_target": 0.275 }],
  "metadata": { "year_start": 2020, "year_end": 2050 }
}

:Сhart title

ייצוא יעדים מול ייצור בפועל

Endpoint: GET /api/v1/renewables/delivery-4/renewable-forecast-israel/export
Description: Export renewable forecast vs targets chart data to Excel
Method: GET
:Response Example
Streamed Excel file

:Сhart title

השוואה בין לאומית של יעדי מתחדשות וייצור אנרגיה סולארית

Endpoint: GET /api/v1/renewables/delivery-4/international-renewable-comparison
Description: Per-region 2030/2050 renewable targets and optional 2024 solar share (fractions 0–1)
Method: GET
:Parameters
  • include_2050_targets (optional, bool, default true)
  • include_solar_share (optional, bool, default true)
:Response Example
{
  "title_he": "אנרגיות מתחדשות יעדים מול ייצור בפועל",
  "regions": [{ "region": "Israel", "region_he": "ישראל", "renewable_target_2030": 0.3, "solar_share_2024": 0.146, "renewable_target_2050": 0.77 }],
  "regions_without_solar_data": []
}

:Сhart title

ייצוא השוואה בין לאומית של יעדי מתחדשות וייצור אנרגיה סולארית

Endpoint: GET /api/v1/renewables/delivery-4/international-renewable-comparison/export
Description: Export international renewable comparison to Excel (same filter query params as GET)
Method: GET
:Parameters
  • include_2050_targets (optional, bool, default true)
  • include_solar_share (optional, bool, default true)
:Response Example
Streamed Excel file

:Сhart title

שיעור הייצור ממקורות מתחדשים

Endpoint: GET /api/v1/renewables/potential-by-industry
Description: Estimates renewable production potential per industry vertical
Method: GET
:Parameters
  • year (optional, 4-digit year; defaults to the current year)
:Response Example
{
  "year": "2025",
  "total_potential_mw": 3865.3,
  "industry_breakdown": [
    {
      "industry_type": "industrial",
      "renewable_potential_mw": 1670.2,
      "solar_share_percent": 48.6
    }
  ],
  "notes": "Industry names follow the Electricity Authority classification."
}

:Сhart title

ייצוא שיעור הייצור ממקורות מתחדשים

Endpoint: GET /api/v1/renewables/potential-by-industry/export
Description: Export renewables potential by industry data to Excel file
Method: GET
:Parameters
  • year (optional, 4-digit year)
:Response Example
Streamed Excel file (renewables_potential_by_industry.xlsx)

:Сhart title

תמהיל ייצור אנרגיה מתחדשת

Endpoint: GET /api/v1/renewables/production-mix
Description: Returns the renewable portion of the production mix with breakdowns for solar, wind, and other sources
Method: GET
:Parameters
  • start_date (optional, YYYY-MM-DD)
  • end_date (optional, YYYY-MM-DD)
  • category (optional, solar | wind | other)
:Response Example
{
  "start_date": "2026-01-01",
  "end_date": "2026-01-31",
  "view": "month",
  "total_renewable_mw": 124500.4,
  "breakdown": [
    {
      "type": "photovoltaic",
      "value": 101750.2,
      "share_percent": 81.8
    },
    {
      "type": "wind",
      "value": 15000.6,
      "share_percent": 12.1
    },
    {
      "type": "other",
      "value": 8000.4,
      "share_percent": 6.1
    }
  ],
  "series": [
    {
      "period": "2026-01-01",
      "solar_mw": 4200.5,
      "wind_mw": 520.0,
      "other_mw": 230.1
    }
  ]
}

:Сhart title

ייצוא תמהיל ייצור אנרגיה מתחדשת

Endpoint: GET /api/v1/renewables/production-mix/export
Description: Export renewables production mix to Excel file
Method: GET
:Parameters
  • start_date (optional, YYYY-MM-DD)
  • end_date (optional, YYYY-MM-DD)
  • category (optional, solar | wind | other)
:Response Example
Streamed Excel file (renewables_production_mix.xlsx)

:Сhart title

ייצור חשמל אל מול עומס החום

Endpoint: GET /api/v1/heat-load-vs-generation
Description: Heat load vs electricity generation based on meteorological CSV data and generation data
Method: GET
:Parameters
  • start_date (optional, YYYY-MM-DD)
  • end_date (optional, YYYY-MM-DD)
  • view (optional, month | year | custom)
:Response Example
{
  "view": "year",
  "start_date": "2026-02-01",
  "end_date": "2026-02-18",
  "units": {
    "heat_load": "THI",
    "electricity_generation": "MW"
  },
  "series": [
    {
      "period": "2026-02-16/2026-02-22",
      "label": "16 Feb",
      "heat_load": 11.96,
      "electricity_generation_mw": 8620.43
    }
  ]
}

:Сhart title

ייצוא ייצור חשמל אל מול עומס החום

Endpoint: GET /api/v1/heat-load-vs-generation/export
Description: Export heat load vs electricity generation to Excel
Method: GET
:Parameters
  • start_date (optional, YYYY-MM-DD)
  • end_date (optional, YYYY-MM-DD)
  • view (optional, month | year | custom)
:Response Example
Streamed Excel file (heat_load_vs_generation_STARTDATE_to_ENDDATE.xlsx)

:Сhart title

קטלוג API

Endpoint: GET /api/v1/apis/
Description: Returns a catalog of all registered public-facing API endpoints
Method: GET
:Response Example
[
  {
    "title": "Energy Overview",
    "link": "/api/v1/energy/overview",
    "method": "GET",
    "description": "Hierarchical breakdown of generation by source.",
    "params": [...],
    "sample_response": ["200"],
    "sample_response_body": {...}
  }
]
image

אולי יעניין אותך גם

מפת הסבירות לחיבור מתקני ייצור חדשים לרשת החשמל
דו"ח מצב משק החשמל 2024
דו"ח מצב משק האנרגיה 2025
צריכה ביתית שעתית ממוצעת בימי חול ליישוב