{"@context": "https://schema.org", "@type": "WebAPI", "name": "Figshare API API", "description": "Figshare apiv2. Using Swagger 2.0", "provider": {"@type": "Organization", "name": "figshare.com"}, "documentation": "http://docs.figshare.com/swagger.json"}
Index / APIs / figshare.com

Figshare API API

Figshare apiv2. Using Swagger 2.0

Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.

Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.

base URLs: https://api.figshare.com/v2

auth: o a u t h 2

find it by capability: POST /search {"query":{"text":"..."}} returns these operations with their invocation detail. Connect any agent client.

Figshare API v2.0.0

Figshare apiv2. Using Swagger 2.0

methodpathwhat the vendor says it does
GET/accountPrivate Account information Account information for token/personal token other
GET/account/articlesPrivate Articles Get Own Articles articles
POST/account/articlesCreate new Article Create a new Article by sending article information articles
GET/account/articles/exportAccount Article Report Return status on all reports generated for the account from the oauth credentials artic
POST/account/articles/exportInitiate a new Report Initiate a new Article Report for this Account. There is a limit of 1 report per day. ar
POST/account/articles/searchPrivate Articles search Returns a list of private articles filtered by the search parameters articles
GET/account/articles/{article_id}Article details View a private article articles
PUT/account/articles/{article_id}Update article Updating an article by passing body parameters; request can also be made with the PATCH method.
DELETE/account/articles/{article_id}Delete article Delete an article articles
GET/account/articles/{article_id}/authorsList article authors List article authors articles
POST/account/articles/{article_id}/authorsAdd article authors Associate new authors with the article. This will add new authors to the list of already a
PUT/account/articles/{article_id}/authorsReplace article authors Associate new authors with the article. This will remove all already associated author
DELETE/account/articles/{article_id}/authors/{author_id}Delete article author De-associate author from article articles
GET/account/articles/{article_id}/categoriesList article categories List article categories articles
POST/account/articles/{article_id}/categoriesAdd article categories Associate new categories with the article. This will add new categories to the list of
PUT/account/articles/{article_id}/categoriesReplace article categories Associate new categories with the article. This will remove all already associated
DELETE/account/articles/{article_id}/categories/{category_id}Delete article category De-associate category from article articles
GET/account/articles/{article_id}/confidentialityArticle confidentiality details View confidentiality settings. The confidentiality feature is now deprecated.
PUT/account/articles/{article_id}/confidentialityUpdate article confidentiality Update confidentiality settings. The confidentiality feature is now deprecated.
DELETE/account/articles/{article_id}/confidentialityDelete article confidentiality Delete confidentiality settings. The confidentiality feature is now deprecated.
GET/account/articles/{article_id}/embargoArticle Embargo Details View a private article embargo details articles
PUT/account/articles/{article_id}/embargoUpdate Article Embargo Note: setting an article under whole embargo does not imply that the article will be pu
DELETE/account/articles/{article_id}/embargoDelete Article Embargo Will lift the embargo for the specified article articles
GET/account/articles/{article_id}/filesList article files List private files articles
POST/account/articles/{article_id}/filesInitiate Upload Initiate a new file upload within the article. Either use the link property to point to an exi
GET/account/articles/{article_id}/files/{file_id}Single File View details of file for specified article articles
POST/account/articles/{article_id}/files/{file_id}Complete Upload Complete file upload articles
DELETE/account/articles/{article_id}/files/{file_id}File Delete Complete file upload articles
GET/account/articles/{article_id}/private_linksList private links List private links articles
POST/account/articles/{article_id}/private_linksCreate private link Create new private link for this article articles
PUT/account/articles/{article_id}/private_links/{link_id}Update private link Update existing private link for this article articles
DELETE/account/articles/{article_id}/private_links/{link_id}Disable private link Disable/delete private link for this article articles
POST/account/articles/{article_id}/publishPrivate Article Publish - If the whole article is under embargo, it will not be published immediately, but whe
POST/account/articles/{article_id}/reserve_doiPrivate Article Reserve DOI Reserve DOI for article articles
POST/account/articles/{article_id}/reserve_handlePrivate Article Reserve Handle Reserve Handle for article articles
POST/account/articles/{article_id}/resourcePrivate Article Resource Edit article resource data. articles
PUT/account/articles/{article_id}/versions/{version_id}/Update article version Updating an article version by passing body parameters; request can also be made with t
PUT/account/articles/{article_id}/versions/{version_id}/update_thumbUpdate article version thumbnail For a given public article version update the article thumbnail by choosing o
POST/account/authors/searchSearch Authors Search for authors authors
GET/account/authors/{author_id}Author details View author details authors

and 96 more operation(s) in this specification, all searchable.

specification origin: http://docs.figshare.com/swagger.json

nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.