Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

As of January 2020 GLTG has 32,122,836 datapoints. 

Status
colourRed
titleWarning
 Please don't fetch all of them at once.


Step 1: Create an Account 

Step 2: Acquire Data from API

You can acquire the data from API by using curl command or python library (we provide the example in jupyter notebook in attached)

Using CURL

Get all Sensors in JSON format

Currently, pulling sensors does not require authentication.

InputsOutputs typeExample
url

JSON



Code Block
titleGet all Sensors
curl -X GET --compressed https://greatlakestogulf.org/geostreams/api/sensors



taskcurlinputsinstructionsreturns
authenticate

curl -X POST -H 'Content-Type: application/json' -d '{"password": "****", "identifier": "email"}' --compressed -i https://greatlakestogulf.org/geostreams/api/authenticate

  • password
  • email
In the response will be X-Auth-Token: followed by the alphanumeric security tokenX-Auth-Token
get all datapoints for a single sensorcurl -X GET -H 'Content-Encoding: application/json' -H 'x-auth-token:token' --compressed 'https://greatlakestogulf.org/geostreams/api/datapoints?sensor_id=22&since=2018-06-01'
  • token
  • sensor_id
  • since
Use X-Auth-Token from authenticationjson


Using Python Library (pyGeotemporal)

<< insert code example here>>

<< need to have instruction how to get pyGeotemporal >>


Jupyter notebook example can be download here <link>



Jupyter Notebook

We have created a jupyter notebook that allows a user to run several common data fetching methods including get sensors as CSV  and get datapoints in CSV or JSON.

Install Jupyter

Code Block
languagepy
titleConda
conda install -c conda-forge notebook

Or

Code Block
languagepy
titlePIP
pip install notebook

Download and Run Notebook

Download this file geostreams_jupyter.ipynb, move it in a directory of your choice, from a terminal in the chosen directory .  

Code Block
titleRun Jupyter
jupyter notebook



Examples using Curl