You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/data-service.md
+30-6
Original file line number
Diff line number
Diff line change
@@ -7,12 +7,36 @@ For more information, visit the [GEOGLOWS API Documentation](https://geoglows.ec
7
7

8
8
---
9
9
10
-
## Using the API in Applications
10
+
## Using the API
11
11
12
-
The API can be used in applications requiring streamflow data and can be integrated directly into Python workflows.
12
+
In order to use the API, most functions require you to know your river ID number. You can find more information about finding your river number here: [Finding River Numbers](https://data.geoglows.org/tutorials/finding-river-numbers). You can download the GIS data by VPU through the data catalog or select a stream on the web application and get a river number that way.
13
+
14
+
### Using the API Website
15
+
16
+
To use the API website, follow these steps:
17
+
18
+
**Step 1:** Click the blue **“Get”** button next to the command you are interested in. This opens a window where you can enter your parameters.
19
+
20
+

21
+
22
+
**Step 2:** Before entering any numbers, click **“Try it out”** to enable input fields. This allows you to enter numbers and select response formats.
23
+
24
+
**Step 3:** Enter the required information:
25
+
- A **9-digit river ID number** (also known as a COMID or Link Number) in the `river_id` field. This is required.
26
+
- Choose either `csv` or `json` from the dropdown menu under `format`. The default selection is `csv`.
27
+
- For **forecast data queries**, enter a date in `YYYYMMDD` format. If left blank, it will return the most recent forecast.
13
28
14
-
The following resources provide guidance:
15
-
-[Programmatic_Access Colab.ipynb](https://colab.research.google.com/drive/19PiUTU2noCvNGr6r-1i9cv0YMduTxATs?usp=sharing): A walkthrough example of how to use the GEOGLOWS API.
16
-
-[Programmatic Access 2.0.pdf](https://drive.google.com/file/d/195LGTwbi4-Ho4JW15qZT-PDgUn10qit1/view?usp=sharing): A presentation with additional details.
29
+

17
30
18
-
These resources demonstrate how to leverage the API effectively for custom applications and analyses.
31
+
**Step 4:** Click the **blue “Execute”** button at the bottom of the screen. The system will process your request and load for a few seconds. Once finished, you will receive a response code along with an option to download the file.
32
+
33
+

34
+
35
+
### Accessing the API Using Python
36
+
37
+
One of the easiest ways to access the API is through Python. There is a **GeoGLOWS Python package** (documented here: [GeoGLOWS API Documentation](https://geoglows.readthedocs.io/en/latest/api-documentation.html)) that contains commands for basic analysis and querying specific types of data.
38
+
39
+
This Python notebook provides examples of using the API in Python, as well as utilizing the Python package: [Programmatic_Access Colab.ipynb](https://colab.research.google.com/drive/19PiUTU2noCvNGr6r-1i9cv0YMduTxATs?usp=sharing)
40
+
41
+
42
+
The API can be used in applications requiring streamflow data and can be integrated directly into Python workflows.
0 commit comments