Skip to content

Figshare API API

by figshare.com

OAuthHTTPSOpen Data
Open documentation ↗

Overview

Figshare apiv2. Using Swagger 2.0

Figshare API is an open data API from figshare.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 136 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Category
Open Data
Base URL
https://api.figshare.com/v2
Version
2.0.0
Endpoints
136
Spec updated
2023-03-06

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://api.figshare.com/v2/account" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://api.figshare.com/v2/account", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://api.figshare.com/v2/account",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/accountPrivate Account information
GET/account/articlesPrivate Articles
POST/account/articlesCreate new Article
GET/account/articles/exportAccount Article Report
POST/account/articles/exportInitiate a new Report
POST/account/articles/searchPrivate Articles search
GET/account/articles/{article_id}Article details
PUT/account/articles/{article_id}Update article
DELETE/account/articles/{article_id}Delete article
GET/account/articles/{article_id}/authorsList article authors
POST/account/articles/{article_id}/authorsAdd article authors
PUT/account/articles/{article_id}/authorsReplace article authors
DELETE/account/articles/{article_id}/authors/{author_id}Delete article author
GET/account/articles/{article_id}/categoriesList article categories
POST/account/articles/{article_id}/categoriesAdd article categories
PUT/account/articles/{article_id}/categoriesReplace article categories
DELETE/account/articles/{article_id}/categories/{category_id}Delete article category
GET/account/articles/{article_id}/confidentialityArticle confidentiality details
PUT/account/articles/{article_id}/confidentialityUpdate article confidentiality
DELETE/account/articles/{article_id}/confidentialityDelete article confidentiality
GET/account/articles/{article_id}/embargoArticle Embargo Details
PUT/account/articles/{article_id}/embargoUpdate Article Embargo
DELETE/account/articles/{article_id}/embargoDelete Article Embargo
GET/account/articles/{article_id}/filesList article files
POST/account/articles/{article_id}/filesInitiate Upload
GET/account/articles/{article_id}/files/{file_id}Single File
POST/account/articles/{article_id}/files/{file_id}Complete Upload
DELETE/account/articles/{article_id}/files/{file_id}File Delete
GET/account/articles/{article_id}/private_linksList private links
POST/account/articles/{article_id}/private_linksCreate private link
PUT/account/articles/{article_id}/private_links/{link_id}Update private link
DELETE/account/articles/{article_id}/private_links/{link_id}Disable private link
POST/account/articles/{article_id}/publishPrivate Article Publish
POST/account/articles/{article_id}/reserve_doiPrivate Article Reserve DOI
POST/account/articles/{article_id}/reserve_handlePrivate Article Reserve Handle
POST/account/articles/{article_id}/resourcePrivate Article Resource
PUT/account/articles/{article_id}/versions/{version_id}/Update article version
PUT/account/articles/{article_id}/versions/{version_id}/update_thumbUpdate article version thumbnail
POST/account/authors/searchSearch Authors
GET/account/authors/{author_id}Author details
GET/account/categoriesPrivate Account Categories
GET/account/collectionsPrivate Collections List
POST/account/collectionsCreate collection
POST/account/collections/searchPrivate Collections Search
GET/account/collections/{collection_id}Collection details
PUT/account/collections/{collection_id}Update collection
DELETE/account/collections/{collection_id}Delete collection
GET/account/collections/{collection_id}/articlesList collection articles
POST/account/collections/{collection_id}/articlesAdd collection articles
PUT/account/collections/{collection_id}/articlesReplace collection articles
DELETE/account/collections/{collection_id}/articles/{article_id}Delete collection article
GET/account/collections/{collection_id}/authorsList collection authors
POST/account/collections/{collection_id}/authorsAdd collection authors
PUT/account/collections/{collection_id}/authorsReplace collection authors
DELETE/account/collections/{collection_id}/authors/{author_id}Delete collection author
GET/account/collections/{collection_id}/categoriesList collection categories
POST/account/collections/{collection_id}/categoriesAdd collection categories
PUT/account/collections/{collection_id}/categoriesReplace collection categories
DELETE/account/collections/{collection_id}/categories/{category_id}Delete collection category
GET/account/collections/{collection_id}/private_linksList collection private links
POST/account/collections/{collection_id}/private_linksCreate collection private link
PUT/account/collections/{collection_id}/private_links/{link_id}Update collection private link
DELETE/account/collections/{collection_id}/private_links/{link_id}Disable private link
POST/account/collections/{collection_id}/publishPrivate Collection Publish
POST/account/collections/{collection_id}/reserve_doiPrivate Collection Reserve DOI
POST/account/collections/{collection_id}/reserve_handlePrivate Collection Reserve Handle
POST/account/collections/{collection_id}/resourcePrivate Collection Resource
POST/account/funding/searchSearch Funding
GET/account/institutionPrivate Account Institutions
GET/account/institution/accountsPrivate Account Institution Accounts
POST/account/institution/accountsCreate new Institution Account
POST/account/institution/accounts/searchPrivate Account Institution Accounts Search
PUT/account/institution/accounts/{account_id}Update Institution Account
GET/account/institution/articlesPrivate Institution Articles
GET/account/institution/custom_fieldsPrivate account institution group custom fields
POST/account/institution/custom_fields/{custom_field_id}/items/uploadCustom fields values files upload
GET/account/institution/embargo_optionsPrivate Account Institution embargo options
GET/account/institution/groupsPrivate Account Institution Groups
GET/account/institution/groups/{group_id}/embargo_optionsPrivate Account Institution Group Embargo Options
GET/account/institution/review/{curation_id}Institution Curation Review
GET/account/institution/review/{curation_id}/commentsInstitution Curation Review Comments
POST/account/institution/review/{curation_id}/commentsPOST Institution Curation Review Comment
GET/account/institution/reviewsInstitution Curation Reviews
GET/account/institution/rolesPrivate Account Institution Roles
GET/account/institution/roles/{account_id}List Institution Account Group Roles
POST/account/institution/roles/{account_id}Add Institution Account Group Roles
DELETE/account/institution/roles/{account_id}/{group_id}/{role_id}Delete Institution Account Group Role
GET/account/institution/users/{account_id}Private Account Institution User
GET/account/licensesPrivate Account Licenses
GET/account/projectsPrivate Projects
POST/account/projectsCreate project
POST/account/projects/searchPrivate Projects search
GET/account/projects/{project_id}View project details
PUT/account/projects/{project_id}Update project
DELETE/account/projects/{project_id}Delete project
GET/account/projects/{project_id}/articlesList project articles
POST/account/projects/{project_id}/articlesCreate project article
GET/account/projects/{project_id}/articles/{article_id}Project article details
DELETE/account/projects/{project_id}/articles/{article_id}Delete project article
GET/account/projects/{project_id}/articles/{article_id}/filesProject article list files

Showing the first 100 of 136 endpoints; the full list is in the documentation.

Questions

Does the Figshare API API need an API key?

Yes. The Figshare API API uses OAuth authentication; the documentation explains how to get credentials.

Does the Figshare API API support HTTPS?

Yes, the Figshare API API is served over HTTPS.

How many endpoints does the Figshare API API have?

Its OpenAPI description lists 136 endpoints in version 2.0.0. The first 100 are shown on this page.

What are alternatives to the Figshare API API?

Other Open Data APIs include Search Services, Wayback API, Wikipedia, Nasdaq Data Link, University of Oslo.

Compare alternatives →

Listed from APIs.guru (CC0).