导航|地址|刷新
API Specification — PVOutput documentati…

Overview

General Features

Daily Page

Search

Compare

Teams

Maps

Live Data

Extended Data

Data Aggregation

Alerts

Tariffs

Bulk Loading

Auto Uploader

Push Services

Service Integration

API Specification
Getting Started
Authentication

Rate Limits

HTTP Headers

Add Output Service
Service URL

POST Method

Parameters
Conditions

CSV Data Parameter

Batching Outputs

POST Examples

GET Examples

Success Messages
OK 200: Added Output

Error Messages
Bad request 400: Date [date] invalid

Bad request 400: Date [date] too old

Bad request 400: Date [date] too new

Bad request 400: Generation [export] too high for system size [size] on [date]

Bad request 400: Export [export] too high for system size [size] on [date]

Bad request 400: Export [export] cannot exceed generation [generation] by 15%

Bad request 400: Consumption [consumption] too high on [date]

Bad request 400: Peak power [power] too high for system size [size] on [date]

Bad request 400: Min/Max temp missing on [date]

Restrictions and Limitations

Donation Features

Add Status Service
Service URL

Parameters

Power and Energy Calculation

Cumulative Energy

Net Data

Battery Data
State Codes

Examples

Success Messages
OK 200: Added Status

Error Messages
Bad request 400: Invalid Date [date]

Bad request 400: Missing date or time

Bad request 400: Missing energy and power values

Bad request 400: Invalid future [date]

Bad request 400: Date is older than 14 days [date]

Bad request 400: Power value [power] too high for system size [system_size]

Bad request 400: Moon Powered

Bad request 400: Energy value [energy] too high for [time]

Bad request 400: Energy value [energy] too high for system size [system_size]

Bad Request 400: Invalid net and cumulative

Bad Request 400: Missing net power value

Restrictions and Limitations

Donation Features

Add Batch Status Service
Service URL

Parameters

Data Structure

Net Data

Examples

Success Messages
Status Codes

Restrictions and Limitations

Donation Features

Get Status Service
Service URL

Parameters

Success Messages

History Query

Day Statistics

Error Messages
Unauthorized 401: Inaccessible System ID

A Bad request 400: No status found

Restrictions and Limitations

Get Statistic Service
Service URL

Parameters

Success Messages

Restrictions and Limitations

Get System Service
Service URL

Parameters

Success Messages

Restrictions and Limitations

Post System Service
Service URL

Parameters

Example Requests

Restrictions and Limitations

Get Ladder Service
Service URL

Parameters

Success Messages

Restrictions and Limitations

Get Output Service
Service URL

Parameters

Success Messages

Insolation

Aggregated Outputs

Team Output

Restrictions and Limitations

Get Extended Service
Service URL

Parameters

Success Messages

Restrictions and Limitations

Get Favourite Service
Service URL

Parameters

Success Messages

Restrictions and Limitations

Get Missing Service
Service URL

Parameters

Success Messages

Restrictions and Limitations

Get Insolation Service
Service URL

Parameters

Latitude and Longitude

Timezone

Date

Example Requests

Success Messages

Restrictions and Limitations

Donation Features

Delete Status Service
Service URL

Parameters

Success Messages
OK 200: Deleted Status

Error Messages
Bad request 400: Date is required

Bad request 400: Status not found

Bad request 400: Date is in the future

Bad request 400: Invalid date: [date]

Bad request 400: Invalid time: [time]

Bad request 400: Date is older than 14 days [date]

Restrictions and Limitations

Donation Features

Search Service
Service URL

Parameters
Country Codes

Success Messages

Restrictions and Limitations

Get Team Service
Service URL

Parameters

Success Messages

Error Messages
Bad request 400: No team found

Restrictions and Limitations

Join Team Service
Service URL

Parameters

Success Messages
OK 200: You have joined team [team_name]

Error Messages
Bad Request 400: You cannot join a team that does not exist

Bad Request 400: Your system cannot join more than 10 teams

Bad Request 400: You are already a member of [team_name]

Bad Request 400: Your system must have at least 5 outputs to join a team

Restrictions and Limitations

Leave Team Service
Service URL

Parameters

Success Messages
OK 200: You have left team [team_name]

Error Messages
Bad Request 400: You cannot leave a team that does not exist

Bad Request 400: You are not a member of team [team_name]

Bad Request 400: You cannot leave the team [team_name] which you started

Restrictions and Limitations

Get Supply Service
Service URL

Parameters

Region Keys
Australia

The Netherlands

United Kingdom

United States

Italy

Belgium

Denmark

Example Requests

Success Messages

Restrictions and Limitations

Register Notification Service
Service URL

Parameters

Alert Types

Callback URL

Restrictions and Limitations

Donation Features

Deregister Notification Service
Service URL

Parameters

Common Errors
Method Not Allowed 405: POST or GET only

