Rainlog API (1.0.0)

Filter readings and return a list. This will return Readings whose

• readingId are in the list of readingIds
• AND readingDate intersects the date range
• AND position intersects the specified region
• AND gaugeType matches the list of types specified
• AND gaugeIds match the list of gaugeIds specified
• AND userIds match the list of userIds specified
• AND gaugeStatus matches the list of statuses specified
• AND quality matches the list of qualities specified
• AND timeWindowHour matches the list of hours specified Omitted or null fields will disable filtering on those fields. An explicitly empty gaugeIds list still means "match nothing". This endpoint returns BOTH hand-entered readings and the daily totals derived from automatic (personal weather station) gauges. Where a gauge has both for the same day and window, the hand-entered reading wins. Automatic rows report readingId 0, which is how you tell the two apart. Automation is a property of the DAY, not of the gauge: a gauge that switched between manual and automatic keeps each day under whichever mechanism was active then, so one gauge's history routinely contains both kinds of row. Results are ordered by readingDate ascending. Pagination is applied after filtering.

Filter month readings and return a list. This will return GaugeRevisions whose

• monthReadingId are in the list of monthReadingIds
• AND readingDate intersects the date range
• AND position intersects the specified region
• AND gaugeType matches the list of types specified
• AND gaugeIds match the list of gaugeIds specified
• AND userIds match the list of userIds specified

Omitted or null fields will disable filtering on those fields.

Filter gauges and return a list. A gauge is an identity that ties its revisions together; its properties live on the GaugeRevision.

Filter gauge revisions and return a list. A revision is the type and location of a gauge at a point in time, so this is where a reading's position, gauge type and timezone come from.

The nightly export of every gauge, reading and observation in Rainlog, as a zip of CSVs. Regenerated once a day, so the same URL gives that day's artifact to everyone. The rollover is just after midnight America/Phoenix; before that instant the request resolves to the previous day's artifact, because the current day's has not been written yet.

With includePwsPayloads=true you get the superset artifact instead: the same CSVs plus automatic_observation_payloads.csv, the raw per-upload payload for every accepted PWS upload, exactly as the station submitted it. Station credentials are redacted in that file: PASSWORD, PASSKEY and mac, plus ID / stationid, which are redundant with its own gauge_id column. This is the same redaction PwsPayload/getLatest applies to its raw format.

The same export as DataDump/globalData, narrowed to one user's gauges, readings, monthly readings, observations and notification subscriptions. Built on request rather than nightly, so it reflects the data as of the call.

includePwsPayloads=true adds that user's raw upload payloads, one CSV per gauge, under the same redaction as the global artifact.

The newest automatic observation for one automatic gauge.

Every other read endpoint here searches daily or monthly aggregates. This one answers what a gauge is reading now, which is what an integration needs and what nothing else returned.

Rain and snow come from Rainlog's own columns. Every other sensor is read out of the upload payload exactly as the station submitted it, which Rainlog keeps permanently and already publishes in the global data export.

The batch form of the GET. A gauge with no current reading is absent from the response rather than being an error, which covers a gauge that never reported and one that has gone stale.

In a text format the body is one record per line, each beginning with its ID=Rainlog<gaugeId> so records can be matched to gauges without relying on their order.

Accepts a Weather Underground style observation for one automatic gauge.

Also reachable at https://rainlog.org/weatherstation/updateweatherstation.php, which is the literal path WU-compatible firmware uses, so a station already configured for Weather Underground can be pointed at Rainlog by changing only the host name.

The gauge's credentials travel as ordinary request fields: ID is the station id Rainlog<gaugeId> (for example Rainlog4821) and PASSWORD is that gauge's station key. See PWS Upload above for where to find them.

Rate limit: one accepted observation per station per 295 seconds by default, so about one upload every five minutes.

The rain value stored for the observation is rainin, the WU rolling one hour total. hourlyrainin is accepted for uploaders that send the Ecowitt spelling, but it feeds only the separate hourly figure: it is not a fallback for the observation's rain, so an upload carrying hourlyrainin and no rainin records no rain. Send rainin.

Only precipitation becomes a Rainlog reading. The other sensors below are accepted and recorded with the upload, and the whole payload is retained verbatim, but they do not change the reading. Parameters not listed here are not rejected either: they are kept in the stored payload as sent.

How daily totals are derived, and which fields to send: Rainlog builds a reading day by differencing a cumulative counter between consecutive uploads, not by adding up the hourly values. Differencing is immune to upload phase, missed uploads and a varying upload rate, because the change between two samples is exactly the rain that fell in between.

The counter is chosen per gauge per reading day, in this order of preference:

1. totalrainin, the all time counter. Best: it only resets on a factory reset.
2. yearlyrainin, which resets on 1 January local time.
3. dailyrainin, which resets at the station's local midnight. Last resort: every reset is a point where a little rain can be lost, and this one resets nightly.

(An Ecowitt upload can also supply a piezo year counter, which ranks between yearlyrainin and dailyrainin. There is no WU parameter for it.)

Where several are present, the one with the most readings in the day wins, ties going to the order above. A counter going backwards (a reset) or jumping by more than 30 inches contributes nothing and simply rebaselines.

If no counter at all is sent, Rainlog falls back to adding the rolling hour values, which is materially less accurate. Send totalrainin if your station has it, and send the counters even when they look redundant next to the hourly figure.

Accepts an Ecowitt style observation for one automatic gauge.

Also reachable at https://rainlog.org/data/report/{token}, which is the literal path Ecowitt consoles use for a custom server, so a station can be pointed at Rainlog through its normal "custom weather server" settings.

Authentication has two parts. The path token is the gauge's credential, issued by Rainlog (see PWS Upload above for where to find it). PASSKEY is the station's own identifier rather than anything Rainlog issues: the first successful upload for a token binds whatever PASSKEY it presents to that gauge, and every later upload must present the same one. Regenerating the token clears the binding.

Rate limit: one accepted observation per gauge per 295 seconds by default, so about one upload every five minutes.

Only precipitation becomes a Rainlog reading. The other sensors below are accepted and recorded with the upload, and the whole payload is retained verbatim, but they do not change the reading. Parameters not listed here are not rejected either: they are kept in the stored payload as sent, which is where a console's extra channels, battery levels and air quality fields end up.

How daily totals are derived, and which fields to send: Rainlog builds a reading day by differencing a cumulative counter between consecutive uploads, not by adding up the hourly values. Differencing is immune to upload phase, missed uploads and a varying upload rate, because the change between two samples is exactly the rain that fell in between.

The counter is chosen per gauge per reading day, in this order of preference:

1. totalrainin, the all time counter. Best: it only resets on a factory reset.
2. yearlyrainin, which resets on 1 January local time.
3. yrain_piezo, the piezo year counter, used when the tipping bucket fields are absent.
4. dailyrainin, which resets at the station's local midnight. Last resort: every reset is a point where a little rain can be lost, and this one resets nightly.

Where several are present, the one with the most readings in the day wins, ties going to the order above. A counter going backwards (a reset) or jumping by more than 30 inches contributes nothing and simply rebaselines.

If no counter at all is sent, Rainlog falls back to adding the rolling hour values, which is materially less accurate. Send totalrainin if your station has it, and send the counters even when they look redundant next to the hourly figure.

Both rain families are understood. The stored hourly rain value is the first of hourlyrainin, hrain_piezo, eventrainin, erain_piezo that is present, so a console reporting both a tipping bucket and a piezo gauge prefers the tipping bucket.