MoroccoAPIDocumentation
API reference

Choose a resource. Set the parameters. Try it.

No API keyJSON responsesOpen CORS

National census indicators

GET/api/v2/population/national/indicators

Good to know. RGPH 2024 and HCP historical series. See meta for each series’ source and date.

Understand the context

RGPH is the population census run by HCP, Morocco’s statistics office. A resident is not necessarily a Moroccan citizen. Reading example: 100 residents, including 95 Moroccan nationals and 5 foreign nationals, means a total of 100; do not add them again. These figures are illustrative.

Parameters

01
stringOptional · Query

Indicator group, such as education or employment.

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 27

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

Territory described by the indicators, with its codes and name.

data.territory.levelstring

Territorial level: national, regions, subdivisions (provinces and prefectures), prefectures-of-arrondissements, communes or arrondissements.

Accepted values: "national" "regions" "subdivisions" "prefectures-of-arrondissements" "communes" "arrondissements"

data.territory.codestring | null

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

data.territory.hcp_codestring | null

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

data.territory.nameobject

Resource name, grouped by language where applicable.

data.territory.name.arstring

Arabic value; null when no translation is provided.

data.territory.name.frstring

French value; null when no translation is provided.

data.territory.name.enstring | null

English value; null when no translation is provided.

data.territory.region_codestring | null

Identifier of the parent region, Morocco’s first administrative level.

data.territory.province_codestring | null

Identifier of the parent province or prefecture, below the region.

data.territory.data_from_local_administrationboolean

true for the four communes HCP marks with *: data supplied by the local administration because of seasonal mobility.

data.indicatorsobject[]

Census indicators for this territory, with their values by sex.

data.indicators[].idstring

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

data.indicators[].groupstring

Indicator group identifier, usable in the group filter.

data.indicators[].unitstring

Indicator unit: percent (0 to 100), persons, households, years, children-per-woman, persons-per-room, persons-per-household or km.

Accepted values: "percent" "persons" "households" "years" "children-per-woman" "persons-per-room" "persons-per-household" "km"

data.indicators[].nameobject

Resource name, grouped by language where applicable.

data.indicators[].name.frstring

French value; null when no translation is provided.

data.indicators[].name.enstring

English value; null when no translation is provided.

data.indicators[].name.arstring

Arabic value; null when no translation is provided.

data.indicators[].both_sexesnumber | null

Value for the whole population (both sexes), in the indicator’s unit; null when absent, see null_reasons.

data.indicators[].malenumber | null

Value for males, in the indicator’s unit; null when absent, see null_reasons.

data.indicators[].femalenumber | null

Value for females, in the indicator’s unit; null when absent, see null_reasons.

data.indicators[].null_reasonsobject

Why each value is null: unavailable (HCP “.”), not_applicable (HCP “…”) or not_published (no HCP value for that sex).

data.indicators[].null_reasons.both_sexesstring | null

Reason when this sex’s value is null: unavailable, not_applicable or not_published; null when the value exists.

data.indicators[].null_reasons.malestring | null

Reason when this sex’s value is null: unavailable, not_applicable or not_published; null when the value exists.

data.indicators[].null_reasons.femalestring | null

Reason when this sex’s value is null: unavailable, not_applicable or not_published; null when the value exists.

