IFRC GO API Tutorial

Interactive Python notebooks demonstrating how to use the IFRC GO API.

🚀 Quick Start with Binder

Click the badge above to launch the notebooks in your browser - no installation required!

Note: You'll need an IFRC GO API token. Learn how to generate one

📓 Notebooks

Notebook	Description
notebook_1.ipynb	Projects analysis by sector (Nepal)
notebook_2.ipynb	Events analysis by country
notebook_3.ipynb	Appeal documents fetcher
notebook_4.ipynb	Project status distribution
notebook_5.ipynb	Surge alerts analysis
notebook_6.ipynb	Deaths by event type and country

🔧 Local Setup

1. Clone the repository:

   git clone https://github.com/IFRCGo/GO_API_TUT.git
   cd GO_API_TUT

2. Create a virtual environment and install dependencies:

   python -m venv .venv
   source .venv/bin/activate  # On Windows: .venv\Scripts\activate
   pip install -r requirements.txt

3. Create a .env file with your API token:

   cp .env.example .env
   # Edit .env and add your token

4. Launch Jupyter:

   jupyter notebook notebooks/

🔑 API Token Setup

To use these notebooks, you need an IFRC GO API token.

Follow the official guide to generate your token:
👉 Generating an API Token - GO Wiki

Once you have your token, add it to your .env file:

IFRC_API_TOKEN=your_token_here

📁 Project Structure

GO_API_TUT/
├── notebooks/           # Jupyter notebooks
│   ├── notebook_1.ipynb
│   ├── notebook_2.ipynb
│   └── ...
├── .env.example         # Template for environment variables
├── requirements.txt     # Python dependencies
├── runtime.txt          # Python version for Binder
└── postBuild            # Binder setup script

License

MIT License