Aggregated Site Data (GET /api/pvdaq/v3/site_data)
Return aggregated IEC61724 data for a specific PVDAQ system and date range.
Request URL
GET /api/pvdaq/v3/site_data.format?parameters
HTTP Basic Authentication
You can access public PVDAQ data with just your developer API key. For access to non-public data you must also provide a PVDAQ username and password via HTTP Basic Authentication. For access to non-public data, contact Chris Deline.
Request Parameters
| Parameter | Required | Value | Description |
|---|---|---|---|
| format | Yes |
Type: string
Default: None
Options: json, xml
|
The output response format. Given in the URL as the file extension. |
| api_key | Yes |
Type: string
Default: None
|
Your developer API key. See API keys for more information. |
| system_id | Yes |
Type: integer
Default: None
|
Return data for the given system ID. Your PVDAQ user account must have access to the given system. |
| start_date | Yes |
Type: date
Default: None
|
Return data between this start date and the end_date given (MM/DD/YYYY format) |
| end_date | Yes |
Type: date
Default: None
|
Return data between the start_date given and this end date (MM/DD/YYYY format). |
| aggregate | Yes |
Type: string
Default: None
Options: hourly, daily, weekly, monthly
|
Aggregate the data based on this time period. |
| limit_fields | No |
Type: string
Default: None
Options: system_id, measdatetime, availability, energy_from_array, poa_irradiation, energy_to_grid, energy_from_grid, total_energy_input, total_energy_output, array_energy_fraction, load_efficiency, bos_efficiency, array_yield, final_yield, reference_yield, array_capture_losses, bos_losses, system_performance_ratio, array_performance_ratio, mean_array_efficiency, total_system_efficiency
|
If defined, return only the fields given. A single field, or a pipe-delimited list of multiple fields, may be given. |
| user_id | No |
Type: string
Default: None
|
For PVDAQ admin user accounts only. Return only systems belonging to the given username. |
Response Fields
| Field | Value | Description |
|---|---|---|
| outputs |
Type: array
|
An array of records containing the data for the site. The first row lists the field names. |
| errors |
Type: array
|
If errors were encountered, a list describing each error. Errors will be returned with an HTTP status code of 422 (Unprocessable Entity). |
| warnings |
Type: array
|
List of warnings, including information about API deprecations. |
| infos |
Type: array
|
List of additional, non-error information. |
| inputs |
Type: record
|
List of request parameters given. |
| version |
Type: string
|
The current version of the PVDAQ web service. |
Examples
JSON Output Format
GET /api/pvdaq/v3/site_data.json?api_key=DEMO_KEY&system_id=2&start_date=3/24/2011&end_date=3/25/2011&aggregate=hourly
{
"errors": [
],
"infos": [
],
"inputs": {
"aggregate": "hourly",
"api_key": "DEMO_KEY",
"end_date": "3/25/2011",
"start_date": "3/24/2011",
"system_id": "2"
},
"outputs": [
[
"measdatetime",
"array_capture_losses",
"array_energy_fraction",
"array_performance_ratio",
"array_yield",
"availability",
"bos_efficiency",
"bos_losses",
"energy_from_array",
"energy_from_grid",
"energy_to_grid",
"final_yield",
"load_efficiency",
"mean_array_efficiency",
"poa_irradiation",
"reference_yield",
"system_id",
"system_performance_ratio",
"total_energy_input",
"total_energy_output",
"total_system_efficiency"
],
[
"2011-03-24T00:00:00Z",
null,
null,
null,
null,
1,
null,
null,
0,
null,
null,
null,
null,
null,
null,
null,
2,
null,
null,
null,
null
],
[
"2011-03-24T01:00:00Z",
null,
null,
null,
null,
1,
null,
null,
0,
null,
null,
null,
null,
null,
null,
null,
2,
null,
null,
null,
null
]
],
"version": "3.0.1",
"warnings": [
]
}
XML Output Format
GET /api/pvdaq/v3/site_data.xml?api_key=DEMO_KEY&system_id=2&start_date=3/24/2011&end_date=3/25/2011&aggregate=hourly
<?xml version="1.0" encoding="UTF-8"?>
<response>
<errors type="array"/>
<outputs type="array">
<output type="array">
<output>measdatetime</output>
<output>array_capture_losses</output>
<output>array_energy_fraction</output>
<output>array_performance_ratio</output>
<output>array_yield</output>
<output>availability</output>
<output>bos_efficiency</output>
<output>bos_losses</output>
<output>energy_from_array</output>
<output>energy_from_grid</output>
<output>energy_to_grid</output>
<output>final_yield</output>
<output>load_efficiency</output>
<output>mean_array_efficiency</output>
<output>poa_irradiation</output>
<output>reference_yield</output>
<output>system_id</output>
<output>system_performance_ratio</output>
<output>total_energy_input</output>
<output>total_energy_output</output>
<output>total_system_efficiency</output>
</output>
<output type="array">
<output type="datetime">2011-03-24T00:00:00Z</output>
<output nil="true"/>
<output nil="true"/>
<output nil="true"/>
<output nil="true"/>
<output type="float">1.0</output>
<output nil="true"/>
<output nil="true"/>
<output type="float">0.0</output>
<output nil="true"/>
<output nil="true"/>
<output nil="true"/>
<output nil="true"/>
<output nil="true"/>
<output nil="true"/>
<output nil="true"/>
<output type="integer">2</output>
<output nil="true"/>
<output nil="true"/>
<output nil="true"/>
<output nil="true"/>
</output>
<output type="array">
<output type="datetime">2011-03-24T01:00:00Z</output>
<output nil="true"/>
<output nil="true"/>
<output nil="true"/>
<output nil="true"/>
<output type="float">1.0</output>
<output nil="true"/>
<output nil="true"/>
<output type="float">0.0</output>
<output nil="true"/>
<output nil="true"/>
<output nil="true"/>
<output nil="true"/>
<output nil="true"/>
<output nil="true"/>
<output nil="true"/>
<output type="integer">2</output>
<output nil="true"/>
<output nil="true"/>
<output nil="true"/>
<output nil="true"/>
</output>
</outputs>
<warnings type="array"/>
<infos type="array"/>
<inputs>
<api-key>DEMO_KEY</api-key>
<system-id>2</system-id>
<start-date>3/24/2011</start-date>
<end-date>3/25/2011</end-date>
<aggregate>hourly</aggregate>
</inputs>
<version>3.0.1</version>
</response>
CSV Output Format
GET /api/pvdaq/v3/site_data.csv?api_key=DEMO_KEY&system_id=2&start_date=3/24/2011&end_date=3/25/2011&aggregate=hourly
measdatetime,array_capture_losses,array_energy_fraction,array_performance_ratio,array_yield,availability,bos_efficiency,bos_losses,energy_from_array,energy_from_grid,energy_to_grid,final_yield,load_efficiency,mean_array_efficiency,poa_irradiation,reference_yield,system_id,system_performance_ratio,total_energy_input,total_energy_output,total_system_efficiency
2011-03-24 00:00:00 UTC,,,,,1.0,,,0.0,,,,,,,,2,,,,
2011-03-24 01:00:00 UTC,,,,,1.0,,,0.0,,,,,,,,2,,,,
Rate Limits
Standard rate limits apply. No more than 1,000 requests may be made in any hour
Errors
Standard errors may be returned. In addition, the following service-specific errors may be returned:
| HTTP Status Code | Description |
|---|---|
| 401 | Unauthorized - For access to non-public PVDAQ data, you must also provide a username and password for your PVDAQ account via HTTP Basic Authentication. For login credentials, contact Chris Deline. |
| 422 | Unprocessable Entity - An invalid value was given for a query parameter. The response body will describe the specific error. |