Summary

The HDX Python API Library is designed to enable you to easily develop code that interacts with the Humanitarian Data Exchange (HDX) platform. The major goal of the library is to make pushing and pulling data from HDX as simple as possible for the end user. If you have humanitarian-related data, please upload your datasets to HDX.

Contents

Tutorials

• A Quick Example

How-to Guides

• Set up
  • Obtain your API Key
  • Install the Library
  • Build a Docker image
  • Build a project Framework
• Configure
  • Use Facades
  • Customise the Configuration
  • Configure Logging
• Work with HDX objects
  • Use HDX Objects
  • Datasets
    • Set Dataset Time Period
    • Set Expected Update Frequency
    • Set Location
    • Set Tags
    • Set Maintainer
    • Set Organization
    • Set Custom Visualization
    • Manage Dataset Resources
    • Generate Resources
  • Resources
    • Operate on Resources
    • Manage the Data Dictionary
    • Use the Datastore
  • Manage Showcases
  • Manage Organizations
  • Manage Users
  • Manage Locations
  • Manage Vocabularies
• Other tools
  • Use Activity Streams
  • Get HDX Statistics
  • Manage Pipeline State
• Examples
  • Working Examples
  • IDMC Example

Reference

• API Documentation (see the menu at the top)
• Breaking Changes

Explanation

• Information
• Default Configuration for Facades
• Brief History