Old OpenAlex API documentation
  • Overview
  • Quickstart tutorial
  • API Entities
    • Entities overview
    • 📄Works
      • Work object
        • Authorship object
        • Location object
      • Get a single work
      • Get lists of works
      • Filter works
      • Search works
      • Group works
      • Get N-grams
    • 👩Authors
      • Author object
      • Get a single author
      • Get lists of authors
      • Filter authors
      • Search authors
      • Group authors
      • Limitations
      • Author disambiguation
    • 📚Sources
      • Source object
      • Get a single source
      • Get lists of sources
      • Filter sources
      • Search sources
      • Group sources
    • 🏫Institutions
      • Institution object
      • Get a single institution
      • Get lists of institutions
      • Filter institutions
      • Search institutions
      • Group institutions
    • 💡Topics
      • Topic object
      • Get a single topic
      • Get lists of topics
      • Filter topics
      • Search topics
      • Group topics
    • 🗝️Keywords
    • 🏢Publishers
      • Publisher object
      • Get a single publisher
      • Get lists of publishers
      • Filter publishers
      • Search publishers
      • Group publishers
    • 💰Funders
      • Funder object
      • Get a single funder
      • Get lists of funders
      • Filter funders
      • Search funders
      • Group funders
    • 🌎Geo
      • Continents
      • Regions
    • 💡Concepts
      • Concept object
      • Get a single concept
      • Get lists of concepts
      • Filter concepts
      • Search concepts
      • Group concepts
    • Aboutness endpoint (/text)
  • How to use the API
    • API Overview
    • Get single entities
      • Random result
      • Select fields
    • Get lists of entities
      • Paging
      • Filter entity lists
      • Search entities
      • Sort entity lists
      • Select fields
      • Sample entity lists
      • Autocomplete entities
    • Get groups of entities
    • Rate limits and authentication
  • Download all data
    • OpenAlex snapshot
    • Snapshot data format
    • Download to your machine
    • Upload to your database
      • Load to a data warehouse
      • Load to a relational database
        • Postgres schema diagram
  • Additional Help
    • Tutorials
    • Report bugs
    • FAQ
Powered by GitBook
On this page
  • alternate_titles
  • cited_by_count
  • country_code
  • counts_by_year
  • created_date
  • description
  • display_name
  • grants_count
  • homepage_url
  • id
  • ids
  • image_thumbnail_url
  • image_url
  • roles
  • summary_stats
  • updated_date
  • works_count
  1. API Entities
  2. Funders

Funder object

PreviousFundersNextGet a single funder

Last updated 1 year ago

These are the fields in a funder object. When you use the API to get a single funder or lists of funders, this is what's returned.

alternate_titles

List: A list of alternate titles for this funder.

alternate_titles: [
  "US National Institutes of Health",
  "Institutos Nacionales de la Salud",
  "NIH"
]

cited_by_count

Integer: The total number that cite a work linked to this funder.

cited_by_count: 7823467

country_code

String: The country where this funder is located, represented as an .

country_code: "US"

counts_by_year

List: The values of and for each of the last ten years, binned by year. To put it another way: for every listed year, you can see how many new works are linked to this funder, and how many times any work linked to this funder was cited.

Years with zero citations and zero works have been removed so you will need to add those back in if you need them.

counts_by_year: [
    {
        year: 2021,
        works_count: 4211,
        cited_by_count: 120939
    },
    {
        year: 2020,
        works_count: 4363,
        cited_by_count: 119531
    },
    
    // and so forth
]

created_date

created_date: "2023-02-13"

description

description: "medical research organization in the United States"

display_name

String: The primary name of the funder.

display_name: "National Institutes of Health"

grants_count

Integer: The number of grants linked to this funder.

grants_count: 7109

homepage_url

String: The URL for this funder's primary homepage.

homepage_url: "http://www.nih.gov/"

id

String: The OpenAlex ID for this funder.

id: "https://openalex.org/F4320332161"

ids

Object: All the external identifiers that we know about for this funder. IDs are expressed as URIs whenever possible. Possible ID types:

  • crossref String: this funder's Crossref ID

  • doi String: this funder's DOI

  • ror String: this funder's ROR ID

ids: {
    openalex: "https://openalex.org/F4320332161",
    ror: "https://ror.org/01cwqze88",
    wikidata: "https://www.wikidata.org/entity/Q390551",
    crossref: "100000002",
    doi: "https://doi.org/10.13039/100000002"
}

image_thumbnail_url

This is usually a hotlink to a wikimedia image. You can change the width=300 parameter in the URL if you want a different thumbnail size.

image_thumbnail_url: "https://commons.wikimedia.org/w/index.php?title=Special:Redirect/file/NIH 2013 logo vertical.svg&width=300"

image_url

String: URL where you can get an image representing this funder. Usually this a hotlink to a Wikimedia image, and usually it's a seal or logo.

image_url: "https://commons.wikimedia.org/w/index.php?title=Special:Redirect/file/NIH 2013 logo vertical.svg"

roles

In many cases, a single organization does not fit neatly into one role. For example, Yale University is a single organization that is a research university, funds research studies, and publishes an academic journal. The roles property links the OpenAlex entities together for a single organization, and includes counts for the works associated with each role.

roles: [
    {
        role: "funder",
        id: "https://openalex.org/F4320308380",
        works_count: 1004,
    },
    {
        role: "publisher",
        id: "https://openalex.org/P4310315589",
        works_count: 13986,
    },
    {
        role: "institution",
        id: "https://openalex.org/I32971472",
        works_count: 250031,
    }
]

summary_stats

Object: Citation metrics for this funder

While the h-index and the i-10 index are normally author-level metrics and the 2-year mean citedness is normally a journal-level metric, they can be calculated for any set of papers, so we include them for funders.

summary_stats: {
    2yr_mean_citedness: 5.065784263815827,
    h_index: 985,
    i10_index: 176682
}

updated_date

updated_date: "2023-04-21T16:54:19.012138"

works_count

Integer: The number of works linked to this funder.

works_count: 260210

String: The date this Funder object was created in the OpenAlex dataset, expressed as an date string.

String: A short description of this funder, taken from .

openalex String: this funder's

wikidata String: this funder's

String: Same as , but it's a smaller image.

List: List of role objects, which include the role (one of institution, funder, or publisher), the id (), and the works_count.

The roles list of an entity (, , or ) always includes itself. In the case where an organization only has one role, the roles will be a list of length one, with itself as the only item.

2yr_mean_citedness Float: The 2-year mean citedness for this source. Also known as . We use the year prior to the current year for the citations (the numerator) and the two years prior to that for the citation-receiving publications (the denominator).

h_index Integer: The for this funder.

i10_index Integer: The for this funder.

String: The last time anything in this funder object changed, expressed as an date string. This date is updated for any change at all, including increases in various counts.

💰
ISO 8601
Wikidata ID
Funder
Publisher
Institution
impact factor
h-index
i-10 index
ISO 8601
Works
ISO two-letter country code
works_count
cited_by_count
Wikidata
image_url
OpenAlex ID
OpenAlex ID