> ## Documentation Index
> Fetch the complete documentation index at: https://hexagraph-docs.voyla.in/llms.txt
> Use this file to discover all available pages before exploring further.

# Output

> Retrieve detailed metadata for a single scholarly output by its HX_W identifier.

Retrieves complete metadata for a single scholarly output (research paper, journal article, preprint, book, dataset, or dissertation) by its unique Hexagraph `HX_W` identifier.

### Path Parameters

<ParamField path="id" type="string" required>
  Unique Hexagraph identifier for the scholarly output (e.g. `HX_W3038568908`).
</ParamField>

### Response Fields

<ResponseField name="id" type="string" required>
  Unique output identifier prefixed with `HX_W`.
</ResponseField>

<ResponseField name="doi" type="string">
  Digital Object Identifier URL for this work.
</ResponseField>

<ResponseField name="title" type="string">
  Title of the scholarly work.
</ResponseField>

<ResponseField name="name" type="string">
  Display name of the scholarly work.
</ResponseField>

<ResponseField name="year" type="integer">
  Four-digit publication year.
</ResponseField>

<ResponseField name="date" type="string">
  ISO publication date string (YYYY-MM-DD).
</ResponseField>

<ResponseField name="ids" type="object">
  External identifiers system mapping.

  <Expandable title="ids attributes">
    <ResponseField name="mag" type="string">Microsoft Academic Graph ID.</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="language" type="object">
  Language metadata object.

  <Expandable title="language attributes">
    <ResponseField name="code" type="string">ISO 639-1 language code (e.g. `"en"`).</ResponseField>
    <ResponseField name="name" type="string">Language name string (e.g. `"English"`).</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="primary_venue" type="object">
  Primary publishing venue details and metrics.

  <Expandable title="primary_venue attributes">
    <ResponseField name="id" type="string">Venue DOI or ID identifier.</ResponseField>
    <ResponseField name="is_oa" type="boolean">`true` if primary venue is Open Access.</ResponseField>
    <ResponseField name="landing_page_url" type="string">Landing page URL.</ResponseField>
    <ResponseField name="pdf_url" type="string">Direct PDF URL.</ResponseField>
    <ResponseField name="license" type="string">License type.</ResponseField>
    <ResponseField name="version" type="string">Publication version.</ResponseField>
    <ResponseField name="is_accepted" type="boolean">`true` if article was accepted.</ResponseField>
    <ResponseField name="is_published" type="boolean">`true` if article is published.</ResponseField>

    <ResponseField name="source" type="object">
      Source details object.

      <Expandable title="source attributes">
        <ResponseField name="id" type="string">Source ID (`HX_S...`).</ResponseField>
        <ResponseField name="name" type="string">Source display name.</ResponseField>
        <ResponseField name="type" type="string">Source type (`journal`, `repository`).</ResponseField>

        <ResponseField name="metrics" type="object">
          Source index metrics (Scopus, Web of Science, ABDC).

          <Expandable title="metrics attributes">
            <ResponseField name="scopus" type="object">Scopus metrics (`{ snip, sjr, citescore, quartile }`).</ResponseField>
            <ResponseField name="web_of_science" type="object">Web of Science metrics (`{ jif, five_year_jif, quartile, indexes }`).</ResponseField>
            <ResponseField name="abdc" type="object">ABDC rating (`{ rating }`).</ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="additional_venues" type="array">
  List of additional repository or secondary venue objects.

  <Expandable title="additional_venues attributes">
    <ResponseField name="id" type="string">Venue repository ID.</ResponseField>
    <ResponseField name="is_oa" type="boolean">`true` if repository location is Open Access.</ResponseField>
    <ResponseField name="landing_page_url" type="string">Repository landing page URL.</ResponseField>
    <ResponseField name="pdf_url" type="string">Repository PDF URL.</ResponseField>
    <ResponseField name="license" type="string">Repository license.</ResponseField>
    <ResponseField name="version" type="string">Version type.</ResponseField>
    <ResponseField name="is_accepted" type="boolean">Accepted status.</ResponseField>
    <ResponseField name="is_published" type="boolean">Published status.</ResponseField>

    <ResponseField name="source" type="object">
      Repository source metadata.

      <Expandable title="source attributes">
        <ResponseField name="id" type="string">Source ID (`HX_S...`).</ResponseField>
        <ResponseField name="name" type="string">Source display name.</ResponseField>
        <ResponseField name="type" type="string">Source type (`journal`, `repository`).</ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="venues_count" type="integer">
  Total number of locations/venues associated with this work.
</ResponseField>

