Development Quickstart

Get up and running with our Wegaw API and kick-start your Wegaw integration.

Integrating the Wegaw API in your apps can begin right after you receive a Wegaw account, and in just four simple steps:

Obtain your API tokens
Check the basins available via API Request
Get data via API Request
Find available maps and download them via API Request

Step 1: Obtain your API tokens

To use the Wegaw API, you will need an access token. We use this token to associate any of your requests to your account. Find your token or refresh it in your Account Dashboard page or obtain it by using the Create Token API endpoint.

You will obtain two tokens:

One Access Token, allowing you to make any API or Maps request
One Refresh Token, allowing you to obtain a new Access Token when this expires

To increase the security of your account, Access tokens automatically expire after 24 hours, while Refresh tokens expire after 1 day.

Due to automated expiration of both tokens, you will need to implement an automatic token retrieval in your system. An expired Access Token will return an HTTP response code 401 Unauthorised. This indicates that you must use the Refresh Token API endpoint to obtain a newly valid Access Token. If the Refresh Token is expired, obtain a new pair of tokens via the Create Token API endpoint.

curl -X POST 'https://api.staging.defrost.io/v2/token/' --header 'Content-Type: application/json' --data '{"username":"string","password":"string"}'

import requests                                                                 
url = 'https://api.staging.defrost.io/v2/token/'                                                                
payload = {'username':'string','password':'string'}                                                                 
r = requests.post(url, json=payload, timeout=300)                                                                 
if r.status_code == 200:                                                                 
     data = r.json()

//import axios on the header <script src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>                                                                 
let url = 'https://api.staging.defrost.io/v2/token/';                                                                
(async() => {                                                                 
    const payload = {'username':'string','password':'string'}                                                                
  try {                                                                
    const response = await axios.post(url, payload);                                                                
    if (response.status == 200) {                                                                
        const data = response.data;                                                                
        console.log(data);// Work with the data                                                                
    } else {                                                                
        console.error('Failed with status code:', response.status);                                                                
    }                                                                
  } catch (error) {                                                                
        console.error('Error during the call:', error);                                                                
 }                                                                
})();

Step 2: Check the catchments available via API Request

Use the following code to check the catchments for which data can be downloaded. You can use the following code:

Make sure to modify the snippets with your API tokens obtained in the step above

curl -X GET 'https://api.staging.defrost.io/v2/catchments/' --header 'Authorization:Bearer <YOUR_JWT_ACCESS_TOKEN>'

import requests                                                                                 
url = 'https://api.staging.defrost.io/v2/catchments/'                                                                                
JWT_ACCESS_TOKEN = '<YOUR_ACCESS_TOKEN>'                                                                                
headers = {'Authorization': 'Bearer ' + JWT_ACCESS_TOKEN}                                                                                 
r = requests.get(url, headers=headers, timeout=300)                                                                                 
if r.status_code == 200:                                                                                 
     data = r.json()

//import axios on the header <script src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>                                                                 
let url = 'https://api.staging.defrost.io/v2/catchments/';                                                                
(async() => {                                                                 
  try {                                                                
    const response = await axios.get(url, { headers: {'Authorization':'Bearer ' + '<JWT_ACCESS_TOKEN>'}});                                                                
    if (response.status == 200) {                                                                
        const data = response.data;                                                                
        console.log(data);// Work with the data                                                                
    } else {                                                                
        console.error('Failed with status code:', response.status);                                                                
    }                                                                
  } catch (error) {                                                                
      console.error('Error during the call:', error);                                                                
 }                                                                
})();

Step 3: Get data via API Request

In this snip of code, we will request Snow Water Equivalent (SWE) data via API.

curl -X GET 'https://api.staging.defrost.io/v2/catchments/<CATCHMENT_NAME>/swe-stats/?from=2023-01-21&to=2023-01-30' --header 'Authorization:Bearer <YOUR_JWT_ACCESS_TOKEN>'

import requests                                                                                 
url = 'https://api.staging.defrost.io/v2/catchments/<CATCHMENT_NAME>/swe-stats/?from=2023-01-21&to=2023-01-30'                                                                                
JWT_ACCESS_TOKEN = '<YOUR_ACCESS_TOKEN>'                                                                                
headers = {'Authorization': 'Bearer ' + JWT_ACCESS_TOKEN}                                                                                 
r = requests.get(url, headers=headers, timeout=300)                                                                                 
if r.status_code == 200:                                                                                 
     data = r.json()

//import axios on the header <script src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>                         
let url = 'https://api.staging.defrost.io/v2/catchments/<CATCHMENT>/<PRODUCT>-stats/?from=<FROM_DATE>&to=<TO_DATE>';                        
(async() => {                         
  try {                        
    const response = await axios.get(url, {'headers': {'Authorization': 'Bearer <JWT_ACCESS_TOKEN>'}});                        
    if (response.status == 200) {                        
  const data = response.data                         
  console.log(data)                        
    } else {                        
        console.error('Failed with status code:', response.status);                        
    }                        
  } catch (error){                        
      console.error('Error during the call:', error);                        
 }                        
})();

