Dams/API v2

Dam level history

GET/api/v2/dams/{id}/levels

Good to know. Partial historical observations, no real-time data or interpolation. date_basis distinguishes source dates from dashboard headline dates. Volume: million m³; filling rate: %.

Understand the context

Illustrative example: 50 Mm³ stored in a 100 Mm³ reservoir means 50% full. Available observations are historical and do not cover every dam.

Read the response

data: The requested results, as an object or an array.

meta: Dataset sources, license and dates. null means unknown or unavailable.

meta.pagination: Lists: 100 results by default, 500 maximum. Use limit and offset; meta.pagination.next_offset is null on the last page.

Illustrative example: With limit=10 and offset=0, the first page holds at most 10 results. If next_offset is 10, request the next page with offset=10 and the same filters. Stop when next_offset is null.

API v2 is the canonical path. Older /api/v1 paths remain compatibility aliases for the currently published behavior, including pagination; no removal date is scheduled.

Response fields 14

[] means each item in a list. null means unknown or unavailable, never zero. The guide language does not translate source values.

dataobject[]

Requested result: a single object or a list.

data[].dam_idstring

Dam identifier, reusable in /dams/{id}.

data[].datestring

Calendar date in YYYY-MM-DD format; null if awaiting confirmation.

data[].date_basisstring

source_calendar: source calendar date; dashboard_headline: dashboard heading date.

Accepted values: "source_calendar" "dashboard_headline"

data[].capacity_mm3number | null

Reservoir capacity in million cubic metres (Mm³); null if unknown.

data[].volume_mm3number

Stored water in million cubic metres. 1 Mm³ = 1,000,000 m³.

data[].filling_rate_pctnumber

Filling percentage: 50 means 50%, not 0.5.

data[].previous_year_filling_rate_pctnumber | null

Previous-year filling percentage reported by the source, or null.

data[].source_idstring

Identifier linking this observation to an entry in meta.sources.

data[].source_refobject

Location of the observation in the source: sheet/row or basin/index.

data[].source_ref.sheetstring

Source spreadsheet sheet name.

data[].source_ref.rowinteger

Source spreadsheet row number, starting at 1.

data[].source_ref.basin_codestring

Basin code in the source dashboard, not an HCP code.

data[].source_ref.dam_indexinteger

Dam position in the source basin list, starting at 1; not a stable identifier.

Data structure

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "meta"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "dam_id",
          "date",
          "date_basis",
          "capacity_mm3",
          "volume_mm3",
          "filling_rate_pct",
          "source_id",
          "source_ref"
        ],
        "properties": {
          "dam_id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 100,
            "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
          },
          "date": {
            "type": "string",
            "format": "date"
          },
          "date_basis": {
            "type": "string",
            "enum": [
              "source_calendar",
              "dashboard_headline"
            ]
          },
          "capacity_mm3": {
            "anyOf": [
              {
                "type": "number",
                "minimum": 0
              },
              {
                "type": "string",
                "nullable": true,
                "enum": [
                  null
                ]
              }
            ]
          },
          "volume_mm3": {
            "type": "number",
            "minimum": 0
          },
          "filling_rate_pct": {
            "type": "number",
            "minimum": 0
          },
          "previous_year_filling_rate_pct": {
            "anyOf": [
              {
                "type": "number",
                "minimum": 0
              },
              {
                "type": "string",
                "nullable": true,
                "enum": [
                  null
                ]
              }
            ]
          },
          "source_id": {
            "type": "string"
          },
          "source_ref": {
            "anyOf": [
              {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "sheet",
                  "row"
                ],
                "properties": {
                  "sheet": {
                    "type": "string"
                  },
                  "row": {
                    "type": "integer",
                    "minimum": 1
                  }
                }
              },
              {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "basin_code",
                  "dam_index"
                ],
                "properties": {
                  "basin_code": {
                    "type": "string",
                    "pattern": "^MH[1-9]$"
                  },
                  "dam_index": {
                    "type": "integer",
                    "minimum": 1
                  }
                }
              }
            ]
          }
        }
      }
    },
    "meta": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "dataset",
        "total",
        "license",
        "license_url",
        "retrieved_at",
        "source_updated_at",
        "transformation_version",
        "coverage",
        "sources",
        "pagination"
      ],
      "properties": {
        "dataset": {
          "enum": [
            "morocco-dams"
          ]
        },
        "total": {
          "type": "integer",
          "minimum": 0
        },
        "license": {
          "enum": [
            "mixed"
          ]
        },
        "license_url": {
          "type": "string",
          "nullable": true,
          "enum": [
            null
          ]
        },
        "retrieved_at": {
          "type": "string",
          "format": "date"
        },
        "source_updated_at": {
          "anyOf": [
            {
              "type": "string",
              "format": "date"
            },
            {
              "type": "string",
              "nullable": true,
              "enum": [
                null
              ]
            }
          ]
        },
        "transformation_version": {
          "type": "string"
        },
        "coverage": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "basin",
            "basins",
            "from",
            "to",
            "real_time",
            "complete_national_coverage",
            "limitations"
          ],
          "properties": {
            "basin": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "bouregreg",
                    "draa-oued-noun",
                    "guir-ziz-gheris",
                    "loukkos",
                    "moulouya",
                    "oum-er-rbia",
                    "sebou",
                    "souss-massa",
                    "tensift"
                  ]
                },
                {
                  "type": "string",
                  "nullable": true,
                  "enum": [
                    null
                  ]
                }
              ]
            },
            "basins": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "bouregreg",
                  "draa-oued-noun",
                  "guir-ziz-gheris",
                  "loukkos",
                  "moulouya",
                  "oum-er-rbia",
                  "sebou",
                  "souss-massa",
                  "tensift"
                ]
              }
            },
            "from": {
              "type": "string",
              "format": "date"
            },
            "to": {
              "type": "string",
              "format": "date"
            },
            "real_time": {
              "enum": [
                false
              ]
            },
            "complete_national_coverage": {
              "enum": [
                false
              ]
            },
            "limitations": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        },
        "sources": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "dataset",
              "producer",
              "source_url",
              "resource_url",
              "license",
              "license_url",
              "date_basis",
              "source_updated_at"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "dataset": {
                "type": "string"
              },
              "producer": {
                "type": "string"
              },
              "source_url": {
                "type": "string",
                "format": "uri"
              },
              "resource_url": {
                "type": "string",
                "format": "uri"
              },
              "license": {
                "anyOf": [
                  {
                    "enum": [
                      "ODbL-1.0"
                    ]
                  },
                  {
                    "type": "string",
                    "nullable": true,
                    "enum": [
                      null
                    ]
                  }
                ]
              },
              "license_url": {
                "anyOf": [
                  {
                    "type": "string",
                    "format": "uri"
                  },
                  {
                    "type": "string",
                    "nullable": true,
                    "enum": [
                      null
                    ]
                  }
                ]
              },
              "date_basis": {
                "type": "string",
                "enum": [
                  "source_calendar",
                  "dashboard_headline"
                ]
              },
              "source_updated_at": {
                "anyOf": [
                  {
                    "type": "string",
                    "format": "date"
                  },
                  {
                    "type": "string",
                    "nullable": true,
                    "enum": [
                      null
                    ]
                  }
                ]
              }
            }
          }
        },
        "pagination": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "limit",
            "offset",
            "count",
            "has_more",
            "next_offset"
          ],
          "properties": {
            "limit": {
              "type": "integer",
              "minimum": 1,
              "maximum": 500
            },
            "offset": {
              "type": "integer",
              "minimum": 0,
              "maximum": 2147483647
            },
            "count": {
              "type": "integer",
              "minimum": 0,
              "maximum": 500
            },
            "has_more": {
              "type": "boolean"
            },
            "next_offset": {
              "anyOf": [
                {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 2147483647
                },
                {
                  "type": "string",
                  "nullable": true,
                  "enum": [
                    null
                  ]
                }
              ]
            }
          }
        }
      }
    }
  }
}

