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
- OpenAPI
- Specification ↗
- Spec updated
- 2023-03-06
Make a first request
Replace the placeholders; the documentation says exactly where credentials go.
curl -X GET "https://api.figshare.com/v2/account" \
-H "Accept: application/json" \
-H "Authorization: Bearer YOUR_TOKEN"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);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
| Method | Path | What it does |
|---|---|---|
| GET | /account | Private Account information |
| GET | /account/articles | Private Articles |
| POST | /account/articles | Create new Article |
| GET | /account/articles/export | Account Article Report |
| POST | /account/articles/export | Initiate a new Report |
| POST | /account/articles/search | Private 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}/authors | List article authors |
| POST | /account/articles/{article_id}/authors | Add article authors |
| PUT | /account/articles/{article_id}/authors | Replace article authors |
| DELETE | /account/articles/{article_id}/authors/{author_id} | Delete article author |
| GET | /account/articles/{article_id}/categories | List article categories |
| POST | /account/articles/{article_id}/categories | Add article categories |
| PUT | /account/articles/{article_id}/categories | Replace article categories |
| DELETE | /account/articles/{article_id}/categories/{category_id} | Delete article category |
| GET | /account/articles/{article_id}/confidentiality | Article confidentiality details |
| PUT | /account/articles/{article_id}/confidentiality | Update article confidentiality |
| DELETE | /account/articles/{article_id}/confidentiality | Delete article confidentiality |
| GET | /account/articles/{article_id}/embargo | Article Embargo Details |
| PUT | /account/articles/{article_id}/embargo | Update Article Embargo |
| DELETE | /account/articles/{article_id}/embargo | Delete Article Embargo |
| GET | /account/articles/{article_id}/files | List article files |
| POST | /account/articles/{article_id}/files | Initiate 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_links | List private links |
| POST | /account/articles/{article_id}/private_links | Create 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}/publish | Private Article Publish |
| POST | /account/articles/{article_id}/reserve_doi | Private Article Reserve DOI |
| POST | /account/articles/{article_id}/reserve_handle | Private Article Reserve Handle |
| POST | /account/articles/{article_id}/resource | Private Article Resource |
| PUT | /account/articles/{article_id}/versions/{version_id}/ | Update article version |
| PUT | /account/articles/{article_id}/versions/{version_id}/update_thumb | Update article version thumbnail |
| POST | /account/authors/search | Search Authors |
| GET | /account/authors/{author_id} | Author details |
| GET | /account/categories | Private Account Categories |
| GET | /account/collections | Private Collections List |
| POST | /account/collections | Create collection |
| POST | /account/collections/search | Private 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}/articles | List collection articles |
| POST | /account/collections/{collection_id}/articles | Add collection articles |
| PUT | /account/collections/{collection_id}/articles | Replace collection articles |
| DELETE | /account/collections/{collection_id}/articles/{article_id} | Delete collection article |
| GET | /account/collections/{collection_id}/authors | List collection authors |
| POST | /account/collections/{collection_id}/authors | Add collection authors |
| PUT | /account/collections/{collection_id}/authors | Replace collection authors |
| DELETE | /account/collections/{collection_id}/authors/{author_id} | Delete collection author |
| GET | /account/collections/{collection_id}/categories | List collection categories |
| POST | /account/collections/{collection_id}/categories | Add collection categories |
| PUT | /account/collections/{collection_id}/categories | Replace collection categories |
| DELETE | /account/collections/{collection_id}/categories/{category_id} | Delete collection category |
| GET | /account/collections/{collection_id}/private_links | List collection private links |
| POST | /account/collections/{collection_id}/private_links | Create 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}/publish | Private Collection Publish |
| POST | /account/collections/{collection_id}/reserve_doi | Private Collection Reserve DOI |
| POST | /account/collections/{collection_id}/reserve_handle | Private Collection Reserve Handle |
| POST | /account/collections/{collection_id}/resource | Private Collection Resource |
| POST | /account/funding/search | Search Funding |
| GET | /account/institution | Private Account Institutions |
| GET | /account/institution/accounts | Private Account Institution Accounts |
| POST | /account/institution/accounts | Create new Institution Account |
| POST | /account/institution/accounts/search | Private Account Institution Accounts Search |
| PUT | /account/institution/accounts/{account_id} | Update Institution Account |
| GET | /account/institution/articles | Private Institution Articles |
| GET | /account/institution/custom_fields | Private account institution group custom fields |
| POST | /account/institution/custom_fields/{custom_field_id}/items/upload | Custom fields values files upload |
| GET | /account/institution/embargo_options | Private Account Institution embargo options |
| GET | /account/institution/groups | Private Account Institution Groups |
| GET | /account/institution/groups/{group_id}/embargo_options | Private Account Institution Group Embargo Options |
| GET | /account/institution/review/{curation_id} | Institution Curation Review |
| GET | /account/institution/review/{curation_id}/comments | Institution Curation Review Comments |
| POST | /account/institution/review/{curation_id}/comments | POST Institution Curation Review Comment |
| GET | /account/institution/reviews | Institution Curation Reviews |
| GET | /account/institution/roles | Private 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/licenses | Private Account Licenses |
| GET | /account/projects | Private Projects |
| POST | /account/projects | Create project |
| POST | /account/projects/search | Private 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}/articles | List project articles |
| POST | /account/projects/{project_id}/articles | Create 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}/files | Project 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.
Similar open data APIs
Compare alternatives →Search Services
Open DataAPI for Internet Archive's Search-related services
Wayback API
Open DataAPI for Internet Archive's Wayback Machine
Wikipedia
Open DataMediawiki Encyclopedia
Nasdaq Data Link
Open DataThe source for financial, economic, and alternative datasets, serving investment professionals.
University of Oslo
Open DataCourses, lecture videos, detailed information for courses etc. for the University of Oslo (Norway)
Data API
Open DataServes the Clever Data API
Listed from APIs.guru (CC0).