Step 4: Find available maps and download them via API Request

In this snip of code, we will request Snow Water Equivalent (SWE) available maps via API.

curl -X GET 'https://api.staging.defrost.io/v2/catchments/<CATCHMENT_NAME>/swe-rasters/?from=2023-01-21&to=2023-01-30' --header 'Authorization: Bearer <YOUR_JWT_ACCESS_TOKEN>'

import requests                                                                                 
url = 'https://api.staging.defrost.io/v2/catchments/<CATCHMENT_NAME>/swe-rasters/?from=2023-01-21&to=2023-01-30'                                                                                
JWT_ACCESS_TOKEN = '<YOUR_ACCESS_TOKEN>'                                                                                
headers = {'Authorization': 'Bearer ' + JWT_ACCESS_TOKEN}                                                                                 
r = requests.get(url, headers=headers, timeout=300)                                                                                 
if r.status_code == 200:                                                                                 
     data = r.json()

//import axios on the header <script src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>                         
let url = 'https://api.staging.defrost.io/v2/catchments/<CATCHMENT>/<PRODUCT>-rasters/?from=<FROM_DATE>&to=<TO_DATE>';                        
(async() => {                         
  try {                        
    const response = await axios.get(url, {'headers': {'Authorization': 'Bearer <JWT_ACCESS_TOKEN>'}});                        
    if (response.status == 200) {                        
  const data = response.data                         
  console.log(data)                        
    } else {                        
        console.error('Failed with status code:', response.status);                        
    }                        
  } catch (error){                        
      console.error('Error during the call:', error);                        
 }                        
})();

And we will receive an array of files with information about the filename, the date and the URL to download the file.

[
  {
    "file_name": "2020-01-21.tif",
    "date": "2020-01-21",
    "url": "https://api.staging.defrost.io/v2/catchments/danube/hs-rasters/2020-01-21.tif"
  }
]

In this snip of code, we will download a SWE map, using the filename, via API.

curl -X GET 'https://api.staging.defrost.io/v2/catchments/<CATCHMENT_NAME>/hs-rasters/<FILE_NAME>' --header 'Authorization: Bearer <YOUR_JWT_ACCESS_TOKEN>' ---output '<OUTPUT>'

import urllib.request                                                                                 
url = 'https://api.staging.defrost.io/v2/catchments/<CATCHMENT_NAME>/hs-rasters/<FILE_NAME>'                                                                                
JWT_ACCESS_TOKEN = '<YOUR_ACCESS_TOKEN>'
OUTPUT = '<OUTPUT_FILENAME>'                                                                                
opener = urllib.request.build_opener()
opener.addheaders = [('Authorization', 'Bearer ' + JWT_ACCESS_TOKEN)]
urllib.request.install_opener(opener)
try:
    response = urllib.request.urlopen(url)
    if response.getcode() == 200:
        urllib.request.urlretrieve(url, OUTPUT)
        print(f'File downloaded successfully to {OUTPUT}.')
except Exception as e:
    print(f'Failed to download the file. Response code: {e}')

//import axios on the header <script src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>                          
let url = 'https://api.staging.defrost.io/v2/catchments/<CATCHMENT>/<PRODUCT>-rasters/<FILE_NAME>';                        
(async() => {                         
  try {                        
    const response = await axios.get(url, {'headers': {'Authorization': 'Bearer <JWT_ACCESS_TOKEN>'}, 'responseType': 'blob'});                        
    if (response.status == 200) {                        
    const blob = new Blob([response.data], { type: response.headers['content-type'] });                         
    const downloadUrl = URL.createObjectURL(blob);                        
    const a = document.createElement('a');                        
    a.href = downloadUrl;                        
    a.download = '<OUTPUT_PATH>';                        
    document.body.appendChild(a);                        
    a.click();                        
    document.body.removeChild(a);                        
    URL.revokeObjectURL(downloadUrl);                        
    console.log('File downloaded successfully');                        
    } else {                        
        console.error('Failed with status code:', response.status);                        
    }                        
  } catch (error){                        
      console.error('Error during the call:', error);                        
 }                        
})();

To learn more about how to use the API and to access some useful examples of code, please visit https://api.staging.defrost.io/

PreviousWegaw API NextWegaw Dashboard

Last updated 1 year ago

hashtagStep 1: Obtain your API tokens

hashtagStep 2: Check the catchments available via API Request

hashtagStep 3: Get data via API Request

hashtagStep 4: Find available maps and download them via API Request

Step 1: Obtain your API tokens

Step 2: Check the catchments available via API Request

Step 3: Get data via API Request

Step 4: Find available maps and download them via API Request