<ResponseField name="type" type="string">
  Output classification (`article`, `preprint`, etc.).
</ResponseField>

<ResponseField name="indexed_in" type="array">
  List of index providers (e.g. `["crossref"]`).
</ResponseField>

<ResponseField name="open_access" type="object">
  Open access indicators.

  <Expandable title="open_access attributes">
    <ResponseField name="is_oa" type="boolean">`true` if Open Access.</ResponseField>
    <ResponseField name="oa_status" type="string">OA status (`diamond`, `gold`, `hybrid`, etc.).</ResponseField>
    <ResponseField name="oa_url" type="string">Direct URL to Open Access publication.</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="authors" type="array">
  List of author objects.

  <Expandable title="authors attributes">
    <ResponseField name="author_position" type="string">Position (`first`, `middle`, `last`).</ResponseField>
    <ResponseField name="id" type="string">Author ID (`HX_A...`).</ResponseField>
    <ResponseField name="name" type="string">Author display name.</ResponseField>
    <ResponseField name="orcid" type="string">Author ORCID URL.</ResponseField>
    <ResponseField name="affiliations" type="array">Affiliated institutions array (`{ id, name }`).</ResponseField>
    <ResponseField name="countries" type="array">Affiliated countries array (`{ code, name }`).</ResponseField>
    <ResponseField name="is_corresponding" type="boolean">`true` if author is corresponding author.</ResponseField>
    <ResponseField name="raw_affiliation_strings" type="array">Unparsed raw affiliation strings.</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="fwci" type="number">
  Field-Weighted Citation Impact.
</ResponseField>

<ResponseField name="has_fulltext" type="boolean">
  `true` if full text document is available.
</ResponseField>

<ResponseField name="cited_by_count" type="integer">
  Total number of citations received by this work.
</ResponseField>

<ResponseField name="cites" type="integer">
  Total number of references cited by this work.
</ResponseField>

<ResponseField name="citation_normalized_percentile" type="object">
  Normalized percentile citation metrics.

  <Expandable title="citation_normalized_percentile attributes">
    <ResponseField name="value" type="number">Normalized citation value score.</ResponseField>
    <ResponseField name="is_in_top_1_percent" type="boolean">`true` if in top 1% percentile.</ResponseField>
    <ResponseField name="is_in_top_10_percent" type="boolean">`true` if in top 10% percentile.</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="cited_by_percentile_year" type="object">
  Yearly citation percentile bounds.

  <Expandable title="cited_by_percentile_year attributes">
    <ResponseField name="min" type="integer">Minimum percentile ranking.</ResponseField>
    <ResponseField name="max" type="integer">Maximum percentile ranking.</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="biblio" type="object">
  Bibliographic info.

  <Expandable title="biblio attributes">
    <ResponseField name="volume" type="string">Volume number.</ResponseField>
    <ResponseField name="issue" type="string">Issue number.</ResponseField>
    <ResponseField name="first_page" type="string">First page number.</ResponseField>
    <ResponseField name="last_page" type="string">Last page number.</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="is_retracted" type="boolean">
  `true` if work was retracted.
</ResponseField>

<ResponseField name="is_paratext" type="boolean">
  `true` if item is paratext content.
</ResponseField>

<ResponseField name="apc_paid" type="object">
  Article processing charges payment info.
</ResponseField>

<ResponseField name="primary_topic" type="object">
  Primary research topic object.

  <Expandable title="primary_topic attributes">
    <ResponseField name="id" type="string">Topic ID (`HX_T...`).</ResponseField>
    <ResponseField name="name" type="string">Topic display name.</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="topics" type="array">
  Associated topics list.

  <Expandable title="topics attributes">
    <ResponseField name="id" type="string">Topic ID (`HX_T...`).</ResponseField>
    <ResponseField name="name" type="string">Topic display name.</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="sustainable_development_goals" type="array">
  List of UN Sustainable Development Goals matched to this output.

  <Expandable title="sustainable_development_goals attributes">
    <ResponseField name="id" type="integer">SDG numerical ID.</ResponseField>
    <ResponseField name="name" type="string">SDG display name.</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="funders" type="array">
  List of funding organization objects.

  <Expandable title="funders attributes">
    <ResponseField name="id" type="string">Funder ID (`HX_F...`).</ResponseField>
    <ResponseField name="name" type="string">Funder display name.</ResponseField>

    <ResponseField name="awards" type="array">
      Grants and awards array.

      <Expandable title="awards attributes">
        <ResponseField name="id" type="string">Award ID (`HX_G...`).</ResponseField>
        <ResponseField name="name" type="string">Grant/Award project title.</ResponseField>
        <ResponseField name="funder_award_id" type="string">Funder's official award reference code.</ResponseField>
        <ResponseField name="doi" type="string">Grant DOI URL.</ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="counts_by_year" type="array">
  Yearly breakdown of citation counts.

  <Expandable title="counts_by_year attributes">
    <ResponseField name="year" type="integer">Year number.</ResponseField>
    <ResponseField name="cited_by_count" type="integer">Citations received in that year.</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="keywords" type="array">
  List of key concept tags.
