Zum Inhalt

API-Dokumentation

Endpunkte, Parameter und Beispielantworten der öffentlichen API (v1).

  • GET/api/v1/search

    Search publications

    q
    query
    category
    query
    kind
    query
    outcome
    query
    authority
    query
    case_number
    query
    activity
    query
    from
    query
    to
    query
    near
    lon,lat
    radius
    query
    sort
    query
    page
    query
    per_page
    query
  • GET/api/v1/suggest

    Typed suggestions (authority, case number, address)

    q*
    query
  • GET/api/v1/publications/{id}

    One official publication

    id*
    path
  • GET/api/v1/procedures/{id}

    Procedure dossier with timeline

    id*
    path
  • GET/api/v1/projects/{id}

    Project (procedures linked by explicit source references)

    id*
    path
  • GET/api/v1/addresses/{bagId}

    Address passport

    bagId*
    path
  • GET/api/v1/map

    GeoJSON features in a bounding box (areas stay areas)

    bbox*
    query
    category
    query
    zoom
    query
  • GET/api/v1/categories

    The eleven categories with counts

  • GET/api/v1/sources

    Source health, coverage, exclusions and legal rule register

  • GET/api/v1/plans/{id}/compare

    Compare two versions of one plan

    id*
    path
    from*
    query
    to*
    query
  • POST/api/v1/letters

    Compose an inspection, copy or Woo request (never sent by Vergunning.app)