Skip to content

Latest commit

 

History

History
205 lines (157 loc) · 4.57 KB

README.md

File metadata and controls

205 lines (157 loc) · 4.57 KB
Raw

politie-api

Access the Politie Open data API with Node.js (unofficial)

npm Build Status Coverage Status

Usage

In the example below I first set up the Politie API basics. Then I send a geo position to the news endpoint. Finally some data is extracted and displayed on the console.

const PolitieAPI = require ('politie-api');
const politie = new PolitieAPI();

politie.nieuws ({
  lat: 51.9823204,
  lon: 5.9102271,
  radius: 25,
}))
  .then (news => console.table (news, [
    'publicatiedatum',
    'titel',
    'gebied',
  ]))
  .catch (console.log)
;

Installation

npm install politie-api

Methods

All functions take one object argument for the parameters. They always return a Promise.

nieuws

Get a list of all news messages, sorted by date and optionally sorted by geo position.

// Get all the news
politie.nieuws()
  .then (news => console.table (news, [
    'publicatiedatum',
    'titel',
    'gebied',
  ]))
  .catch (console.log)
;

// Or close to a location
politie.nieuws ({
  lat: 52.373089,
  lon: 4.8910403,
  radius: 5,
})
  .then (news => console.table (news, [
    'publicatiedatum',
    'titel',
    'gebied',
  ]))
  .catch (console.log)
;

politiebureaus

Get a list of all police stations or sorted by geo position.

// Get all police stations
politie.politiebureaus()
  .then (data => data.map (itm => {
    return {
      naam: itm.naam,
      adres: itm.bezoekadres.postadres,
      plaats: itm.bezoekadres.plaats,
    };
  }))
  .then (console.table)
  .catch (console.log)
;

// Or close to a location
politie.politiebureaus ({
  lat: 52.373089,
  lon: 4.8910403,
  radius: 5,
})
  .then (data => data.map (itm => {
    return {
      naam: itm.naam,
      adres: itm.bezoekadres.postadres,
      plaats: itm.bezoekadres.plaats,
    };
  }))
  .then (console.table)
  .catch (console.log)
;

wijkagenten

Get a list of local police agents. Twitter usernames have their non-word characters removed.

// Local police Twitters
politie.wijkagenten ({
  lat: 52.09314,
  lon: 5.1147328,
  radius: 5,
})
  .then (data => data.map (itm => {
    return {
      werkgebied: itm.werkgebied,
      twitter: itm.twitter.accountnaam,
    };
  }))
  .then (data => data.filter (itm => itm.twitter))
  .then (console.table)
  .catch (console.log)
;

Vermist

Search for missing persons. Does not include unidentified persons.

// List all
const data = await politie.vermist();

// Search
const data = await politie.vermist ({
  query: 'amsterdam',
});

urgentpolitiebericht

Get the current urgent police message, if available.

politie.urgentpolitiebericht()
  .then (console.log)
  .catch (console.error)
;

Unlicense

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to https://unlicense.org/

Author

Franklin | Buy me a coffee