Data structure
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "meta"
  ],
  "properties": {
    "data": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "territory",
        "indicators"
      ],
      "properties": {
        "territory": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "level",
            "code",
            "hcp_code",
            "name",
            "region_code",
            "province_code",
            "data_from_local_administration"
          ],
          "properties": {
            "level": {
              "enum": [
                "national",
                "regions",
                "subdivisions",
                "prefectures-of-arrondissements",
                "communes",
                "arrondissements"
              ]
            },
            "code": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "string",
                  "nullable": true,
                  "enum": [
                    null
                  ]
                }
              ],
              "description": "MoroccoAPI geography code; null for the national total."
            },
            "hcp_code": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "string",
                  "nullable": true,
                  "enum": [
                    null
                  ]
                }
              ],
              "description": "HCP geographic code in the dotted form used by the geography endpoints; null for the national total."
            },
            "name": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "ar",
                "fr",
                "en"
              ],
              "properties": {
                "ar": {
                  "type": "string"
                },
                "fr": {
                  "type": "string"
                },
                "en": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "string",
                      "nullable": true,
                      "enum": [
                        null
                      ]
                    }
                  ]
                }
              }
            },
            "region_code": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "string",
                  "nullable": true,
                  "enum": [
                    null
                  ]
                }
              ]
            },
            "province_code": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "string",
                  "nullable": true,
                  "enum": [
                    null
                  ]
                }
              ]
            },
            "data_from_local_administration": {
              "type": "boolean",
              "description": "True for the four communes that HCP marks with *: their data comes from the local administration because of seasonal mobility."
            }
          }
        },
        "indicators": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "group",
              "unit",
              "name",
              "both_sexes",
              "male",
              "female",
              "null_reasons"
            ],
            "properties": {
              "id": {
                "type": "string",
                "minLength": 2,
                "maxLength": 64,
                "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
              },
              "group": {
                "type": "string"
              },
              "unit": {
                "enum": [
                  "percent",
                  "persons",
                  "households",
                  "years",
                  "children-per-woman",
                  "persons-per-room",
                  "persons-per-household",
                  "km"
                ]
              },
              "name": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "fr",
                  "en",
                  "ar"
                ],
                "properties": {
                  "fr": {
                    "type": "string"
                  },
                  "en": {
                    "type": "string"
                  },
                  "ar": {
                    "type": "string"
                  }
                }
              },
              "both_sexes": {
                "anyOf": [
                  {
                    "type": "number",
                    "minimum": 0
                  },
                  {
                    "type": "string",
                    "nullable": true,
                    "enum": [
                      null
                    ]
                  }
                ]
              },
              "male": {
                "anyOf": [
                  {
                    "type": "number",
                    "minimum": 0
                  },
                  {
                    "type": "string",
                    "nullable": true,
                    "enum": [
                      null
                    ]
                  }
                ]
              },
              "female": {
                "anyOf": [
                  {
                    "type": "number",
                    "minimum": 0
                  },
                  {
                    "type": "string",
                    "nullable": true,
                    "enum": [
                      null
                    ]
                  }
                ]
              },
              "null_reasons": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "both_sexes",
                  "male",
                  "female"
                ],
                "description": "Why each value is null: unavailable (HCP \".\"), not_applicable (HCP \"…\") or not_published (HCP gives no value for that sex). Null when the value is present.",
                "properties": {
                  "both_sexes": {
                    "anyOf": [
                      {
                        "enum": [
                          "unavailable",
                          "not_applicable",
                          "not_published"
                        ]
                      },
                      {
                        "type": "string",
                        "nullable": true,
                        "enum": [
                          null
                        ]
                      }
                    ]
                  },
                  "male": {
                    "anyOf": [
                      {
                        "enum": [
                          "unavailable",
                          "not_applicable",
                          "not_published"
                        ]
                      },
                      {
                        "type": "string",
                        "nullable": true,
                        "enum": [
                          null
                        ]
                      }
                    ]
                  },
                  "female": {
                    "anyOf": [
                      {
                        "enum": [
                          "unavailable",
                          "not_applicable",
                          "not_published"
                        ]
                      },
                      {
                        "type": "string",
                        "nullable": true,
                        "enum": [
                          null
                        ]
                      }
                    ]
                  }
                }
              }
            }
          }
        }
      }
    },
    "meta": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "dataset",
        "total",
        "license",
        "retrieved_at",
        "transformation_version",
        "sources"
      ],
      "properties": {
        "dataset": {
          "enum": [
            "population-indicators"
          ]
        },
        "total": {
          "type": "integer",
          "minimum": 0
        },
        "license": {
          "enum": [
            "CC-BY-4.0"
          ]
        },
        "retrieved_at": {
          "enum": [
            "2026-10-20"
          ]
        },
        "transformation_version": {
          "enum": [
            "1.0.1"
          ]
        },
        "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: "population-indicators"

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-10-20"

meta.transformation_versionstring

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

Accepted values: "1.0.1"

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.

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.

Your request

GET · JSON

Base URL

Response

The live response will appear here.

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