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

# List institutions

> Query and list academic institutions with filtering, sorting, and pagination.

Retrieves a paginated list of academic institutions with filtering and sorting capabilities.

### Query Parameters

<ParamField query="page" default="1" type="integer">
  Page number for pagination. Default is `1`.
</ParamField>

<ParamField query="per_page" default="25" type="integer">
  Results per page. Allowed values: `10`, `25`, `50`, `100`.
</ParamField>

<ParamField query="filter" type="string">
  Filter expression (e.g. `type:education`, `country_code:US`).
</ParamField>

<ParamField query="sort" type="string">
  Sorting parameter (e.g. `outputs_count:desc`, `cited_by_count:desc`).
</ParamField>

### Response Fields

<ResponseField name="meta" type="object" required>
  Pagination metadata.

  <Expandable title="meta attributes">
    <ResponseField name="count" type="integer">Total matching records count.</ResponseField>
    <ResponseField name="page" type="integer">Current page number.</ResponseField>
    <ResponseField name="per_page" type="integer">Items per page.</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="results" type="array" required>
  Array of institution records.

  <Expandable title="results item attributes">
    <ResponseField name="id" type="string">Institution ID (`HX_I...`).</ResponseField>
    <ResponseField name="ror" type="string">Research Organization Registry (ROR) URL.</ResponseField>
    <ResponseField name="name" type="string">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. `"JP"`).</ResponseField>
        <ResponseField name="name" type="string">Country display name.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="type" type="string">Institution classification (`facility`, `education`, etc.).</ResponseField>
    <ResponseField name="homepage_url" type="string">Homepage 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">List of acronyms.</ResponseField>
    <ResponseField name="display_name_alternatives" type="array">List of alternative names.</ResponseField>

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

      <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 outputs count.</ResponseField>
    <ResponseField name="cited_by_count" type="integer">Total citations count.</ResponseField>

    <ResponseField name="summary_stats" type="object">
      Summary statistics object.

      <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">
      Associated parent/child institutions.

      <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">
      Yearly breakdown of outputs and citations.

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

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

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

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

      <Expandable title="geo attributes">
        <ResponseField name="city" type="string">City name.</ResponseField>
        <ResponseField name="geonames_city_id" type="string">GeoNames city identifier.</ResponseField>
        <ResponseField name="region" type="string">Region / state 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">Geographic latitude coordinate.</ResponseField>
        <ResponseField name="longitude" type="number">Geographic longitude coordinate.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="international" type="object">International metadata object.</ResponseField>
    <ResponseField name="updated_date" type="string">ISO update date string.</ResponseField>
    <ResponseField name="created_date" type="string">ISO creation date string.</ResponseField>

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

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

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET "https://api.hexagraph.in/institutions?filter=type:facility&sort=outputs_count:desc&per_page=25"
  ```

  ```javascript JavaScript theme={null}
  fetch("https://api.hexagraph.in/institutions?filter=type:facility&sort=outputs_count:desc&per_page=25")
    .then(response => response.json())
    .then(data => console.log(data));
  ```

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

  response = requests.get("https://api.hexagraph.in/institutions", params={"filter": "type:facility", "sort": "outputs_count:desc", "per_page": 25})
  print(response.json())
  ```
</RequestExample>

<ResponseExample>
  ```json 200 OK theme={null}
  {
    "meta": {
      "count": 134448,
      "page": 1,
      "per_page": 25
    },
    "results": [
      {
        "id": "HX_I4210108322",
        "ror": "https://ror.org/01t3wyv61",
        "name": "National Institute for Fusion Science",
        "country": {
          "code": "JP",
          "name": "Japan"
        },
        "type": "facility",
        "homepage_url": "https://www.nifs.ac.jp",
        "image_url": null,
        "image_thumbnail_url": null,
        "display_name_acronyms": [
          "NIFS"
        ],
        "display_name_alternatives": [
          "Kakuyugo Kagaku Kenkyujo",
          "Kakuyugou Kagaku Kenkyuujo",
          "Kakuyūgō Kagaku Kenkyūjo",
          "NINS National Institute for Fusion Science",
          "National Institute for Fusion Science",
          "National Institutes of Natural Sciences National Institute for Fusion Science",
          "かくゆうごうかがくけんきゅうじょ",
          "カクユウゴウカガクケンキュウジョ",
          "核融合科学研究所"
        ],
        "repositories": [
          {
            "id": "HX_S4306401138",
            "name": "National Institute for Fusion Science Repository (National Institute for Fusion Science)"
          }
        ],
        "outputs_count": 40567916,
        "cited_by_count": 2350640,
        "summary_stats": {
          "2yr_mean_citedness": 0.000029117814157264747,
          "h_index": 194,
          "i10_index": 18840
        },
        "associated_institutions": [
          {
            "id": "HX_I199525922",
            "name": "National Institutes of Natural Sciences",
            "relationship": "parent"
          }
        ],
        "counts_by_year": [
          {
            "year": 2026,
            "outputs_count": 11617444,
            "oa_outputs_count": 11617410,
            "cited_by_count": 49
          },
          {
            "year": 2025,
            "outputs_count": 18940305,
            "oa_outputs_count": 18940235,
            "cited_by_count": 442
          },
          {
            "year": 2024,
            "outputs_count": 10000445,
            "oa_outputs_count": 10000376,
            "cited_by_count": 1130
          }
        ],
        "roles": [
          {
            "role": "funder",
            "id": "HX_F4320338091",
            "outputs_count": 2266
          },
          {
            "role": "institution",
            "id": "HX_I4210108322",
            "outputs_count": 40567916
          }
        ],
        "geo": {
          "city": "Toki",
          "geonames_city_id": "1850207",
          "region": null,
          "country_code": "JP",
          "country": "Japan",
          "latitude": 35.349998474121094,
          "longitude": 137.18333435058594
        },
        "international": {},
        "updated_date": "2026-08-05T05:59:45",
        "created_date": "2022-02-02T04:48:36",
        "topics": [
          {
            "id": "HX_T12157",
            "name": "Geochemistry and Geologic Mapping"
          },
          {
            "id": "HX_T13067",
            "name": "Geological Modeling and Analysis"
          },
          {
            "id": "HX_T10346",
            "name": "Magnetic confinement fusion research"
          }
        ]
      }
    ]
  }
  ```

  ```json 400 Bad Request theme={null}
  {
    "statusCode": 400,
    "message": "Bad Request - Invalid query parameters",
    "error": "Bad Request"
  }
  ```

  ```json 429 Rate Limit Exceeded theme={null}
  {
    "statusCode": 429,
    "message": "Rate limit exceeded. Maximum 30 requests per minute.",
    "error": "Too Many Requests"
  }
  ```
</ResponseExample>