Unauthorized 401: Invalid System ID

Unauthorized 401: Invalid API Key

Unauthorized 401: Disabled API Key

Forbidden 403: Read only key

Unauthorized 401: Missing, invalid or inactive api key information (X-Pvoutput-Apikey)

Forbidden 403: Exceeded number requests per hour

Forbidden 403: Donation Mode

Data Services

Managed Systems

Widgets and Portlets

Donations

Commercial Use

Privacy and Security

Terms and Definitions

Terms of Service

PVOutput

API Specification

------

API Specification

This section details the API specification for those who wish to implement their own client software.

Getting Started

Login and goto your Settings page

Select Enabled for API Access

Click on New Key to generate your API key

Make a note of your System Id

Save your settings

Both the API key and System Id will be required to access all API services

Authentication

The following HTTP Headers need to be set to authenticate the service request.

X-Pvoutput-Apikey

X-Pvoutput-SystemId

Alternatively, the parameters key and sid may be passed as part of a GET request.

Rate Limits

The following rate limits applies per API key for all request types -

60 requests per hour.

300 requests per hour in Donation mode.

The following rate limits applies per API key to Get Statistic API -

12 requests per hour.

60 requests per hour in Donation mode.

HTTP Headers

Rate limit information can be obtained by setting the HTTP header X-Rate-Limit to 1

The HTTP response will be returned with the additional headers -

X-Rate-Limit-Remaining - The number of requests remaining for the hour

X-Rate-Limit-Limit - The total request limit for the hour

X-Rate-Limit-Reset - Unix time in UTC when the limit is reset

Add Output Service

The Add Output service uploads end of day output information. It allows all of the information provided on the Add Output page to be uploaded.

Service URL

1https://pvoutput.org/service/r2/addoutput.jsp

POST Method

The POST method accepts either a single CSV data parameter or multiple parameters. It is recommended to use the POST method as it does not expose the API key via the URL.

Parameters

The following parameters are used when requesting the service via GET or POST.

Parameter

Field

Required

Format

Unit

Example

d

Date

Yes

yyyymmdd

date

20210228

g

Generated

No 1

number

watt hours

3271

e

Exported

No

number

watt hours

1928

pp

Peak Power

No

number

watts

2802

pt

Peak Time

No

hh:mm

time

13:15

cd

Condition

No

text

See Conditions

tm

Min Temp

No

decimal

celsius

10.2

tx

Max Temp

No

decimal

celsius

21.2

cm

Comments

No

text

Free text

ip

Import Peak

No

number

watt hours

io

Import Off Peak

No

number

watt hours

is

Import Shoulder

No

number

watt hours

ih

Import High Shoulder

No

number

watt hours

c

Consumption

No

number

watt hours

ep

Export Peak

No

number

watt hours

eo

Export Off-Peak

No

number

watt hours

es

Export Shoulder

No

number

watt hours

eh

Export High Shoulder

No

number

watt hours

1 Required if the output does not already exist.

Conditions

The following values are valid for the condition cd parameter -

Fine

Partly Cloudy

Mostly Cloudy

Cloudy

Showers

Snow

Hazy

Fog

Dusty

Frost

Storm

CSV Data Parameter

The data input contains comma separated values of the output details. The fields must be passed in the order shown below.

Position

Field

Required

1

Output Date

Yes

2

Generated

No 1

3

Exported

No

4

Peak Power

No

5

Peak Time

No

6

Condition

No

7

Min Temp

No

8

Max Temp

No

9

Comments

No

10

Import Peak

No

11

Import Off Peak

No

12

Import Shoulder

No

13

Import High Shoulder

No

14

Consumption

No

15

Export Peak

No

16

Export Off-Peak

No

17

Export Shoulder

No

18

Export High Shoulder

No

1 Required if the output does not already exist.

Batching Outputs

Multiple outputs may be added or updated in a single request by separating each output with a semi-colon in the data input.

See example below -

POST Examples

Using cURL to send the minimum required data

1curl -d "data=20210830,15000" -H "X-Pvoutput-Apikey: Your-API-Key" -H "X-Pvoutput-SystemId: Your-System-Id" https://pvoutput.org/service/r2/addoutput.jsp

Using cURL to send a batch of 3 outputs

1curl -d "data=20210101,15000;20210102,14000;20210103,16000" -H "X-Pvoutput-Apikey: Your-API-Key" -H "X-Pvoutput-SystemId: Your-System-Id" https://pvoutput.org/service/r2/addoutput.jsp

Using cURL to update the comment, off peak import (300) and off peak export (200)

1curl -d "data=20210301,,,,,,,,updated comment,,300,,,,,200,," -H "X-Pvoutput-Apikey: Your-API-Key" -H "X-Pvoutput-SystemId: Your-System-Id" https://pvoutput.org/service/r2/addoutput.jsp

Using cURL to send the data values as parameters

