Codes postaux/API v2

Rechercher un code postal

GET/api/v2/postal-codes

À savoir. Snapshot Poste Maroc de septembre 2018, pas nécessairement actuel. 45 lignes suspectes exclues. Un lieu peut avoir plusieurs codes.

Renseignez au moins un filtre : q, region_code, province_code ou city.

Comprendre le contexte

Un code postal sert à acheminer le courrier ; un code HCP identifie une unité administrative. Une ville peut avoir plusieurs codes postaux, répartis par quartier. Le fichier décrit septembre 2018.

Paramètres

qstringFacultatif · Filtre

Texte à rechercher, au moins 2 caractères.

2-100 caractères

typestringFacultatif · Filtre

Type de ressource.

region_codestringFacultatif · Filtre

Code MoroccoAPI de la région.

province_codestringFacultatif · Filtre

Code MoroccoAPI de la province ou préfecture.

citystringFacultatif · Filtre

Une des villes de /postal-codes/cities, sans distinction de casse, d’accents, d’espaces ou de tirets.

2-100 caractères

limitintegerFacultatif · Filtre

Résultats par page. 100 par défaut, 500 maximum.

Minimum: 1Maximum: 500Par défaut: 100

offsetintegerFacultatif · Filtre

Résultats à ignorer après filtrage. Commence à 0.

Minimum: 0Maximum: 2147483647Par défaut: 0

Comprendre la réponse

data: Les résultats demandés, sous forme d’objet ou de liste.

meta: Sources, licence et dates du jeu de données. null signifie une valeur inconnue ou indisponible.

meta.pagination: Listes : 100 résultats par défaut, 500 maximum. Utilisez limit et offset ; meta.pagination.next_offset vaut null à la dernière page.

Exemple illustratif: Avec limit=10 et offset=0, la première page contient au plus 10 résultats. Si next_offset vaut 10, demandez la suivante avec offset=10 et les mêmes filtres. Arrêtez quand next_offset vaut null.

API v2 est le chemin de référence. Les anciens chemins /api/v1 restent des alias de compatibilité du comportement actuellement publié, pagination comprise ; aucune date de suppression n’est fixée.

Champs renvoyés 8

[] désigne chaque élément d’une liste. null signifie inconnu ou indisponible, jamais zéro. La langue du guide ne traduit pas les valeurs des sources.

dataobject[]

Résultat demandé : objet unique ou liste.

data[].postal_codestring

Code postal à cinq chiffres, conservé comme texte ; ne pas le confondre avec un code HCP.

data[].typestring

locality : lieu à code unique hors villes multicode ; neighborhood : quartier d’une ville ayant plusieurs codes.

Valeurs acceptées: "locality" "neighborhood"

data[].namestring

Nom de la ressource, éventuellement réparti par langue.

data[].citystring | null

Ville multicode à laquelle appartient le quartier ; null pour une localité autonome.

data[].province_codestring

Identifiant de la province ou préfecture parente, sous la région.

data[].region_codestring

Identifiant de la région parente, premier niveau administratif du Maroc.

data[].commune_codestring | null

Correspondance exacte du nom de localité avec une commune de la même province. null sans correspondance et pour tous les quartiers.

Structure des données

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "meta"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "postal_code",
          "type",
          "name",
          "city",
          "province_code",
          "region_code",
          "commune_code"
        ],
        "properties": {
          "postal_code": {
            "type": "string",
            "pattern": "^[0-9]{5}$"
          },
          "type": {
            "type": "string",
            "enum": [
              "locality",
              "neighborhood"
            ],
            "description": "locality: a place outside the multi-code cities, with one code. neighborhood: a neighbourhood of a multi-code city."
          },
          "name": {
            "type": "string",
            "description": "Poste Maroc spelling, preserved apart from whitespace."
          },
          "city": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "string",
                "nullable": true,
                "enum": [
                  null
                ]
              }
            ],
            "description": "Multi-code city of a neighborhood, or null for a locality."
          },
          "province_code": {
            "type": "string"
          },
          "region_code": {
            "type": "string"
          },
          "commune_code": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "string",
                "nullable": true,
                "enum": [
                  null
                ]
              }
            ],
            "description": "MoroccoAPI commune whose name equals the locality name in the same province. Null when there is no exact match, and always null for neighborhoods."
          }
        }
      }
    },
    "meta": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "dataset",
        "total",
        "license",
        "retrieved_at",
        "transformation_version",
        "sources",
        "pagination"
      ],
      "properties": {
        "dataset": {
          "enum": [
            "postal-codes"
          ]
        },
        "total": {
          "type": "integer",
          "minimum": 0
        },
        "license": {
          "enum": [
            "ODbL-1.0"
          ]
        },
        "retrieved_at": {
          "enum": [
            "2026-10-14"
          ]
        },
        "transformation_version": {
          "enum": [
            "1.1.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": [
                  "ODbL-1.0",
                  "CC-BY-4.0"
                ]
              },
              "source_updated_at": {
                "type": "string",
                "format": "date"
              }
            }
          }
        },
        "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 et pagination 19

metaobject

Contexte du résultat : sources, dates, licence et pagination si applicable.

meta.datasetstring

Nom du jeu de données auquel appartient le résultat ou la source.

Valeurs acceptées: "postal-codes"

meta.totalinteger

Nombre de résultats correspondant aux filtres, avant pagination ; pas la taille de cette page.

meta.licensestring

Licence de réutilisation. mixed signifie des licences différentes : consultez chaque source.

Valeurs acceptées: "ODbL-1.0"

meta.retrieved_atstring

Date de récupération du fichier source par le projet ; pas la date des observations.

Valeurs acceptées: "2026-10-14"

meta.transformation_versionstring

Version des règles de conversion du jeu de données ; distincte de l’API.

Valeurs acceptées: "1.1.0"

meta.sourcesobject[]

Sources utilisées pour ce résultat, avec leurs producteurs et licences.

meta.sources[].datasetstring

Nom du jeu de données auquel appartient le résultat ou la source.

meta.sources[].producerstring

Organisme qui publie la donnée originale.

meta.sources[].source_urlstring

Page de présentation ou de publication de la source.

meta.sources[].resource_urlstring

Lien vers le fichier ou la ressource utilisée.

meta.sources[].licensestring

Licence de réutilisation. mixed signifie des licences différentes : consultez chaque source.

Valeurs acceptées: "ODbL-1.0" "CC-BY-4.0"

meta.sources[].source_updated_atstring

Dernière mise à jour annoncée par la source ; pas la date de récupération.

meta.paginationobject

Informations pour parcourir une collection page par page.

meta.pagination.limitinteger

Nombre maximal demandé par page : 100 par défaut, 500 au maximum.

meta.pagination.offsetinteger

Nombre de résultats ignorés avant cette page, après filtrage. La première page commence à 0.

meta.pagination.countinteger

Nombre de résultats effectivement présents dans cette page.

meta.pagination.has_moreboolean

true s’il reste une autre page de résultats.

meta.pagination.next_offsetinteger | null

Valeur de offset pour la page suivante ; null à la fin. Gardez les mêmes filtres.

Erreurs

400: Paramètre invalide ou manquant.

Les erreurs renvoient error.code, error.message et error.request_id.

errorobject: Détails d’une requête échouée ; remplace data et meta.
error.codestring: Code stable de l’erreur, par exemple RESOURCE_NOT_FOUND ; à utiliser dans votre logique.
error.messagestring: Explication lisible de l’erreur ; utilisez code pour la logique de votre application.
error.request_idstring: Identifiant du traitement de cette requête, utile pour retrouver un problème.

Rechercher un code postal

Paramètres

Votre requête