MoroccoAPIDocumentation
API reference

Choose a resource. Set the parameters. Try it.

No API keyJSON responsesOpen CORS

Get a region

GET/api/v2/regions/{code}

Good to know. HCP reference: regions, provinces and communes. Codes are MoroccoAPI identifiers.

Understand the context

A region contains provinces and prefectures, which contain urban or rural communes (local authorities). Some communes are divided into arrondissements (urban districts). For example, Casablanca is a commune within the Casablanca-Settat region; an arrondissement is not a region. HCP is Morocco’s national statistics office; RGPH is its population census.

Parameters

01
stringRequired · Path

Resource identifier, taken from the list.

2-80 characters
Pattern^[a-z0-9-]+$
Read the response

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

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

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 8

[] 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.codestring

MoroccoAPI resource identifier; use it in the corresponding resource URLs.

Illustrative example: Rabat-Salé-Kénitra: code = "rabat-sale-kenitra", hcp_code = "04". They identify the same region in two different systems.

data.hcp_codestring

Code from HCP, Morocco’s national statistics office. Keep it as text to preserve leading zeros.

data.typestring

Kind of resource. Possible values are listed below.

Accepted values: "region"

data.nameobject

Resource name, grouped by language where applicable.

data.name.arstring

Arabic value; null when no translation is provided.

data.name.frstring

French value; null when no translation is provided.

data.name.enstring

English value; null when no translation is provided.

Data structure
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "meta"
  ],
  "properties": {
    "data": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "code",
        "hcp_code",
        "type",
        "name"
      ],
      "properties": {
        "code": {
          "type": "string"
        },
        "hcp_code": {
          "type": "string",
          "pattern": "^[0-9]{2}$"
        },
        "type": {
          "enum": [
            "region"
          ]
        },
        "name": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "ar",
            "fr",
            "en"
          ],
          "properties": {
            "ar": {
              "type": "string"
            },
            "fr": {
              "type": "string"
            },
            "en": {
              "type": "string"
            }
          }
        }
      }
    },
    "meta": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "dataset",
        "total",
        "license",
        "retrieved_at",
        "transformation_version",
        "sources"
      ],
      "properties": {
        "dataset": {
          "enum": [
            "administrative-regions"
          ]
        },
        "total": {
          "type": "integer",
          "minimum": 0
        },
        "license": {
          "enum": [
            "CC-BY-4.0"
          ]
        },
        "retrieved_at": {
          "enum": [
            "2026-09-25"
          ]
        },
        "transformation_version": {
          "enum": [
            "2.0.0"
          ]
        },
        "sources": {
          "type": "array",
          "minItems": 1,
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "dataset",
              "producer",
              "source_url",
              "resource_url",
              "license",
              "source_updated_at"
            ],
            "properties": {
              "dataset": {
                "type": "string"
              },
              "producer": {
                "type": "string"
              },
              "source_url": {
                "type": "string",
                "format": "uri"
              },
              "resource_url": {
                "type": "string",
                "format": "uri"
              },
              "license": {
                "enum": [
                  "CC-BY-4.0"
                ]
              },
              "source_updated_at": {
                "type": "string",
                "format": "date"
              }
            }
          }
        }
      }
    }
  }
}
Sources and pagination 13
metaobject

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

meta.datasetstring

Name of the dataset for this result or source.

Accepted values: "administrative-regions"

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: "CC-BY-4.0"

meta.retrieved_atstring

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

Accepted values: "2026-09-25"

meta.transformation_versionstring

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

Accepted values: "2.0.0"

meta.sourcesobject[]

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

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

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

Accepted values: "CC-BY-4.0"

meta.sources[].source_updated_atstring

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

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.

Illustrative example: Rabat-Salé-Kénitra: code = "rabat-sale-kenitra", hcp_code = "04". They identify the same region in two different systems.

error.messagestring

Human-readable error explanation; use code for application logic.

error.request_idstring

Identifier for this request, useful when reporting a problem.

Your request

GET · JSON

Base URL

Response

The live response will appear here.

Language changes the guide, not JSON keys or source values.