FR Postal Code Gov API icon

FR Postal Code Gov API

1.0.x
(0 reviews)

API provided by
https://api.gouv.fr/documentation/api_carto_codes_postaux
Swagger can be found there:
https://apicarto.ign.fr/api/doc/codes-postaux.yml

sawgger does not work out of the box, here is the working content:

swagger: '2.0'
info:
  version: 1.0.0
  title: API Carto - codes-postaux
  description: >
    API de récupération des communes associées à un code postal donné. Voir https://github.com/BaseAdresseNationale/codes-postaux pour plus d'information sur les sources de données.

    Consultez la [documentation utilisateur](https://apicarto.ign.fr/api/doc/pdf/docUser_moduleCodesPostaux.pdf) pour plus d’informations sur les paramètres d’appel disponibles et le format des résultats.


consumes:
  - application/json

basePath: /api

produces:
  - application/json

paths:
  /codes-postaux/communes/{codePostal}:
    get:
      description: Renvoie les communes correspondant à un code postal
      parameters:
        - in: path
          name: codePostal
          type: string
          required: true
          description: Code postal de la commune.
      tags:
        - codes-postaux
      responses:
        200:
          description: Success
          schema:
            type: array
            items:
              $ref: '#/definitions/Commune'

definitions:
  Commune:
    type: object
    description: Commune correspondant au code postal
    properties:
      codePostal:
        type: string
        description: Le code postal
      codeCommune:
        type: string
        description: Le code INSEE de la commune
      nomCommune:
        type: string
        description: Le nom de la commune
      libelleAcheminement:
        type: string
        description: Le libellé d'acheminement

Reviews