pappers-sdk v1.0.1

Avertissement

Ce SDK est développé et maintenu par Polyfact et n'est pas un SDK officiel fourni par Pappers. Il est conçu pour faciliter la récupération et la recherche de données politiques à partir de l'API de Pappers.

Pappers Politique SDK

Le SDK Pappers Politique permet d'interagir facilement avec l'API Pappers Politique pour récupérer des informations et des documents sur les données politiques françaises. Vous pouvez effectuer des recherches, récupérer des documents spécifiques, et obtenir des informations détaillées sur les acteurs parlementaires.

Installation

Pour installer le SDK, utilisez npm :

npm install pappers-sdk

Utilisation

Initialisation

Pour commencer à utiliser le SDK, vous devez initialiser le client avec votre clé API.

import { PappersSDK } from "pappers-sdk";

const apiToken = "votre_clé_api_ici";
const client = new PappersSDK(apiToken);

Recherche de documents

Vous pouvez effectuer une recherche dans la base de données des documents Pappers Politique.

client
  .search({
    q: "conflit d'intérêt",
    highlight: true,
    recherche_flat: true,
    types: ["amendement"],
    themes: ["Affaires étrangères et coopération"],
    statut: ["question-pending"],
    groupes_politiques: ["MoDem"],
    assemblies: ["assemblee-nationale"],
    article_modifie: ["Article L-3231 du code de la santé publique"],
    date_derniere_activite_min: "2024-01-01",
    date_derniere_activite_max: "2024-07-18",
    date_depot_min: "2024-01-01",
    date_depot_max: "2024-07-18",
    sort: "date_depot",
    page: 1,
    par_page: 20,
  })
  .then((results) => {
    results.results.forEach((document) => {
      console.log(document.titre);
    });
  });

Récupérer un document par ID

Vous pouvez récupérer les détails d'un document spécifique en utilisant son ID.

const documentId = "JORFTEXT000050038167";
client.getDocument(documentId).then((document) => {
  console.log(document.titre);
});

Récupérer un dossier législatif par ID

Vous pouvez récupérer les détails d'un dossier législatif en utilisant son ID.

const dossierId = "DLR5L16N48683";
client.getDossier(dossierId).then((dossier) => {
  console.log(dossier.titre);
});

Recherche d'acteurs

Vous pouvez rechercher des acteurs parlementaires selon différents critères.

client
  .searchActors({
    q: "Jean Lassalle",
    groupes_politiques: ["MoDem"],
    sources_parlementaires: ["assemblee-nationale"],
    statut_mandat: "ongoing",
    page: 1,
    par_page: 20,
  })
  .then((actors) => {
    actors.forEach((actor) => {
      console.log(actor.denomination);
    });
  });

Récupérer la fiche d'un acteur par ID

Vous pouvez récupérer les détails d'un acteur parlementaire en utilisant son ID.

const actorId = "PA722142";
client.getActor(actorId).then((actor) => {
  console.log(actor.denomination);
});

Recherche des interventions d'un acteur

Vous pouvez rechercher dans les interventions d'un acteur parlementaire.

client
  .searchActivitiesActor({
    id: "PA722142",
    q: "conflit d'intérêt",
    types: ["amendement"],
    page: 1,
    par_page: 20,
  })
  .then((results) => {
    results.results.forEach((doc) => {
      console.log(doc.titre);
    });
  });

Tester les exemples

Pour tester les exemples inclus dans ce package, suivez les étapes suivantes :

1. Compilez le fichier TypeScript example.ts en JavaScript :

   npx tsc example.ts

2. Exécutez le fichier JavaScript compilé :

   node example.js

Assurez-vous de remplacer les valeurs comme votre_api_token, document_id, dossier_id, et actor_id par des valeurs réelles avant d'exécuter les exemples.

Contribuer

Les contributions sont les bienvenues ! Si vous souhaitez contribuer, veuillez suivre les étapes ci-dessous :

1. Fork le dépôt
2. Créez une branche pour votre fonctionnalité (git checkout -b feature/AmazingFeature)
3. Committez vos changements (git commit -m 'Add some AmazingFeature')
4. Poussez votre branche (git push origin feature/AmazingFeature)
5. Ouvrez une Pull Request

License

MIT