Figshare API Resources

You can use the Figshare API to automate record management, gather statistics, or even build custom web apps for users or administrators.

Note: Interested in migrating records in batch? This is certainly possible through the API. However, if you are a repository manager at an institution, the Batch Management Tool may be an easier option for you.

Getting started - the basics

1. How to use the API

• Understanding the API documentation
• API methods
• Chaining API requests
• Stats API endpoints

2. Advice and Guidance

• Formatting JSON inputs and outputs
• Impersonating
• General reporting information

3. Example metadata workflows

• Gather records for one author and output basic record information
• Upload metadata and files and then publish the record
• Batch format and upload metadata from a datasource
• Retrieve metadata for items in review
• A variety of other scripts can be found here and this help page links to Google Colab versions of some of those scripts
• There are many other GitHub repos for Figshare related workflows or integrations

Examples For Statistics Reporting

• Gather records for one author and output basic record information
• Download metadata and stats for a custom repository dashboard

More Advanced Resources - Custom Web Apps and Custom User Interfaces

You can create custom interfaces to display information from your Figshare account or repository. Online tools, like ChatGPT, can help. This was demonstrated in the API workshop Figshare ran at the 2023 Open Repositories Conference. You can see the resources for this demonstration on the workshop page and the workshop slides.