Application programming interface (API)s are communication tools between software platforms, in digital humanities research, one of their most pertinent uses is accessing and retrieving data from digital collections with open access (archives, libraries, museums) and linking these entities to ongoing research.
In this course we will cover what APIs are, what they do, how to use them to access and connect data sources. We will also discuss practical considerations such as rate limits, authentication, and the availability of APIs for researchers. Particular attention will be given to understanding API documentation and data structures (e.g. JSON), equipping participants with the skills to interpret documentation and design simple queries. The course will include examples from real-world research applications and provide the key terminology needed to engage with APIs effectively.
This is a beginner-friendly course. No previous knowledge on the topic is required/expected, and the trainer will cover the basics of the method.
- Understanding what an API is and why it is used
- Understanding how APIs are used in research for accessing data or linking data with functionality
- Understanding different types of API more widely and specific for research uses
- Learning to work with API documentation
- Understanding output files like JSON
By attending this course, you will become familiar with the following skills:
- Understanding how to operate authorisation and authentication using API keys
- Sending simple requests to retrieve information from digital collections
- Navigate and make use of API documentation
- Explore digital archive resources using APIs
