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

# Funder

> Retrieve detailed metadata for a single research funding agency by its HX_F identifier.

Retrieves a single research granting agency, foundation, or government funding body by its `HX_F` identifier.

### Path Parameters

<ParamField path="id" type="string" required>
  Unique funder identifier (e.g. `HX_F4320321001`). Must be prefixed with `HX_F`.
</ParamField>

### Response Fields

<ResponseField name="id" type="string" required>
  Unique funder identifier prefixed with `HX_F` (e.g. `HX_F4320321001`).
</ResponseField>

<ResponseField name="name" type="string" required>
  Funder display name (e.g. `"National Science Foundation"`).
</ResponseField>

<ResponseField name="alternate_titles" type="array">
  Alternative display names or abbreviations.
</ResponseField>

<ResponseField name="country" type="object">
  Country of origin details.

  <Expandable title="country attributes">
    <ResponseField name="code" type="string">Two-letter country code.</ResponseField>
    <ResponseField name="name" type="string">Country display name.</ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="description" type="string">
  Summary description of the funding agency.
</ResponseField>

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

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

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

<ResponseField name="grants_count" type="integer">
  Total number of grants associated with this funder.
</ResponseField>

<ResponseField name="awards_count" type="integer">
  Total number of awards associated with this funder.
</ResponseField>

<ResponseField name="outputs_count" type="integer">
  Total number of indexed outputs funded by this agency.
</ResponseField>

<ResponseField name="cited_by_count" type="integer">
  Total citation count received across all funded outputs.
</ResponseField>

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

  <Expandable title="summary_stats attributes">
    <ResponseField name="2yr_mean_citedness" type="number">2-year mean citedness.</ResponseField>
    <ResponseField name="h_index" type="integer">h-index of the funder.</ResponseField>
    <ResponseField name="i10_index" type="integer">i10-index of the funder.</ResponseField>
  </Expandable>
</ResponseField>

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

  <Expandable title="roles attributes">
    <ResponseField name="role" type="string">Role name (e.g. `funder`).</ResponseField>
    <ResponseField name="id" type="string">Role unique ID.</ResponseField>
    <ResponseField name="outputs_count" type="integer">Outputs count associated with this role.</ResponseField>
  </Expandable>
</ResponseField>

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

  <Expandable title="ids attributes">
    <ResponseField name="doi" type="string">Digital Object Identifier.</ResponseField>
    <ResponseField name="ror" type="string">Research Organization Registry ID.</ResponseField>
    <ResponseField name="wikidata" type="string">Wikidata URL.</ResponseField>
    <ResponseField name="crossref" type="string">Crossref identifier.</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">Calendar year.</ResponseField>
    <ResponseField name="outputs_count" type="integer">Outputs count in the year.</ResponseField>
    <ResponseField name="oa_outputs_count" type="integer">Open Access outputs count in the year.</ResponseField>
    <ResponseField name="cited_by_count" type="integer">Citations count in the year.</ResponseField>
  </Expandable>
</ResponseField>

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

<ResponseField name="created_date" type="string">
  Creation timestamp.
</ResponseField>

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

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

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

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

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

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

  func main() {
  	resp, err := http.Get("https://api.hexagraph.in/funders/HX_F4320321001")
  	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_F4320321001",
    "name": "National Natural Science Foundation of China",
    "alternate_titles": [
      "NNSF of China",
      "Guójiā Zìrán Kēxué Jījīn Wěiyuánhuì",
      "NSF of China",
      "The National Natural Science Foundation of China",
    ],
    "country": {
      "code": "CN",
      "name": "China"
    },
    "description": "Chinese government body",
    "homepage_url": "https://www.nsfc.gov.cn",
    "image_url": "https://commons.wikimedia.org/w/index.php?title=Special:Redirect/file/National Natural Science Foundation of China (20230310102823).jpg",
    "image_thumbnail_url": "https://commons.wikimedia.org/w/index.php?title=Special:Redirect/file/National Natural Science Foundation of China (20230310102823).jpg&width=300",
    "grants_count": 1698,
    "awards_count": 1190293,
    "outputs_count": 4455709,
    "cited_by_count": 113648084,
    "summary_stats": {
      "2yr_mean_citedness": 5.924197295373457,
      "h_index": 1211,
      "i10_index": 2243793
    },
    "ids": {
      "ror": "https://ror.org/01h0zpd94",
      "wikidata": "https://www.wikidata.org/entity/Q4501917",
      "crossref": "501100001809",
      "doi": "10.13039/501100001809"
    },
    "counts_by_year": [
      {
        "year": 2028,
        "outputs_count": 4,
        "oa_outputs_count": 4,
        "cited_by_count": 0
      }
    ],
    "roles": [
      {
        "role": "funder",
        "id": "HX_F4320321001",
        "outputs_count": 4455709
      }
    ],
    "updated_date": "2026-08-05T04:01:50",
    "created_date": "2023-02-13T20:32:25"
  }
  ```

  ```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": "Funder with ID HX_F9999999999 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>
