# /figshare/articles

`POST /api/figshare/articles`

Price: 5 credits

Get one Figshare research output by id, page address or DOI. Returns the title, the full description, every named author with ORCID, the item type, the licence, subject categories, tags, references, funding awards, related publications, institution-defined metadata fields, the version number and the deposited files with their size, checksum and a direct download link.

## How to use it

Accepts the numeric article id, a figshare.com page address, a Figshare DOI and also a publisher DOI — an institutional deposit carries the journal's own DOI rather than a 10.6084 one, so do not try to derive the id from the DOI string. A DOI costs one extra lookup, an id does not. `item_type` names what the record is (dataset, figure, software, thesis, journal contribution and so on); a `journal contribution` is usually the supplementary material of a paper, and `source_doi` then points at the paper itself. Read `files[].download_url` for the actual data — Figshare is one of the few repositories that hands out a direct, unauthenticated download link. An empty `files` list with `is_metadata_record` true means the record describes data held elsewhere. `custom_fields` is defined by the depositing institution, so its names differ between records.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `article` (string, required) — Figshare article id, the address of its Figshare page, or its DOI (examples: "33620353", "https://figshare.com/articles/dataset/Wind_speed_data/32974826", "10.6084/m9.figshare.32974826", "10.1186/1471-2288-13-46"; minLength: 1)

## Response

### 200 — Successful Response

- `@type` (string) (default: "FigshareArticleDetail")
- `id` (string, required)
- `url` (string, required)
- `doi` (string, nullable)
- `handle` (string, nullable)
- `description` (string, nullable)
- `citation` (string, nullable)
- `item_type` (string, nullable)
- `item_type_id` (string, nullable)
- `status` (string, nullable)
- `version` (string, nullable)
- `size` (integer, nullable)
- `created_at` (string, nullable)
- `modified_at` (string, nullable)
- `published_at` (string, nullable)
- `timeline` (object, nullable)
  - `@type` (string) (default: "FigshareTimeline")
  - `posted_at` (string, nullable)
  - `submitted_at` (string, nullable)
  - `revised_at` (string, nullable)
  - `first_online_date` (string, nullable)
  - `publisher_publication_date` (string, nullable)
  - `publisher_acceptance_date` (string, nullable)
- `thumbnail` (string, nullable)
- `group_id` (string, nullable)
- `source_doi` (string, nullable)
- `source_title` (string, nullable)
- `license` (object, nullable)
  - `@type` (string) (default: "FigshareLicense")
  - `id` (string, nullable)
  - `name` (string, nullable)
  - `url` (string, nullable)
- `authors` (array) (default: [])
  - `@type` (string) (default: "FigshareAuthor")
  - `id` (string, nullable)
  - `full_name` (string, required)
  - `first_name` (string, nullable)
  - `last_name` (string, nullable)
  - `orcid` (string, nullable)
  - `alias` (string, nullable)
  - `is_active` (boolean, nullable)
- `categories` (array) (default: [])
  - `@type` (string) (default: "FigshareCategory")
  - `id` (string, required)
  - `parent_category_id` (string, nullable)
  - `taxonomy_id` (string, nullable)
  - `path` (string, nullable)
  - `source_id` (string, nullable)
- `tags` (array) (default: [])
- `references` (array) (default: [])
- `files` (array) (default: [])
  - `@type` (string) (default: "FigshareFile")
  - `id` (string, required)
  - `name` (string, nullable)
  - `size` (integer, nullable)
  - `mime_type` (string, nullable)
  - `download_url` (string, nullable)
  - `supplied_md5` (string, nullable)
  - `computed_md5` (string, nullable)
  - `is_link_only` (boolean, nullable)
  - `folder` (string, nullable)
- `funding` (array) (default: [])
  - `@type` (string) (default: "FigshareFunding")
  - `id` (string, nullable)
  - `grant_code` (string, nullable)
  - `funder_name` (string, nullable)
  - `url` (string, nullable)
  - `is_user_defined` (boolean, nullable)
- `related_materials` (array) (default: [])
  - `@type` (string) (default: "FigshareRelatedMaterial")
  - `id` (string, nullable)
  - `identifier` (string, nullable)
  - `identifier_type` (string, nullable)
  - `relation` (string, nullable)
  - `link_url` (string, nullable)
  - `is_linkout` (boolean, nullable)
- `custom_fields` (array) (default: [])
  - `@type` (string) (default: "FigshareCustomField")
  - `name` (string, required)
  - `values` (array) (default: [])
  - `field_type` (string, nullable)
  - `is_mandatory` (boolean, nullable)
- `embargo` (object, nullable)
  - `@type` (string) (default: "FigshareEmbargo")
  - `until_date` (string, nullable)
  - `type` (string, nullable)
  - `reason` (string, nullable)
- `is_public` (boolean, nullable)
- `is_embargoed` (boolean, nullable)
- `is_confidential` (boolean, nullable)
- `is_metadata_record` (boolean, nullable)
- `has_linked_file` (boolean, nullable)
- `is_download_disabled` (boolean, nullable)
- `confidential_reason` (string, nullable)
- `metadata_reason` (string, nullable)

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.

### 412

No Figshare article carries this id or DOI

What to do: Retrying will not help: either the entity does not exist, or the input points at a different one.

### 429

Too many requests: a rate limit or a usage window is exhausted

What to do: When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.

### 500

Something broke on our side

What to do: Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.

### 529

Rate limit reached, or the endpoint is overloaded

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these headers:

- `X-Error` — Error message text (present only on error)
- `X-Request-ID` — Unique request identifier
- `X-Execution-Time` — Execution time in seconds
- `X-Result-Count` — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
- `X-Total-Available-Results` — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
- `X-Warning` — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
- `X-Retry-After` — Seconds to wait before retrying. Present only on 429.