> ## 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.

# Institution

> Retrieve detailed metadata for a single academic institution or research center by its HX_I identifier.

Retrieves a single academic institution, university, research institute, hospital, or corporate R\&D entity by its `HX_I` identifier.

### Path Parameters

<ParamField path="id" type="string" required>
  Unique institution identifier (e.g. `HX_I109009565`). Must be prefixed with `HX_I`.
</ParamField>

### Response Fields

<ResponseField name="id" type="string" required>
  Unique institution identifier prefixed with `HX_I` (e.g. `HX_I1299303238`).
</ResponseField>

<ResponseField name="ror" type="string">
  Research Organization Registry (ROR) URL.
</ResponseField>

<ResponseField name="name" type="string" required>
  Institution display name.
</ResponseField>

<ResponseField name="country" type="object">
  Country metadata object.

  <Expandable title="country attributes">
    <ResponseField name="code" type="string">ISO country code (e.g. `"US"`).</ResponseField>
    <ResponseField name="name" type="string">Country display name.</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="type" type="string">
  Institution classification (`government`, `education`, `facility`, `company`, `healthcare`).
</ResponseField>

<ResponseField name="homepage_url" type="string">
  Official institution website URL.
</ResponseField>

<ResponseField name="image_url" type="string">
  Image logo URL.
</ResponseField>

<ResponseField name="image_thumbnail_url" type="string">
  Thumbnail image URL.
</ResponseField>

<ResponseField name="display_name_acronyms" type="array">
  Acronyms array.
</ResponseField>

<ResponseField name="display_name_alternatives" type="array">
  Alternative names array.
</ResponseField>

<ResponseField name="repositories" type="array">
  Associated repositories array.

  <Expandable title="repositories attributes">
    <ResponseField name="id" type="string">Repository source ID (`HX_S...`).</ResponseField>
    <ResponseField name="name" type="string">Repository display name.</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="outputs_count" type="integer">
  Total number of indexed outputs affiliated with this institution.
</ResponseField>

<ResponseField name="cited_by_count" type="integer">
  Total citation count received.
</ResponseField>

<ResponseField name="summary_stats" type="object">
  Aggregated impact metrics.

  <Expandable title="summary_stats attributes">
    <ResponseField name="2yr_mean_citedness" type="number">Two-year mean citation rate.</ResponseField>
    <ResponseField name="h_index" type="integer">Calculated h-index score.</ResponseField>
    <ResponseField name="i10_index" type="integer">Calculated i10-index score.</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="associated_institutions" type="array">
  Parent and subsidiary institutions array.

  <Expandable title="associated_institutions attributes">
    <ResponseField name="id" type="string">Institution ID (`HX_I...`).</ResponseField>
    <ResponseField name="name" type="string">Institution display name.</ResponseField>
    <ResponseField name="relationship" type="string">Relationship type (`parent`, `child`, `related`).</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="counts_by_year" type="array">
  Outputs, OA outputs, and citations grouped by year.

  <Expandable title="counts_by_year attributes">
    <ResponseField name="year" type="integer">Year number.</ResponseField>
    <ResponseField name="outputs_count" type="integer">Outputs published in year.</ResponseField>
    <ResponseField name="oa_outputs_count" type="integer">Open Access outputs published in year.</ResponseField>
    <ResponseField name="cited_by_count" type="integer">Citations received in year.</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="roles" type="array">
  Roles array.

  <Expandable title="roles attributes">
    <ResponseField name="role" type="string">Role classification (`funder`, `institution`, `publisher`).</ResponseField>
    <ResponseField name="id" type="string">Entity ID.</ResponseField>
    <ResponseField name="outputs_count" type="integer">Outputs count for role.</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="geo" type="object">
  Geographic coordinates and location.

  <Expandable title="geo attributes">
    <ResponseField name="city" type="string">City name.</ResponseField>
    <ResponseField name="geonames_city_id" type="string">GeoNames city ID.</ResponseField>
    <ResponseField name="region" type="string">State or region name.</ResponseField>
    <ResponseField name="country_code" type="string">ISO country code.</ResponseField>
    <ResponseField name="country" type="string">Country display name.</ResponseField>
    <ResponseField name="latitude" type="number">Latitude coordinate.</ResponseField>
    <ResponseField name="longitude" type="number">Longitude coordinate.</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="international" type="object">
  International metadata object.
