Intro
The API provide real-time water level and flow (discharge) data collected at over 1900 hydrometric stations across Canada and historical water level and flow (discharge) data collected at over 7700 hydrometric stations across Canada covering rivers and lakes.
All data are sourced from the government of Canada website
Authentification key
In order to prevent abuse, Scrapi API requires a private API key for all requests. We allow one API key by email which gives a quota of 200 requests/day.
The API key is passed as a "key" parameter in each request.
API endpoint
https://vps267042.vps.ovh.ca/scrapi
Get the list of stations
/stations?page={PAGE}&key={KEY}
Parameter |
Type |
Description |
PAGE |
Integer |
For pagination between 1 and 11 |
KEY |
String |
Use the key received in the email |
Example :
https://vps267042.vps.ovh.ca/scrapi/stations?page=1&key={KEY}
Get a station details
/station/{STATION_ID}?key={KEY}
Parameter |
Type |
Description |
STATION_ID |
String |
Station id, Id returned by the previous request |
KEY |
String |
Use the key received in the email |
Example :
https://vps267042.vps.ovh.ca/scrapi/station/02OA016?key={KEY}
Get Primary level
/station/{STATION_ID}/primarylevel/?startDate={START_DATE}&endDate={END_DATE}&resultType={RESULT_TYPE}&key={KEY}
Parameter |
Type |
Format |
Description |
STATION_ID |
String |
(ex : 02OA016) |
Station id |
START_DATE |
String |
AAAA-mm-jj |
Inclusive date from which we want the data |
END_DATE |
String |
AAAA-mm-jj |
Inclusive date to which we want the data |
RESULT_TYPE |
String |
Possible value : stats, history, all |
Type of data returned. History is for real time values and stats is for agregated values (average, max, min... |
KEY |
String |
Alphanumeric |
Use the key received in the email |
Example :
https://vps267042.vps.ovh.ca/scrapi/station/02OA016/primarylevel/?startDate=2022-06-25&endDate=2022-06-27&resultType=history&key={KEY}
Get Secondary level
/station/{STATION_ID}/secondarylevel/?startDate={START_DATE}&endDate={END_DATE}&resultType={RESULT_TYPE}&key={KEY}
Parameter |
Type |
Format |
Description |
STATION_ID |
String |
(ex : 02OA016) |
Station id |
START_DATE |
String |
AAAA-mm-jj |
Inclusive date from which we want the data |
END_DATE |
String |
AAAA-mm-jj |
Inclusive date to which we want the data |
RESULT_TYPE |
String |
Possible value : stats, history, all |
Type of data returned. History is for real time values and stats is for agregated values (average, max, min... |
KEY |
String |
Alphanumeric |
Use the key received in the email |
Example :
https://vps267042.vps.ovh.ca/scrapi/station/02OA016/secondarylevel/?startDate=2022-06-25&endDate=2022-06-27&resultType=history&key={KEY}
Flow
/station/{STATION_ID}/flow/?startDate={START_DATE}&endDate={END_DATE}&resultType={RESULT_TYPE}&key={KEY}
Parameter |
Type |
Format |
Description |
STATION_ID |
String |
(ex : 02OA016) |
Station id |
START_DATE |
String |
AAAA-mm-jj |
Inclusive date from which we want the data |
END_DATE |
String |
AAAA-mm-jj |
Inclusive date to which we want the data |
RESULT_TYPE |
String |
Possible value : stats, history, all |
Type of data returned. History is for real time values and stats is for agregated values (average, max, min... |
KEY |
String |
Alphanumeric |
Use the key received in the email |
Example :
https://vps267042.vps.ovh.ca/scrapi/station/02OA016/flow/?startDate=2022-06-25&endDate=2022-06-27&resultType=history&key={KEY}
Temperature
/station/{STATION_ID}/temperature/?startDate={START_DATE}&endDate={END_DATE}&resultType={RESULT_TYPE}&key={KEY}
Parameter |
Type |
Format |
Description |
STATION_ID |
String |
(ex : 02OA016) |
Station id |
START_DATE |
String |
AAAA-mm-jj |
Inclusive date from which we want the data |
END_DATE |
String |
AAAA-mm-jj |
Inclusive date to which we want the data |
RESULT_TYPE |
String |
Possible value : stats, history, all |
Type of data returned. History is for real time values and stats is for agregated values (average, max, min... |
KEY |
String |
Alphanumeric |
Use the key received in the email |
Example :
https://vps267042.vps.ovh.ca/scrapi/station/02OA016/temperature/?startDate=2022-06-25&endDate=2022-06-27&resultType=history&key={KEY}