1curl -d "d=20100830" -d "g=15000" -H "X-Pvoutput-Apikey: Your-API-Key" -H "X-Pvoutput-SystemId: Your-System-Id" https://pvoutput.org/service/r2/addoutput.jsp

Hint

Replace Your-API-Key and Your-System-Id with your key and system id

GET Examples

Using the web browser to send minimum required data

1https://pvoutput.org/service/r2/addoutput.jsp?key=Your-API-Key&sid=Your-System-Id&d=20100830&g=12000

Success Messages

The following messages will be returned upon successfully adding or updating output data.

OK 200: Added Output

The output data has been recieved and will either be added or updated.

Error Messages

The following service specific errors may be encountered.

For general API errors common for all services, refer to the service Common Errors section.

Bad request 400: Date [date] invalid

The date is incorrectly formatted, expecting yyyymmdd format

Bad request 400: Date [date] too old

The date must be after 2000-01-01

Bad request 400: Date [date] too new

The date must not be a future date

Bad request 400: Generation [export] too high for system size [size] on [date]

The generation amount to too high compared to the system size

Bad request 400: Export [export] too high for system size [size] on [date]

The export amount to too high compared to the system size

Bad request 400: Export [export] cannot exceed generation [generation] by 15%

The export amount is too high compared to the generation amount

Bad request 400: Consumption [consumption] too high on [date]

Consumption exceeded the 999999999Wh limit

Bad request 400: Peak power [power] too high for system size [size] on [date]

The peak power is 50% greater than the system size.

Bad request 400: Min/Max temp missing on [date]

Both min and max temperature must exist or both should be omitted

Restrictions and Limitations

Generated or consumption must be provided for a new output.

Generated and consumption are optional for an update.

If a Time of Export parameter ep, eo, es or eh is set then the existing total export value e is overwritten with the sum of all 4 time of export values.

Min temperature must be lower or equal to max temperature.

Temperature range is -100 to 100 degrees celsius.

Batching is only available with Donation mode enabled.

Maximum batch size is 100.

Donation Features

See Donation feature section.

Add Status Service

The Add Status service accepts live output data at the Status Interval (5 to 15 minutes) configured for the system.

Service URL

1https://pvoutput.org/service/r2/addstatus.jsp

Parameters

This service accepts both GET or POST requests with the following parameters -

…(内容过长已截断)

Parameter

Field

Required

Format

Unit

Example

Donation

d

Output Date

Yes

yyyymmdd

date

20210228

t

Time

Yes

hh:mm

time

14:00

v1

Energy Generation

No

number

watt hours

10000

v2

Power Generation

No

number

watts

2000

v3

Energy Consumption

No

number

watt hours

10000

v4

Power Consumption

No

number

watts

2000

v5

Temperature

No

decimal

celsius

23.4

v6

Voltage

No

decimal

volts

239.2

c1

Cumulative Flag

No

number

1

n

Net Flag

No

number

1

v7

Extended Value v7

No

number

User Defined

Yes

v8

Extended Value v8

No

number

User Defined

Yes

v9

Extended Value v9

No

number

User Defined

Yes

v10

Extended Value v10

No

number

User Defined

Yes

v11

Extended Value v11

No

number

User Defined

Yes

v12

Extended Value v12

No

number

User Defined

Yes

m1

Text Message 1

No

text

30 chars max

Yes

b1

Battery Power

No

number

watts

------
导航页打开网址

Parameter	Field	Required	Format	Unit	Example
d	Date	Yes	yyyymmdd	date	20210228
g	Generated	No 1	number	watt hours	3271
e	Exported	No	number	watt hours	1928
pp	Peak Power	No	number	watts	2802
pt	Peak Time	No	hh:mm	time	13:15
cd	Condition	No	text		See Conditions
tm	Min Temp	No	decimal	celsius	10.2
tx	Max Temp	No	decimal	celsius	21.2
cm	Comments	No	text		Free text
ip	Import Peak	No	number	watt hours
io	Import Off Peak	No	number	watt hours
is	Import Shoulder	No	number	watt hours
ih	Import High Shoulder	No	number	watt hours
c	Consumption	No	number	watt hours
ep	Export Peak	No	number	watt hours
eo	Export Off-Peak	No	number	watt hours
es	Export Shoulder	No	number	watt hours
eh	Export High Shoulder	No	number	watt hours

Position	Field	Required
1	Output Date	Yes
2	Generated	No 1
3	Exported	No
4	Peak Power	No
5	Peak Time	No
6	Condition	No
7	Min Temp	No
8	Max Temp	No
9	Comments	No
10	Import Peak	No
11	Import Off Peak	No
12	Import Shoulder	No
13	Import High Shoulder	No
14	Consumption	No
15	Export Peak	No
16	Export Off-Peak	No
17	Export Shoulder	No
18	Export High Shoulder	No