Sources and pagination 32

metaobject

Result context: sources, dates, license and pagination where applicable.

meta.datasetstring

Name of the dataset for this result or source.

Accepted values: "morocco-dams"

meta.totalinteger

Number of matching records before pagination; not the size of this page.

meta.licensestring

Reuse license. mixed means licenses differ: inspect each source.

Accepted values: "mixed"

meta.license_urlnull

Link to the license terms; null when no URL is supplied.

Accepted values: null

meta.retrieved_atstring

Date the project retrieved the source file; not the observation date.

meta.source_updated_atstring | null

Last update reported by the source; not the retrieval date.

meta.transformation_versionstring

Version of the dataset conversion rules; separate from the API version.

meta.coverageobject

Geographic and time coverage actually available.

meta.coverage.basinstring | null

River basin: an area draining to the same water system, separate from an administrative region.

meta.coverage.basinsstring[]

Basins covered by the observations.

meta.coverage.fromstring

Start of the covered or requested period, inclusive.

meta.coverage.tostring

End of the covered or requested period, inclusive.

meta.coverage.real_timeboolean

false means observations are historical, without live updates.

Accepted values: false

meta.coverage.complete_national_coverageboolean

false means the dataset does not cover every dam in Morocco.

Accepted values: false

meta.coverage.limitationsstring[]

Known source or coverage limitations; read before using the data.

meta.sourcesobject[]

Sources used for this result, with their publishers and licenses.

meta.sources[].idstring

Identifier of this item in the dataset; not necessarily an official code.

meta.sources[].datasetstring

Name of the dataset for this result or source.

meta.sources[].producerstring

Organization publishing the original data.

meta.sources[].source_urlstring

Source publication or dataset landing page.

meta.sources[].resource_urlstring

Link to the actual file or resource used.

meta.sources[].licensestring | null

Reuse license. mixed means licenses differ: inspect each source.

meta.sources[].license_urlstring | null

Link to the license terms; null when no URL is supplied.

meta.sources[].date_basisstring

source_calendar: source calendar date; dashboard_headline: dashboard heading date.

Accepted values: "source_calendar" "dashboard_headline"

meta.sources[].source_updated_atstring | null

Last update reported by the source; not the retrieval date.

meta.paginationobject

Information for reading a collection one page at a time.

meta.pagination.limitinteger

Requested maximum records per page: default 100, maximum 500.

meta.pagination.offsetinteger

Matching records skipped before this page, after filtering. The first page starts at 0.

meta.pagination.countinteger

Number of records actually returned on this page.

meta.pagination.has_moreboolean

true when another page of records remains.

meta.pagination.next_offsetinteger | null

Use as offset for the next page; null at the end. Keep the same filters.

Errors

400: Invalid or missing parameter.
404: Resource not found.

Errors return error.code, error.message and error.request_id.

errorobject: Details of a failed request; replaces data and meta.
error.codestring: Stable error code, such as RESOURCE_NOT_FOUND; use it in application logic.
error.messagestring: Human-readable error explanation; use code for application logic.
error.request_idstring: Identifier for this request, useful when reporting a problem.

Dam level history

Parameters

Your request