Livelihoods Explorer
English Spanish French
English Spanish French

API du Livelihoods Explorer

Le Livelihoods Explorer (LEX) propose une API REST complète pour accéder aux données selon les autorisations de l’utilisateur. Cette API offre plus de souplesse que l’interface utilisateur du Livelihoods Explorer.

L’API REST du LEX prend en charge de nombreuses fonctions. Une documentation interactive de l’API est disponible (en anglais).

Authentification

Une petite partie des informations du Livelihoods Explorer n’est pas publique, notamment la liste des noms de communautés et les liens de téléchargement des fichiers BSS d’origine. Pour accéder à ces informations, les utilisateurs doivent s’authentifier en se connectant au Livelihoods Explorer. Une fois la connexion établie, votre navigateur envoie automatiquement un cookie de session pour authentifier les requêtes adressées à l’API.

Si vous ne vous authentifiez pas ou si vous n’avez pas l’autorisation d’accéder aux données :

  • Vous pouvez recevoir l’erreur « no data found » lorsque vous interrogez des données dont l’accès est restreint.

  • Il est possible que toutes les données attendues ne figurent pas dans la réponse.

Structure des liens de l’API

Chaque URL comporte jusqu’à 5 parties : l’URL de base, le point de terminaison, le format de sortie, les filtres et les champs.

Exemple :

https://livelihoods.fews.net/api/season.html?country=ET&fields=simple

Cette URL comporte les 5 parties. Elle permet d’afficher la liste des saisons de la base de données pour l’Éthiopie.

  • URL de base de la base de données AEM/HEA : https://livelihoods.fews.net/api/

  • Point de terminaison : season

  • Format de sortie : .html

  • Filtres : ?country=ET

  • Champs : &fields=simple

URL de base

L’URL de base de l’API du Livelihoods Explorer est https://livelihoods.fews.net/api/.

Points de terminaison

Cette API comprend de nombreux points de terminaison.

Les points de terminaison les plus utiles pour l’analyse de données sont les suivants :

Nom

URL

Description

livelihoodactivitysummary

https://livelihoods.fews.net/api/livelihoodactivitysummary/

Affiche les sommes agrégées de calories et de revenus tirées d’activités de moyens d’existence précises pour les Groupes de richesse de référence. Calcule la part du revenu global, des dépenses, de kcals_consumed et de percentage_kcals
qui provient de produits et/ou de types de stratégie précis. En savoir plus sur ce point de terminaison.

livelihoodzonebaseline

https://livelihoods.fews.net/api/livelihoodzonebaseline/

Accède aux données spatiales des zones de moyens d’existence disponibles, pour la cartographie.

thresholdcomponent

https://livelihoods.fews.net/api/livelihoodzonebaseline/ https://livelihoods.fews.net/api/thresholdcomponent/

Renvoie une vue calculée des éléments qui composent les Seuils de survie et de protection des moyens d’existence de chaque Groupe de richesse.

Les points de terminaison les plus utiles pour la collecte et la soumission des données des BSS sont les suivants :

Nom

URL

Description

classifiedproduct

https://livelihoods.fews.net/api/classifiedproduct/

Affiche la liste des produits de la base de données et de leurs alias.

season

https://livelihoods.fews.net/api/season/

Affiche la liste des saisons de la base de données.

seasonalactivitytype

https://livelihoods.fews.net/api/seasonalactivitytype/

Affiche la liste des types d’activités saisonnières disponibles dans la base de données et de leurs alias.

wealthcharacteristic

https://livelihoods.fews.net/api/wealthcharacteristic/

Affiche la liste des caractéristiques de richesse disponibles dans la base de données et de leurs alias.

livelihoodcategory

https://livelihoods.fews.net/api/livelihoodcategory/

Affiche la liste des catégories de moyens d’existence (p. ex. types de zones de moyens d’existence) disponibles dans la base de données et de leurs alias.

livelihoodproductcategory

https://livelihoods.fews.net/api/livelihoodproductcategory/

Affiche la liste des articles inclus dans les paniers.

wealthgroupcategory

https://livelihoods.fews.net/api/wealthgroupcategory/

Affiche la liste des catégories de groupe de richesse disponibles dans la base de données et de leurs alias.

hazardcategory

https://livelihoods.fews.net/api/hazardcategory/

Affiche la liste des catégories d’aléas disponibles dans la base de données et de leurs alias.

Autres points de terminaison :

Nom

URL

country

https://livelihoods.fews.net/api/country/

currency

https://livelihoods.fews.net/api/currency/

unitofmeasure

https://livelihoods.fews.net/api/unitofmeasure/

user

https://livelihoods.fews.net/api/user/

userprofile

https://livelihoods.fews.net/api/userprofile/

sourceorganization

https://livelihoods.fews.net/api/sourceorganization/

livelihoodzone

