API for research

This is a beginner level course on APIs and their use cases in research, covering details about what APIs are what they are used for, how to understand their application, types of APIs, limits and considerations and core topics related to API use.

This course was developed by Somya Iqbal (siqbal5@ed.ac.uk), Alex Crest (s2442997@ed.ac.uk) & Aybuke Atalay (aybuke.atalay@ed.ac.uk).

What to expect at the sessions

• Demonstrations
• Practical exercises
• Talks from tutors
• Q & A

Schedule

Session 1 - Day 1 - 26/11/25

Remit: Understanding fundamentals and demonstration

• [14:00-14:20] - Talk: Introduction to APIs and use cases
• [14:20-14:30]: Q & A - main goals from attendees for API use and domain
• [14:30-14:40] - Talk & brief demo: Web based access for APIs (searchable interface) a short demonstration
• [14:40-15:00] -Talk: Understanding API documentation
• [15:00-15:20] - Talk : Understanding file outputs with JSON/XML structures

10-minute break

• [15:30-15:45] - Talk and demonstration: Understanding API user keys/authentication
• Demonstration (Google APIs)

Final 15 minutes

• Discussion: Q & A
• Next session overview for practical & exercise
• Record attendance & feedback

Session 2 - Day 2 03/12/25

APIs in practice

• [14:00-14:15]: Introduction to session and recap
• [14:15-14:40]: Exercise - working through API documentation
• [14:40-14:50]: Feedback to group on exercise

10-minute break & setup

• [15:00-15-45 +- 5 mins]: Practical with code book (accessing an API)
• [15:45-15:50]: Discussion

Last 10 minutes

• In closing: signpost to resources
• Record attendance & feedback

Setup instructions (support available in session) - Required at session 2

Further information will be provided on the day

1. Noteable

If you are part of the University of Edinburgh you can use Noteable the cloud-based computational notebook system which works on your browser from any device.

Start Noteable (Python-based)

1. Open the following link in a new tab: https://noteable.edina.ac.uk/login
2. Login with your EASE credentials
3. Under 'Standard Python 3 Notebook' click 'Start'

Upload the Notebook (and files) to Noteable (for Python users)

1. From the Noteable home page, click on the 'Git'>'Clone a Repository' button at the top bar of the screen and enter the link of this repo (https://github.com/DCS-training/APIs_For_Research_2025.git)
2. Now click on Clone
3. You now have imported the full repo and you can see all the material
4. Double-click on '01_API_Codebook_GettingStarted.ipynb' to open the Notebook
5. Follow the instruction on the Notebook

Noteable is the recommended mode for University members since your EASE credentials provide easy access to the analysis and avoid further installation of any software or tools locally. For intermeddiate candidates familar with programming, running the notebook locally would allow for a better controlled environment.

Repository structure & layout

This README

Introduction & Overview

• This document details topics covered in talks and can be used as a learning resource

Session slides

• Slides from the course - PDF

Notebooks_&_outputs

This folder also includes a few other folders where we export files and outputs.

• We will use the following notebook during the course practical in session 2

01_ API_Codebook_Getting started (session 2)

This is the codebook we will use in the practical at session 2 (3rd Dec 2025) Tutors will be on hand to guide setup and run through the examples.

Metadata

Where we keep JSON files from initial searches and JSON files with object metadata

Metadata README a descriptive note for this folder

Image_Data

In cases where we are able to extract images, we will store them as outputs here

Image Data README a descriptive note for this folder

Converted_Data

Where we want to convert curated sections of available data into CSV formats, we will store them here

Converted Data README a descriptive note for this folder

License

Copyright

This repository has a license