University of British Columbia

UBC Library Abacus Dataverse API

The REST API of Abacus, UBC Library's research-data repository, running Dataverse 5.9 on UBC's own infrastructure at abacus.library.ubc.ca. UBC operates the deployment and the data is UBC's and its BC consortium partners'; the contract itself is Dataverse software's, served by the product at /openapi, and every schema, ruleset and vocabulary in this repo derived from it inherits that. Verified live 2026-08-19 at /api/info/version. This ONE surface was previously recorded as twenty-two separate APIs because the refine step splits a contract by tag — the twenty-two OpenAPI documents are kept as properties here, but they describe one API, not twenty-two.

GitHub OpenAPI

Operations 22

GET /api/v1/access/datafile/bundle/{fileId} Datafile bundle #
GET /api/v1/access/datafile/{fileId:.+} Datafile #
GET /api/v1/access/datafile/{fileId}/auxiliary List datafile metadata aux #
GET /api/v1/access/datafile/{fileId}/auxiliary/{formatTag}/{formatVersion} Download auxiliary file #
POST /api/v1/access/datafile/{fileId}/auxiliary/{formatTag}/{formatVersion} Save auxiliary file with version #
DELETE /api/v1/access/datafile/{fileId}/auxiliary/{formatTag}/{formatVersion} Delete auxiliary file with version #
GET /api/v1/access/datafile/{fileId}/auxiliary/{origin} List datafile metadata aux by origin #
GET /api/v1/access/datafile/{fileId}/metadata Tabular datafile metadata #
GET /api/v1/access/datafile/{fileId}/metadata/ddi Tabular datafile metadata DDI #
PUT /api/v1/access/datafile/{id}/grantAccess/{identifier} Grant file access #
GET /api/v1/access/datafile/{id}/listRequests List file access requests #
PUT /api/v1/access/datafile/{id}/rejectAccess/{identifier} Reject file access #
PUT /api/v1/access/datafile/{id}/requestAccess Request file access #
DELETE /api/v1/access/datafile/{id}/revokeAccess/{identifier} Revoke file access #
POST /api/v1/access/datafiles Post download datafiles #
GET /api/v1/access/datafiles/{fileIds} Datafiles #
GET /api/v1/access/dataset/{id} Download all from latest #
GET /api/v1/access/dataset/{id}/versions/{versionId} Download all from version #
GET /api/v1/access/dsCardImage/{versionId} Ds card image #
GET /api/v1/access/dvCardImage/{dataverseId} Dv card image #
GET /api/v1/access/fileCardImage/{fileId} File card image #
PUT /api/v1/access/{id}/allowAccessRequest Allow access request #

Documentation

📖
Documentation
https://abacus.library.ubc.ca/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/authentication/ubc-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/openapi/ubc-access-api-openapi.yml
⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/openapi/ubc-admin-api-openapi.yml
⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/openapi/ubc-batch-api-openapi.yml
⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/openapi/ubc-builtin-users-api-openapi.yml
⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/openapi/ubc-datasets-api-openapi.yml
⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/openapi/ubc-datatags-api-openapi.yml
⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/openapi/ubc-dataverses-api-openapi.yml
⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/openapi/ubc-edit-api-openapi.yml
⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/openapi/ubc-files-api-openapi.yml
⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/openapi/ubc-harvest-api-openapi.yml
⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/openapi/ubc-info-api-openapi.yml
⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/openapi/ubc-ingest-api-openapi.yml
⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/openapi/ubc-mail-api-openapi.yml
⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/openapi/ubc-meta-api-openapi.yml
⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/openapi/ubc-metadatablocks-api-openapi.yml
⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/openapi/ubc-mydata-api-openapi.yml
⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/openapi/ubc-notifications-api-openapi.yml
⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/openapi/ubc-pids-api-openapi.yml
⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/openapi/ubc-roles-api-openapi.yml
⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/openapi/ubc-search-api-openapi.yml
⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/openapi/ubc-users-api-openapi.yml
⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/openapi/ubc-workflows-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/json-schema/ubc-dataset-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/json-schema/ubc-datafile-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/json-schema/ubc-dataverse-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/json-structure/ubc-dataset-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/json-structure/ubc-dataverse-structure.json

Other Resources

🔗
OpenData
https://abacus.library.ubc.ca/dataverse/ubc_open
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/examples/ubc-search-datasets-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/examples/ubc-get-dataverse-example.json
🔗
Rules
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/rules/ubc-rules.yml
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/vocabulary/ubc-vocabulary.yml
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/json-ld/ubc-context.jsonld
🔗
Scopes
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/scopes/ubc-scopes.yml
🔗
Errors
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/errors/ubc-errors.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/lifecycle/ubc-lifecycle.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/abacus-dataverse"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

ubc-access-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: UBC Abacus Dataverse Access API
  description: OpenAPI 3.0 description of the Dataverse REST API exposed by UBC Library's Abacus research-data repository (Dataverse 5.9). Spec retrieved live from https://abacus.library.ubc.ca/openapi. Native Dataverse Search and Data Access APIs are available for read; write operations require an API token.
  version: '5.9'
servers:
- url: https://abacus.library.ubc.ca
  description: UBC Abacus Dataverse production server.
tags:


# --- truncated at 32 KB (102 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ubc/refs/heads/main/openapi/ubc-access-api-openapi.yml