Exports

2 opérations servies.

/

Fichiers complets des jeux

GET/api/v1/exports

Les éditions des fichiers complets que le contrat de l'organisation ouvre (jeux de son périmètre, droit d'export actif), plus les éditions communes : pour chacune, le jeu, la date d'édition, le format, la taille, le nombre de lignes, l'empreinte SHA-256, la présence du dictionnaire et de la fiche qualité, et le chemin de téléchargement. Seules les éditions dont la volumétrie a été contrôlée avant l'envoi sont listées. Réservé aux contrats ; REST seulement.

Coût: 0 crédit par appel réussi
Accès: Sur contrat
Portée: exports
Outil MCP: exports
Bac à sable: Non
Mémoire: 5 min
Délai: 5 s

Essayer en direct

Paramètres

jeutexte
Jeu exportable, tel que le périmètre du contrat le nomme.
Valeurs : annonces, evenements_prix, diffusion, biens, adresses, dvf_adresse, dpe, audits, coproprietes, permis, societes_civiles, pre_marche, communes, iris, urbanisme, agences, indice_travaux, barometre, tuiles

Exemple d'appel

curl https://pillr.fr/api/v1/exports \
  -H "Authorization: Bearer $PILLR_CLE"

Réponse

editionsliste d'objets
Les éditions ouvertes par le contrat, la plus récente d'abord.
Afficher les 11 champsMasquer
- jeutexte
- datetexte
  Date de l'édition (AAAA-MM-JJ).
- formattexte
  Valeurs : parquet, csv.gz, geoparquet, pmtiles
- taille_octetsnombre ou null
- lignesnombre ou null
- sha256texte ou null
  Empreinte SHA-256 du fichier.
- dictionnairebooléen
  Vrai : le dictionnaire des colonnes accompagne l'édition.
- fiche_qualitebooléen
  Vrai : la fiche qualité accompagne l'édition.
- perimetretexte
  contrat : édition propre au contrat ; echantillon : édition commune.
  Valeurs : contrat, echantillon
- genere_letexte ou null
- telechargementtexte
  Chemin du téléchargement (redirection vers le fichier).
duree_lien_sentier
Validité d'une adresse de téléchargement, en secondes.
retrait_particulierstexte
creditsobjet
Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).
Afficher les 2 champsMasquer
- debitesentier
  0 au moins
- restantsentier ou null

Erreurs possibles

400parametres_invalidesUn paramètre manque ou ne passe pas son contrôle ; le détail est donné champ par champ
401cle_absenteL'en-tête Authorization manque
401cle_invalideLa clé est inconnue, révoquée ou expirée
403organisation_suspendueL'organisation de la clé n'est pas active
403portee_insuffisanteLa clé ou l'accès de l'organisation n'ouvre pas cette opération
403palier_insuffisantL'accès de l'organisation n'atteint pas celui que l'opération exige
403hors_bac_a_sableUne clé pk_test_ l'appelle : l'opération n'a pas de bac à sable
402credits_insuffisantsLes crédits ne suffisent plus pour cet appel
429plafond_cleLe plafond mensuel de crédits de la clé est atteint
429quota_minuteLe débit par minute de l'organisation est atteint
503charge_globaleL'API est momentanément surchargée, tous clients confondus ; rien n'est débité
504delai_depasseLe calcul dépasse le délai de l'opération ; rien n'est débité
503service_indisponibleL'API est momentanément indisponible
500erreur_interneUne erreur de notre côté ; rien n'est servi ni débité

Une ressource absente répond par un code de la famille des ressources absentes, propre à l'opération, sans débit.

Téléchargement d'un fichier complet

GET/api/v1/exports/{jeu}/{date}

Redirige (302) vers le fichier d'une édition, son dictionnaire ou sa fiche qualité, par une adresse présignée valable 15 minutes. Chaque téléchargement est noté. Réservé aux contrats ; REST seulement.

Coût: 0 crédit par appel réussi
Accès: Sur contrat
Portée: exports
Outil MCP: exports_telecharger
Bac à sable: Non
Mémoire: Jamais gardée
Délai: 5 s