Skip to content

Latest commit

 

History

History
206 lines (203 loc) · 9.39 KB

README.md

File metadata and controls

206 lines (203 loc) · 9.39 KB
Raw

PurpleAir GMU InSitu API Endpoints for FireAlarm

Below are the details of the InSitu API endpoints to get sensor and reading data.

Provider Endpoint Required Variables Optional Variables Default Values Constraints
PurpleAir-GMU-Raw sensor_data date, min_lon, max_lon, min_lat, max_lat, provider variable (can be pm2_5, temperature, or humidity)
  • variable: pm2_5
 No specific constraints
Sample Request: https://insitu-api.stcenter.net/sensor_data?date=2022-07-01&variable=pm2_5&min_lon=-123.0&max_lon=-122.0&min_lat=37.0&max_lat=38.0&provider=PurpleAir-GMU-Raw
activities sensor_ids, sd (start date), provider
  • Maximum of 10 sensors allowed per request.
  • End date is not allowed.
Sample Request: https://insitu-api.stcenter.net/activities?sd=2022-07-01&sensor_ids=34653,9678,90465,14859,56109,142608,14973,55503,73135,39885&provider=PurpleAir-GMU-Raw
PurpleAir-GMU-Raw-Hourly sensor_data date, min_lon, max_lon, min_lat, max_lat, provider variable (can be pm2_5, temperature, or humidity)
  • variable: pm2_5
 No specific constraints
Sample Request: https://insitu-api.stcenter.net/sensor_data?date=2022-07-01&variable=pm2_5&min_lon=-123.0&max_lon=-122.0&min_lat=37.0&max_lat=38.0&provider=PurpleAir-GMU-Raw-Hourly
activities sensor_ids, sd (start date), ed (end date), provider
  • Maximum of 500 sensors allowed per request.
  • An end date is mandatory for each request.
  • The time span between the start date and end date must not exceed 7 days.
Sample Request: https://insitu-api.stcenter.net/activities?sd=2022-07-01&ed=2022-07-03&sensor_ids=34653,9678,90465,14859,56109,142608,14973,55503,73135,39885&provider=PurpleAir-GMU-Raw-Hourly
PurpleAir-GMU-Intermediate sensor_data date, min_lon, max_lon, min_lat, max_lat, provider variable (can be pm2_5, temperature, or humidity)
  • variable: pm2_5
Sample Request: https://insitu-api.stcenter.net/sensor_data?date=2022-07-01&variable=pm2_5&min_lon=-118.67&max_lon=-118.15&min_lat=33.70&max_lat=34.34&provider=PurpleAir-GMU-Intermediate
activities sensor_ids, sd (start date), ed (end date), provider
  • Maximum of 500 sensors allowed per request.
  • An end date is mandatory for each request.
  • The time span between the start date and end date must not exceed 7 days.
  • Start and end dates cannot be the same.
Sample Request: https://insitu-api.stcenter.net/activities?sd=2022-07-01&ed=2022-07-03&sensor_ids=96771,4069,130445,96855,96243,27235,34873,130445,90323,80807,23945,56899&provider=PurpleAir-GMU-Intermediate
PurpleAir-GMU-Cal sensor_data date, min_lon, max_lon, min_lat, max_lat, provider variable (can be pm2_5, temperature, or humidity)
  • variable: pm2_5
 Bounding box must be within Los Angeles: [33.70, -118.67] to [34.34, -118.15]
Sample Request: https://insitu-api.stcenter.net/sensor_data?date=2022-07-01&variable=pm2_5&min_lon=-118.67&max_lon=-118.15&min_lat=33.70&max_lat=34.34&provider=PurpleAir-GMU-Cal
activities sensor_ids, sd (start date), ed (end date), provider
  • Maximum of 500 sensors allowed per request.
  • An end date is mandatory for each request.
  • The time span between the start date and end date must not exceed 7 days.
  • Start and end dates cannot be the same.
Sample Request: https://insitu-api.stcenter.net/activities?sd=2022-07-01&ed=2022-07-02&sensor_ids=96771,4069,130445,96855,96243,27235,34873,130445,90323,80807,23945,56899&provider=PurpleAir-GMU-Cal

Below are the details of the InSitu API endpoints to get statistics of each sensor.

Provider Endpoint Required Variables Optional Variables Default Values Constraints
PurpleAir-GMU-Raw statistics provider startTime, endTime No specific constraints
Sample Request: https://insitu-api.stcenter.net/statistics?provider=PurpleAir-GMU-Raw&startTime=2022-07-01T00:00:00Z&endTime=2022-07-02T00:00:00Z
PurpleAir-GMU-Raw-Hourly statistics provider startTime, endTime No specific constraints
Sample Request: https://insitu-api.stcenter.net/statistics?provider=PurpleAir-GMU-Raw-Hourly&startTime=2022-07-01T00:00:00Z&endTime=2022-07-02T00:00:00Z
PurpleAir-GMU-Intermediate statistics provider startTime, endTime No specific constraints
Sample Request: https://insitu-api.stcenter.net/statistics?provider=PurpleAir-GMU-Intermediate&startTime=2022-07-01T00:00:00Z&endTime=2022-07-02T00:00:00Z
PurpleAir-GMU-Cal statistics provider startTime, endTime No specific constraints
Sample Request: https://insitu-api.stcenter.net/statistics?provider=PurpleAir-GMU-Cal&startTime=2022-07-01T00:00:00Z&endTime=2022-07-02T00:00:00Z