https://livelihoods.fews.net/api/livelihoodzone/

community

https://livelihoods.fews.net/api/community/

wealthgroup

https://livelihoods.fews.net/api/wealthgroup/

baselinewealthgroup

https://livelihoods.fews.net/api/baselinewealthgroup/

communitywealthgroup

https://livelihoods.fews.net/api/communitywealthgroup/

wealthgroupcharacteristicvalue

https://livelihoods.fews.net/api/wealthgroupcharacteristicvalue/

baselinewealthgroupcharacteristicvalue

https://livelihoods.fews.net/api/baselinewealthgroupcharacteristicvalue/

communitywealthgroupcharacteristicvalue

https://livelihoods.fews.net/api/communitywealthgroupcharacteristicvalue/

livelihoodstrategy

https://livelihoods.fews.net/api/livelihoodstrategy/

livelihoodactivity

https://livelihoods.fews.net/api/livelihoodactivity/

baselinelivelihoodactivity

https://livelihoods.fews.net/api/baselinelivelihoodactivity/

responselivelihoodactivity

https://livelihoods.fews.net/api/responselivelihoodactivity/

milkproduction

https://livelihoods.fews.net/api/milkproduction/

butterproduction

https://livelihoods.fews.net/api/butterproduction/

meatproduction

https://livelihoods.fews.net/api/meatproduction/

livestocksale

https://livelihoods.fews.net/api/livestocksale/

cropproduction

https://livelihoods.fews.net/api/cropproduction/

foodpurchase

https://livelihoods.fews.net/api/foodpurchase/

paymentinkind

https://livelihoods.fews.net/api/paymentinkind/

relief

https://livelihoods.fews.net/api/relief/

fishing

https://livelihoods.fews.net/api/fishing/

hunting

https://livelihoods.fews.net/api/hunting/

wildfoodgathering

https://livelihoods.fews.net/api/wildfoodgathering/

othercashincome

https://livelihoods.fews.net/api/othercashincome/

otherpurchase

https://livelihoods.fews.net/api/otherpurchase/

seasonalactivity

https://livelihoods.fews.net/api/seasonalactivity/

seasonalactivityoccurrence

https://livelihoods.fews.net/api/seasonalactivityoccurrence/

communitycropproduction

https://livelihoods.fews.net/api/communitycropproduction/

communitylivestock

https://livelihoods.fews.net/api/communitylivestock/

marketprice

https://livelihoods.fews.net/api/marketprice/

seasonalproductionperformance

https://livelihoods.fews.net/api/seasonalproductionperformance/

hazard

https://livelihoods.fews.net/api/hazard/

event

https://livelihoods.fews.net/api/event/

expandabilityfactor

https://livelihoods.fews.net/api/expandabilityfactor/

copingstrategy

https://livelihoods.fews.net/api/copingstrategy/

Format de sortie

