dataverse-sync

Harvard Dataverse API Sync

Overview

Sync local files with a Harvard Dataverse dataset using the Native API.

Key API Endpoints

Action	Endpoint	Method
Get dataset metadata	/api/datasets/:persistentId/?persistentId={DOI}	GET
Add file	/api/datasets/:persistentId/add?persistentId={DOI}	POST
Replace file	/api/files/{file_id}/replace	POST
Delete file	/api/files/{file_id}	DELETE

Authentication

All requests require the X-Dataverse-key header with your API token:

headers = {"X-Dataverse-key": "your-api-token"}

Common Operations

Get Dataset Files

import requests

url = "https://dataverse.harvard.edu/api/datasets/:persistentId/"
params = {"persistentId": "doi:10.7910/DVN/XXXXXX"}
headers = {"X-Dataverse-key": API_TOKEN}

response = requests.get(url, params=params, headers=headers)
data = response.json()
files = data["data"]["latestVersion"]["files"]

for f in files:
    file_id = f["dataFile"]["id"]
    md5 = f["dataFile"].get("md5", "")
    filename = f.get("label", f["dataFile"].get("filename"))
    directory = f.get("directoryLabel", "")

Add File

import json

url = "https://dataverse.harvard.edu/api/datasets/:persistentId/add"
params = {"persistentId": DOI}
headers = {"X-Dataverse-key": API_TOKEN}

json_data = json.dumps({
    "directoryLabel": "path/to/directory",  # Optional
    "categories": [],
})

with open(filepath, "rb") as f:
    files = {
        "file": (filename, f),
        "jsonData": (None, json_data, "application/json"),
    }
    response = requests.post(url, params=params, headers=headers, files=files)

Delete File

url = f"https://dataverse.harvard.edu/api/files/{file_id}"
headers = {"X-Dataverse-key": API_TOKEN}
response = requests.delete(url, headers=headers)

Compare Files Using MD5

import hashlib

def compute_md5(filepath):
    md5_hash = hashlib.md5()
    with open(filepath, "rb") as f:
        for chunk in iter(lambda: f.read(8192), b""):
            md5_hash.update(chunk)
    return md5_hash.hexdigest()