EyeOnWater Observations API

https://www.eyeonwater.org/api
Admin
EyeOnWater Observations API allows anyone to export the publicly available observations.
Tokens:1,587
Snippets:7
Trust Score:8.1
Update:3 months ago
Show doc for...
Tokens:
Raw
### Get All Observations

Source: https://www.eyeonwater.org/api

Retrieves a list of all publicly available observations.

```APIDOC
## GET /api/observations

### Description
Returns a list of observations.

### Method
GET

### Endpoint
/api/observations
```

--------------------------------

### Get Observations for Australia

Source: https://www.eyeonwater.org/api

Retrieves a list of publicly available observations specifically for Australia.

```APIDOC
## GET /api/observations/australia

### Description
Returns a list of observations for Australia.

### Method
GET

### Endpoint
/api/observations/australia
```

--------------------------------

### GET /api/observations

Source: https://www.eyeonwater.org/api/specifications

Returns a list of water observations. This endpoint allows filtering by period, user, bounding box, and Forel-Ule value, as well as controlling the offset, limit, and sort order. The response format can be JSON or CSV.

```APIDOC
## GET /api/observations

### Description
Retrieves a list of water observations with various filtering and pagination options.

### Method
GET

### Endpoint
/api/observations

### Parameters
#### Query Parameters
- **period** (integer) - Optional - Specifies the number of months into the past for which to retrieve data. Defaults to 12.
- **offset** (integer) - Optional - Offset the list of the observations. Defaults to 0.
- **limit** (integer) - Optional - Limit the list of the observations. Defaults to 10.
- **sort** (string) - Optional - Order the list of observation based on the input date. Allowed values: "asc", "desc". Defaults to "desc".
- **fu_value** (integer) - Optional - Select specific Forel-Ule value for filtering. Allowed values: 0-21.
- **user** (integer) - Optional - Select measurements from a specific user, identified by user_n_code.
- **bbox** (string) - Optional - Bounding box to define the area of interest, specified as a comma-separated list of coordinates 'minLongitude,minLatitude,maxLongitude,maxLatitude'. Defaults to '-70,-100,70,100'.
- **bboxVersion** (string) - Optional - The API supports OGC WMS bounding box versions 1.1.1 and 1.3.0. Defaults to '1.3.0'. Allowed values: "1.3.0", "1.1.1".
- **format** (string) - Optional - The data format in which the data should be returned. Defaults to 'application/json'. Allowed values: "application/json", "text/csv".

### Response
#### Success Response (200)
- The response can be a JSON array of water observations or CSV data, depending on the 'format' parameter.

#### Response Example (JSON)
{
  "example": "[{"observation_id": 123, "timestamp": "2023-10-27T10:00:00Z", "latitude": 52.3702, "longitude": 4.8952, "value": 10, "unit": "°C"}]
"
}

#### Response Example (CSV)
"observation_id","timestamp","latitude","longitude","value","unit"
"123","2023-10-27T10:00:00Z","52.3702","4.8952","10","°C"
```

--------------------------------

### GET /api/observations/australia

Source: https://www.eyeonwater.org/api/specifications

Returns a list of water observations specifically for Australia, using a predefined bounding box. This endpoint supports filtering by period, user, and Forel-Ule value, as well as controlling the offset, limit, and sort order.

```APIDOC
## GET /api/observations/australia

### Description
Retrieves a list of water observations for Australia.

### Method
GET

### Endpoint
/api/observations/australia

### Parameters
#### Query Parameters
- **period** (integer) - Optional - Specifies the number of months into the past for which to retrieve data. Defaults to 12.
- **offset** (integer) - Optional - Offset the list of the observations. Defaults to 0.
- **limit** (integer) - Optional - Limit the list of the observations. Defaults to 10.
- **sort** (string) - Optional - Order the list of observation based on the input date. Allowed values: "asc", "desc". Defaults to "desc".
- **fu_value** (integer) - Optional - Select specific Forel-Ule value for filtering. Allowed values: 0-21.
- **user** (integer) - Optional - Select measurements from a specific user, identified by user_n_code.

### Response
#### Success Response (200)
- A JSON array of water observations within the Australia bounding box.

#### Response Example (JSON)
{
  "example": "[{"observation_id": 456, "timestamp": "2023-10-26T09:00:00Z", "latitude": -25.2744, "longitude": 133.7751, "value": 15, "unit": "°C"}]
"
}
```

--------------------------------

### Get Water Observations

Source: https://www.eyeonwater.org/api/specifications

Retrieves a list of water observations. You can filter the results by specifying a user code or a bounding box. The response can be in JSON or CSV format.

```APIDOC
## GET /observations

### Description
Retrieves a list of water observations, optionally filtered by user and location.

### Method
GET

### Endpoint
/observations

### Parameters
#### Query Parameters
- **user_n_code** (integer) - Optional - The user's unique identification code.
- **bbox** (string) - Optional - Bounding box to define the area of interest, specified as a comma-separated list of coordinates 'minLongitude,minLatitude,maxLongitude,maxLatitude'. Defaults to '-70,-100,70,100'.
- **bboxVersion** (string) - Optional - The API supports OGC WMS bounding box versions 1.1.1 and 1.3.0. Defaults to '1.3.0'. Enum: ['1.3.0', '1.1.1'].
- **format** (string) - Optional - The data format in which the data should be returned. Defaults to 'application/json'. Enum: ['application/json', 'text/csv'].

### Response
#### Success Response (200)
- **waterobservations** (array) - A JSON array of water observations.

#### Response Example (JSON)
{
  "example": "[\n  {\n    \"lat\": 48.8566, \n    \"lng\": 2.3522, \n    \"device_platform\": \"IOS\", \n    \"device_model\": \"Iphone15\", \n    \"bottom\": 10, \n    \"date_photo\": \"2023-10-27T10:00:00Z\", \n    \"image\": 12345, \n    \"viewing_angle\": 45, \n    \"rain\": 0 \n  }\n]"
}

#### Response Example (CSV)
"lat","lng","device_platform","device_model","bottom","date_photo","image","viewing_angle","rain"
"48.8566","2.3522","IOS","Iphone15","10","2023-10-27T10:00:00Z","12345","45","0"
```
Tokens:
Raw