API Guide

Contents:

• Introduction
  • What is an API?
  • Types of Dataverse Software API Users
  • How This Guide is Organized
  • Getting Help
• Getting Started with APIs
  • Servers You Can Test With
  • Getting an API Token
  • curl Examples and Environment Variables
  • Depositing Data
  • Finding and Downloading Data
  • Managing Permissions
  • Getting the OpenAPI Document
  • Beyond “Getting Started” Tasks
  • Getting Help
• API Tokens and Authentication
  • How to Get an API Token
  • How Your API Token Is Like a Password
  • Passing Your API Token as an HTTP Header (Preferred) or a Query Parameter
  • Resetting Your API Token
  • Bearer Tokens
  • Signed URLs
• Search API
  • Parameters
  • Basic Search Example
  • Advanced Search Examples
  • Date Range Search Example
  • Iteration
• Data Access API
  • Downloading All Files in a Dataset
  • Basic File Access
  • Multiple File (“bundle”) download
  • “All Formats” bundled download for Tabular Files.
  • Data Variable Metadata Access
  • Preprocessed Data
  • Authentication and Authorization
  • Access Requests and Processing
• Native API
  • Dataverse Collections
  • Datasets
  • Files
  • Users Token Management
  • Builtin Users
  • Roles
  • Explicit Groups
  • Shibboleth Groups
  • Info
  • Metadata Blocks
  • Dataset Fields
  • Notifications
  • User Information
  • Managing Harvesting Server and Sets
  • Managing Harvesting Clients
  • PIDs
  • Admin
  • MyData
• Metrics API
  • Categories
  • Return Formats
  • Filtering with Query Parameters
  • Endpoint Table
  • Related API Endpoints
• SWORD API
  • About
  • Authentication for SWORD
  • Backward incompatible changes
  • New features as of v1.1
  • curl examples
  • Known issues
  • Bug fixes in v1.1
  • Client libraries
• Client Libraries
  • C/C++
  • Go
  • Java
  • Javascript
  • Julia
  • PHP
  • Python
  • R
  • Ruby
  • Rust
• Building External Tools
  • Introduction
  • Examples of External Tools
  • How External Tools Are Presented to Users
  • Creating an External Tool Manifest
  • Testing Your External Tool
  • Spreading the Word About Your External Tool
• Dataset Curation Label API
  • Get a Draft Dataset’s Curation Label
  • Set a Draft Dataset’s Curation Label
  • Delete a Draft Dataset’s Curation Label
  • Get the Set of Allowed Labels for a Dataset
  • Get a Report on the Curation Status of All Datasets
• Linked Data Notification API
• Apps
  • Javascript
  • Python
  • Java
  • Go
  • PHP
• Frequently Asked Questions
  • What is an API?
  • What Are Common Use Cases for Dataverse Software APIs?
  • Where Can I Find Examples of Using Dataverse Software APIs?
  • When Should I Use the Native API vs. the SWORD API?
  • To Operate on a Dataset Should I Use Its DOI (or Handle) or Its Database ID?
  • Where is the Comprehensive List of All API Functionality?
  • Is There a Changelog of API Functionality That Has Been Added Over Time?
  • What Functionality is GUI Only and Not Available Via API
  • Why Are the Return Values (HTTP Status Codes) Not Documented?
  • What If My Question Is Not Answered Here?
• API Changelog (Breaking Changes)
  • v6.6
  • v6.5
  • v6.4
  • v6.3
  • v6.2
  • v6.1
  • v6.0
  • v5.6