Tous les points de terminaison prennent en charge un ensemble standard de formats d’extraction, accessibles par une extension dans l’URL (p. ex. https://livelihoods.fews.net/api/livelihoodactivitysummary.html) ou par un paramètre de requête (p. ex. https://livelihoods.fews.net/api/livelihoodactivitysummary/&format=json).

Les valeurs standard du paramètre format sont les suivantes :

  • html : un tableau HTML simple

  • json : une chaîne de texte au format JSON (JavaScript Object Notation)

  • csv : un fichier de valeurs séparées par des virgules, encodé en UTF-8, avec une ligne d’en-tête et une marque d’ordre des octets (BOM) UTF-8 pour que Microsoft Excel et d’autres outils reconnaissent correctement le fichier

  • xml : une chaîne de texte en langage de balisage extensible. XML est le format recommandé pour importer des données dans Microsoft Excel.

Le point de terminaison livelihoodzonebaseline prend aussi en charge les extractions spatiales au format geojson.

Filtres et pagination

Plusieurs domaines de séries chronologiques contiennent un grand volume de données ; une tentative d’extraction complète en une seule requête peut échouer à cause des délais d’attente du navigateur. Il est recommandé de filtrer la requête pour n’inclure que les données nécessaires, ou d’utiliser la pagination pour limiter la taille de chaque réponse.

Filtres

Les options de filtre sont propres à chaque point de terminaison. Certaines des options de filtre les plus courantes et/ou utiles sont décrites ci-dessous. Pour voir la liste complète des options de votre point de terminaison, consultez notre documentation interactive complète de l’API (en anglais).

  • Géographie

    • country_code : code ISO 3166-1 alpha-2 à deux lettres d’un pays. Les options sont disponibles via https://livelihoods.fews.net/api/country/.
      Exemple : &country_code=KE

    • country : semblable au filtre country_code ci-dessus, mais utilise le nom du pays (en anglais) plutôt que le code ISO. Il est plus simple à utiliser, mais peut être plus lent, surtout pour les extractions volumineuses. Exemple : ?country=Kenya

    • livelihood_zone : code d’une Zone de moyens d’existence, comme ML12. Les options sont disponibles via https://livelihoods.fews.net/api/livelihoodzone/.

  • Moyens d’existence et Lignes de base

    • main_livelihood_category : mode de vie dominant d’une Zone de moyens d’existence, comme pastoral ou urbain. Également appelé système de la zone de moyens d’existence ou système de production. Les options sont disponibles via https://livelihoods.fews.net/api/livelihoodcategory/.

    • wealth_group_category : Catégorie de groupe de richesse, comme Pauvres (P) ou Aisés (B/O). Les options sont disponibles via https://livelihoods.fews.net/api/wealthgroupcategory/.

    • wealth_characteristic : attribut d’un Groupe de richesse, comme le nombre d’enfants d’âge scolaire. Les options sont disponibles via https://livelihoods.fews.net/api/wealthcharacteristic/.

    • strategy_type : type de stratégie de moyens d’existence, comme la production végétale. Les options sont MilkProduction, ButterProduction, MeatProduction, LivestockSale, CropProduction, FoodPurchase, PaymentInKind, ReliefGiftOther, Hunting, Fishing, WildFoodGathering, OtherCashIncome, OtherPurchase.

    • scenario : une Activité de moyens d’existence contient les résultats d’une Stratégie de moyens d’existence mise en œuvre par l’un des groupes suivants :

      • Un Groupe de richesse d’une Communauté pendant l’Année de référence

      • Un Groupe de richesse représentant l’ensemble de la Ligne de base pendant l’Année de référence (scénario baseline)

      • Un Groupe de richesse représentant l’ensemble de la Ligne de base en réponse à un choc (scénario response)

    • as_of_date : utiliser as_of_date avec la date du jour exclut les Lignes de base qui ne sont plus valides. Les dates doivent être au format AAAA-MM-JJ. Exemple : as_of_date=2026-06-12.

  • Produits

    • cpc : la CPC est la Classification centrale de produits des Nations Unies. La CPC est hiérarchique : indiquer L02122AF ne renvoie que les enregistrements correspondants, alors que filtrer sur L02122 renvoie les prix de L02122AA et de L02122AF. Les options sont disponibles via https://livelihoods.fews.net/api/classifiedproduct/
      Exemple : ?cpc=L02122

    • product : nom ou description d’un produit (en anglais). Il est plus simple à utiliser, mais peut être plus lent et moins précis que le filtre cpc.
      Exemple : ?product=maize

  • Calendriers saisonniers

    • season_type : classification d’une période de l’année selon les conditions météorologiques, la température et d’autres facteurs. Les options sont harvest, lean, wet, dry, mild, spring, summer, fall, winter et monsoon.

    • activity_category : types d’activités saisonnières. Les options sont climatology, stress_periods, crop, livestock, fishing, other_income et other.

    • seasonal_activity_type : type d’activité précis, comme le sarclage, la récolte ou les mises bas. Les options sont disponibles via https://livelihoods.fews.net/api/seasonalactivitytype/.

Pagination

Avec les réponses au format JSON, les données peuvent être paginées en ajoutant les paramètres page_size et offset à la requête.

Par exemple, la requête https://livelihoods.fews.net/api/country.json?page_size=10&offset=0 renvoie la réponse suivante :

{
"count": 251,
"next": "https://livelihoods.fews.net/api/country.json?offset=0&page=2&page_size=10",
"previous": null,
"results": [
    <snip>
]
}

Champs

Par défaut, les réponses de l’API contiennent un grand nombre de champs. Pour certains domaines, elles peuvent inclure diverses statistiques supplémentaires, comme la valeur d’il y a un an ou la moyenne sur cinq ans. Le paramètre fields permet de choisir les champs renvoyés par l’API.

Un ensemble réduit de champs courants peut être sélectionné avec &fields=simple.

Vous pouvez aussi indiquer des champs précis dans une liste séparée par des virgules, comme &fields=dataseries,start_date,period_date,value,two_year_average.

Langue

Les champs traduits (p. ex. nom, description) s’affichent si possible dans la langue sélectionnée. Elle se définit avec &language= (p. ex. &language=pt). Les langues disponibles sont les suivantes :

  • ar (arabe)

  • en (anglais, par défaut)

  • es (espagnol)

  • fr (français)

  • pt (portugais)

Tri

Les résultats peuvent être triés selon certains champs. Pour trier selon un champ précis, utilisez &ordering=[field], p. ex. &ordering=livelihood_zone. Le tri est croissant par défaut. Pour un tri décroissant, ajoutez un - devant le nom du champ, p. ex. &ordering=-livelihood_zone.

Aide supplémentaire

Si votre cas d’utilisation n’est pas couvert par notre documentation, contactez le service d’assistance.