NCAR OpenIoTwx

CHORDS Data URLs

URLs for data ingest and download
Instrument: Howard/Demo 002 (id: 65)
Although this example is for a specific instrument, the syntax is common to all of them. instrument_id specifies the instrument. For putting data, there is a list of variable short names with their corresponding measurement value. All of the qualifiers (i.e. the fields following "?" and "") are order independent.

Download Single Instrument Data


Action URL format Qualifiers Example
Insert data w/instrument_id GET instrument_id, at, email, api_key, test http://cisl-chords.cloud.ucar.edu/measurements/url_create?instrument_id=65&pm25standard=PM2.5&pm100standard=PM10&pm10standard=PM1.0&partcount03= Particle Count (3um) &partcount05= Particle Count (5um) &partcount10=Particle Count (10um) &partcount25= Particle Count (25um) & partcount50 = Particle Count (50um) &partcount100= Particle Count (100um) &at=2015-08-20T19:50:28&email=[USER_EMAIL]&api_key=[API_KEY]&test
Insert data w/sensor_id GET sensor_id, at, email, api_key, test http://cisl-chords.cloud.ucar.edu/measurements/url_create?sensor_id=howard002&pm25standard=PM2.5&pm100standard=PM10&pm10standard=PM1.0&partcount03= Particle Count (3um) &partcount05= Particle Count (5um) &partcount10=Particle Count (10um) &partcount25= Particle Count (25um) & partcount50 = Particle Count (50um) &partcount100= Particle Count (100um) &at=2015-08-20T19:50:28&email=[USER_EMAIL]&api_key=[API_KEY]&test
Fetch a CSV file .csv start, end, last http://cisl-chords.cloud.ucar.edu/api/v1/data/65.csv?start=2015-08-01T00:30&end=2015-08-20T12:30
http://cisl-chords.cloud.ucar.edu/api/v1/data/65.csv?last
Fetch a GeoJSON file .geojson start, end, last http://cisl-chords.cloud.ucar.edu/api/v1/data/65.geojson
http://cisl-chords.cloud.ucar.edu/api/v1/data/65.geojson?start=2015-08-01T00:30&end=2015-08-20T12:30
http://cisl-chords.cloud.ucar.edu/api/v1/data/65.geojson?last

Download Multiple Instrument Data


Action URL format Qualifiers Example
Download all instruments for past 24 hours GET http://cisl-chords.cloud.ucar.edu/api/v1/data
http://cisl-chords.cloud.ucar.edu/api/v1/data.json
http://cisl-chords.cloud.ucar.edu/api/v1/data.geojson
Download all instruments for past 24 hours with authentication GET email, api_key http://cisl-chords.cloud.ucar.edu/api/v1/data?email=[USER_EMAIL]&api_key=[API_KEY]
Download all instruments w/date range GET start, end http://cisl-chords.cloud.ucar.edu/api/v1/data?start=2015-08-01T00:30&end=2015-08-20T12:30
Download all instruments w/date range test data only GET start, end, test http://cisl-chords.cloud.ucar.edu/api/v1/data?start=2015-08-01T00:30&end=2015-08-20T12:30&test
Download multiple instruments w/instrument ids GET instruments, start, end http://cisl-chords.cloud.ucar.edu/api/v1/data?instruments=1,2,3&start=2015-08-01T00:30&end=2015-08-20T12:30
Download multiple instruments w/sensor ids GET sensors, start, end http://cisl-chords.cloud.ucar.edu/api/v1/data?sensors=sen1,sen2,sen3&start=2015-08-01T00:30&end=2015-08-20T12:30

Optional Parameters


Optional
Qualifiers 		Meaning
sensor_id= SENSOR_ID A sensor id may be specified instead of the numerical instrument id, this value superceeds instrument id if both are given
at= time A time to assign to the measurement. If not present, the measurement will be time stamped with the time that it was received by the portal.
api_key= API_KEY An optional validation key. It is required if "Require the security key in order to submit a measurement" is checked in the configuration. The api key value is specified in the user configuration.
email= USER_EMAIL A user email is required when supplying an API Key to access secured data.
test If present, this measurement will be marked as a test value. Test values can be deleted from the database using the "Delete Test Button" on the instrument page. Do not use this option for production-ready instruments.
start= time A start time for the returned measurements.
end= time An end time for the returned measurements.
last Return all measurements for the most recent measurement time stamp.
include_test_data=true Include test data in data downloads.