</ResponseField>

<ResponseField name="abstract" type="string">
  Abstract / summary of the paper.
</ResponseField>

<ResponseField name="updated_date" type="string">
  ISO last updated timestamp.
</ResponseField>

<ResponseField name="created_date" type="string">
  ISO creation date timestamp.
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET "https://api.hexagraph.in/outputs/HX_W3038568908"
  ```

  ```javascript JavaScript theme={null}
  fetch("https://api.hexagraph.in/outputs/HX_W3038568908")
    .then(response => response.json())
    .then(data => console.log(data));
  ```

  ```python Python theme={null}
  import requests

  response = requests.get("https://api.hexagraph.in/outputs/HX_W3038568908")
  print(response.json())
  ```

  ```go Go theme={null}
  package main

  import (
  	"fmt"
  	"io"
  	"net/http"
  )

  func main() {
  	resp, err := http.Get("https://api.hexagraph.in/outputs/HX_W3038568908")
  	if err != nil {
  		fmt.Println("Error:", err)
  		return
  	}
  	defer resp.Body.Close()
  	body, _ := io.ReadAll(resp.Body)
  	fmt.Println(string(body))
  }
  ```
</RequestExample>

<ResponseExample>
  ```json 200 OK theme={null}
  {
    "id": "HX_W3038568908",
    "doi": "https://doi.org/10.1585/pfr.15.2402039",
    "title": "Radiation Resistant Camera System for Monitoring Deuterium Plasma Discharges in the Large Helical Device",
    "name": "Radiation Resistant Camera System for Monitoring Deuterium Plasma Discharges in the Large Helical Device",
    "year": 2020,
    "date": "2020-06-08",
    "ids": {
      "mag": "3038568908"
    },
    "language": {
      "code": "en",
      "name": "English"
    },
    "primary_venue": {
      "id": "doi:10.1585/pfr.15.2402039",
      "is_oa": true,
      "landing_page_url": "https://doi.org/10.1585/pfr.15.2402039",
      "pdf_url": "https://www.jstage.jst.go.jp/article/pfr/15/0/15_2402039/_pdf",
      "license": null,
      "version": "publishedVersion",
      "is_accepted": true,
      "is_published": true,
      "source": {
        "id": "HX_S46033839",
        "name": "Plasma and Fusion Research",
        "type": "journal",
        "metrics": {
          "scopus": {
            "snip": 0.438,
            "sjr": 0.31,
            "citescore": 1.2,
            "quartile": "Q4"
          },
          "web_of_science": {
            "jif": 0.5,
            "five_year_jif": 0.7,
            "quartile": "Q4",
            "indexes": [
              {
                "code": "ESCI",
                "name": "ESCI"
              }
            ]
          },
          "abdc": null
        }
      }
    },
    "additional_venues": [
      {
        "id": "pmh:oai:irdb.nii.ac.jp:01130:0005371079",
        "is_oa": true,
        "landing_page_url": "https://nifs-repository.repo.nii.ac.jp/records/11278",
        "pdf_url": null,
        "license": "cc-by-nc-nd",
        "version": "submittedVersion",
        "is_accepted": false,
        "is_published": false,
        "source": {
          "id": "HX_S7407056385",
          "name": "Institutional Repositories DataBase (IRDB)",
          "type": "repository"
        }
      },
      {
        "id": "pmh:oai:nifs-repository.repo.nii.ac.jp:00011278",
        "is_oa": false,
        "landing_page_url": null,
        "pdf_url": null,
        "license": null,
        "version": "submittedVersion",
        "is_accepted": false,
        "is_published": false,
        "source": {
          "id": "HX_S4306401138",
          "name": "National Institute for Fusion Science Repository (National Institute for Fusion Science)",
          "type": "repository"
        }
      }
    ],
    "venues_count": 3,
    "type": "article",
    "indexed_in": [
      "crossref"
    ],
    "open_access": {
      "is_oa": true,
      "oa_status": "diamond",
      "oa_url": "https://www.jstage.jst.go.jp/article/pfr/15/0/15_2402039/_pdf"
    },
    "authors": [
      {
        "author_position": "first",
        "id": "HX_A5039600762",
        "name": "M. Shoji",
        "orcid": "https://orcid.org/0000-0003-0655-7347",
        "affiliations": [
          {
            "id": "HX_I199525922",
            "name": "National Institutes of Natural Sciences"
          },
          {
            "id": "HX_I4210108322",
            "name": "National Institute for Fusion Science"
          }
        ],
        "countries": [
          {
            "code": "JP",
            "name": "Japan"
          }
        ],
        "is_corresponding": true,
        "raw_affiliation_strings": [
          "National Institute for Fusion Science, National Institutes of Natural Sciences"
        ]
      },
      {
        "author_position": "last",
        "id": null,
        "name": "LHD Experiment Group",
        "orcid": null,
        "affiliations": [
          {
            "id": "HX_I199525922",
            "name": "National Institutes of Natural Sciences"
          },
          {
            "id": "HX_I4210108322",
            "name": "National Institute for Fusion Science"
          }
        ],
        "countries": [
          {
            "code": "JP",
            "name": "Japan"
          }
        ],
        "is_corresponding": false,
        "raw_affiliation_strings": [
          "National Institute for Fusion Science, National Institutes of Natural Sciences"
        ]
      }
    ],
    "fwci": 0.9171,
    "has_fulltext": true,
    "cited_by_count": 801217,
    "cites": 8,
    "citation_normalized_percentile": {
      "value": 0.83912838,
      "is_in_top_1_percent": false,
      "is_in_top_10_percent": false
    },
    "cited_by_percentile_year": {
      "min": 89,
      "max": 100
    },
    "biblio": {
      "volume": "15",
      "issue": "0",
      "first_page": "2402039",
      "last_page": "2402039"
    },
    "is_retracted": false,
    "is_paratext": false,
    "apc_paid": null,
    "primary_topic": {
      "id": "HX_T10346",
      "name": "Magnetic confinement fusion research"
    },
    "topics": [
      {
        "id": "HX_T10346",
        "name": "Magnetic confinement fusion research"
      },
      {
        "id": "HX_T11949",
        "name": "Nuclear Physics and Applications"
      },
      {
        "id": "HX_T10592",
        "name": "Fusion materials and technologies"
      }
    ],
    "sustainable_development_goals": [
      {
        "id": 7,
        "name": "Affordable and clean energy"
      }
    ],
    "funders": [
      {
        "id": "HX_F4320334764",
        "name": "Japan Society for the Promotion of Science",
        "awards": [
          {
            "id": "HX_G4452778246",
            "name": "Development of an innovative concept for reducing divertor heat load by recycling dust and deposition layers",
            "funder_award_id": "16H04619",
            "doi": null
          }
        ]
      }
    ],
    "counts_by_year": [
      {
        "year": 2026,
        "cited_by_count": 2
      },
      {
        "year": 2025,
        "cited_by_count": 801210
      },
      {
        "year": 2024,
        "cited_by_count": 2
      },
      {
        "year": 2022,
        "cited_by_count": 2
      },
      {
        "year": 2021,
        "cited_by_count": 1
      }
    ],
    "keywords": [
      "Radiation",
      "Plasma",
      "Materials science",
      "Optics",
      "Shield",
      "Neutron",
      "Nuclear engineering",
      "Physics",
      "Nuclear physics",
      "Geology"
    ],
    "abstract": "Radiation resistant camera system was constructed for monitoring deuterium plasma discharges in the Large Helical Device (LHD). This system has contributed to safe operation during two experimental campaigns without serious problems due to radiation (neutrons and gamma-rays).",
    "updated_date": "2026-07-22T07:51:19.307946",
    "created_date": "2025-10-10T00:00:00"
  }
  ```

  ```json 400 Bad Request theme={null}
  {
    "statusCode": 400,
    "message": "Only HX_ prefixed IDs are allowed",
    "error": "Bad Request"
  }
  ```

  ```json 404 Not Found theme={null}
  {
    "statusCode": 404,
    "message": "Output with ID HX_W9999999999 not found",
    "error": "Not Found"
  }
  ```

  ```json 429 Too Many Requests theme={null}
  {
    "statusCode": 429,
    "error": "Too Many Requests",
    "message": "IP rate limit exceeded (max 30 requests per minute). Please try again in 42 seconds (at 11:40:32 UTC).",
    "reset_in_seconds": 42,
    "reset_at_utc": "2026-08-05T11:40:32.000Z"
  }
  ```
</ResponseExample>