</ResponseField>

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

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

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

  <Expandable title="ids attributes">
    <ResponseField name="grid" type="string">GRID ID.</ResponseField>
    <ResponseField name="wikipedia" type="string">Wikipedia page URL.</ResponseField>
    <ResponseField name="wikidata" type="string">Wikidata entity URL.</ResponseField>
  </Expandable>
</ResponseField>

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

  <Expandable title="topics attributes">
    <ResponseField name="id" type="string">Topic ID (`HX_T...`).</ResponseField>
    <ResponseField name="name" type="string">Topic name.</ResponseField>
    <ResponseField name="count" type="integer">Outputs count in topic.</ResponseField>
    <ResponseField name="share" type="number">Output share proportion.</ResponseField>
  </Expandable>
</ResponseField>

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

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

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

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

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

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

  func main() {
  	resp, err := http.Get("https://api.hexagraph.in/institutions/HX_I1299303238")
  	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_I1299303238",
    "ror": "https://ror.org/01cwqze88",
    "name": "National Institutes of Health",
    "country": {
      "code": "US",
      "name": "United States"
    },
    "type": "government",
    "homepage_url": "https://www.nih.gov",
    "image_url": "https://commons.wikimedia.org/w/index.php?title=Special:Redirect/file/NIH%202013%20logo%20vertical.svg",
    "image_thumbnail_url": "https://commons.wikimedia.org/w/index.php?title=Special:Redirect/file/NIH%202013%20logo%20vertical.svg&width=300",
    "display_name_acronyms": [
      "NIH"
    ],
    "display_name_alternatives": [
      "National Institutes of Health",
      "US National Institutes of Health",
      "United States National Institutes of Health"
    ],
    "repositories": [
      {
        "id": "HX_S2764455111",
        "name": "PubMed Central"
      }
    ],
    "outputs_count": 274453,
    "cited_by_count": 70225412,
    "summary_stats": {
      "2yr_mean_citedness": 6.7651082522748665,
      "h_index": 2424,
      "i10_index": 530125
    },
    "associated_institutions": [
      {
        "id": "HX_I1299022934",
        "name": "United States Department of Health and Human Services",
        "relationship": "parent"
      }
    ],
    "counts_by_year": [
      {
        "year": 2026,
        "outputs_count": 6111,
        "oa_outputs_count": 5262,
        "cited_by_count": 1401
      },
      {
        "year": 2025,
        "outputs_count": 6288,
        "oa_outputs_count": 5230,
        "cited_by_count": 25042
      }
    ],
    "roles": [
      {
        "role": "funder",
        "id": "HX_F4320332161",
        "outputs_count": 1793561
      },
      {
        "role": "institution",
        "id": "HX_I1299303238",
        "outputs_count": 274453
      }
    ],
    "geo": {
      "city": "Bethesda",
      "geonames_city_id": "4348599",
      "region": "Maryland",
      "country_code": "US",
      "country": "United States",
      "latitude": 38.98067,
      "longitude": -77.10026
    },
    "international": {},
    "updated_date": "2026-08-05T05:59:45",
    "created_date": "2016-06-24T00:00:00",
    "ids": {
      "grid": "grid.94365.3d",
      "wikipedia": "http://en.wikipedia.org/wiki/National_Institutes_of_Health",
      "wikidata": null
    },
    "topics": [
      {
        "id": "HX_T11020",
        "name": "Immune Cell Function and Interaction",
        "count": 9779,
        "share": 0.0268975
      },
      {
        "id": "HX_T10031",
        "name": "T-cell and B-cell Immunology",
        "count": 7710,
        "share": 0.0267649
      }
    ]
  }
  ```

  ```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": "Institution with ID HX_I9999999999 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>
