ROR data structure

ROR's current data structure is based on Digital Science's GRID, which provided the original seed data for the registry. GRID has retired its public releases as of 16 Sep 2021, and the ROR data structure will evolve over time and based on community feedback now that ROR is managed independently from GRID.

To suggest a change to the ROR data structure, please post your suggestion on the ROR Roadmap Discussion board.

See also ROR Metadata Policies on GitHub.

ROR metadata

Records will return all fields regardless of whether they have a value. JSON will return null values and empty arrays and objects if there is no value available for the given organization.

Field name

Definition

Type

Required

Value required

Remarks

id

Unique ROR ID for the organization

String

TRUE

TRUE

name

The primary name of the organization

String

TRUE

TRUE

email_address

A contact mail address for the organization

String

FALSE

FALSE

Deprecated field - Not actively curating

ip_addresses

IP address(es) associated with the organization

Array

FALSE

FALSE

Deprecated field - Not actively curating

established

Year the organization was established (CE)

Number

TRUE

FALSE

types

Organization type

Array

TRUE

TRUE

Allowed types: Education, Healthcare, Company, Archive, Nonprofit, Government, Facility, Other

relationships

Related organizations in ROR

Array

TRUE

FALSE

Allowed relationship types: Parent, Child, Related

addresses

The organization's location

Array

TRUE

TRUE

links

Official website of the organization

Array

TRUE

FALSE

aliases

Other names the organization is known by

Array

TRUE

FALSE

acronyms

Acronyms or initialisms for the organization name

Array

TRUE

FALSE

status

Whether the organization is active or not

String

TRUE

TRUE

Forthcoming circa October 2022: Active, Inactive, Withdrawn

wikipedia_url

Wikipedia link for the organization

String

TRUE

FALSE

labels

Name(s) for the organization in other language(s)

Array

TRUE

FALSE

country

Country where organization is located

Object

TRUE

TRUE

external_ids

Other identifiers for the organization

Array

TRUE

FALSE

Allowed external IDs: Crossref Funder ID (FundRef), ISNI, Wikidata. Other external IDs not actively curated include GRID, OrgRef, HESA, UCAS, UKPRN, CNRS.

Definitions and policies for specific metadata elements

* indicates a value is required

name*

The official name of the organization used for affiliation purposes (this may be different than the organization's legal name).

Only one name can be included in the primary name field. ROR metadata includes additional fields (alias, labels, acronym) for other versions of an organization’s name so that these versions of the name can also be represented in the metadata record and so that the organization can be discoverable in the registry no matter which version of a name is input by a user in searches and API queries.

The primary name field defaults to English when an English version of an organization’s name is available, but primary names may also be in non-English languages.

ROR metadata can support multiple languages and character sets. However, the primary name field uses Latin (Roman) characters only.

The primary data source for the organization name and formatting thereof is the organization's website.

alias, labels

alias is used for one or more alternate forms of the organization name that may be used for affiliation purposes but are not considered the primary name according to official organization policy and/or for the purposes of ROR metadata handling. This field may include both current and historical name variants. ROR does not currently identify which aliases are current versus historical (this is something to address in future iterations of the ROR schema).

labels displays versions of the organization name in one or more languages other than that used in the primary name field, with a corresponding language tag based on the two-letter ISO-639 code.

acronym

One or more official acronyms or initialisms for the organization, typically consisting of the first letters of the words in the organization name (e.g., UCLA for “University of California, Los Angeles”).

links

The primary website of the organization. Only one URL should be associated with the record.

In the case of websites with translated versions that use a language suffix like “/en”, the generic URL (without the language suffix) is used as long as the website resolves without it. Otherwise, the English version will be used.

types*

The type of organization based on a controlled list of categories. An organization always has a type. ROR metadata can support multiple types for a given organization, but in most cases, there will just be one type associated with the organization.

Based on the available information about the organization, curators will use their judgement in determining the appropriate category to assign.

Allowed types:

Education: A university or similar institution involved in providing education and educating/employing researchers

Healthcare: A medical care facility such as hospital or medical clinic. Excludes medical schools, which should be categorized as “Education”.

Company: A private for-profit corporate entity involved in conducting or sponsoring research.

Archive: An organization involved in stewarding research and cultural heritage materials. Includes libraries, museums, and zoos.

Nonprofit: A non-profit and non-governmental organization involved in conducting or funding research.

Government: An organization that is part of or operated by a national or regional government and that conducts or supports research.

Facility: A specialized facility where research takes place, such as a laboratory or telescope or dedicated research area.

Other: Use this category for any organization that does not fit the categories above.

addresses

Location details for the organization. Location data comes from GeoNames.

A city or specified location is required to populate corresponding data from GeoNames, such as latitude/longitude coordinates, state/province/region, and country.

external_ids

Other identifiers for the organization (if available).

ROR maps its IDs to the following other identifiers: GRID, Wikidata, ISNI, and Crossref Funder Registry (formerly “Fundref”).

There are additional IDs in the existing ROR metadata that are primarily legacy identifiers. These will not be actively curated in new records for the time being: OrgRef, UCAS, CNRS, HESA, UKPRN.

relationships

One or more organizations that the organization is related to.

Only three types of relations are supported: an organization can have a parent, a child, or a related organization. An organization can have multiple relations but each relation must be classified as either parent, child, or related.

Given that ROR’s scope is top-level organizations, the relationships captured in ROR are meant solely to describe relations between top-level organizations, such as a university and an associated hospital.

established

The year the organization was established, written as four digits (YYYY).

Example record

See the JSON structure in an example organization record.

{
   "id":"https://ror.org/013cjyk83",
   "name":"PSL Research University",
   "email_address":null,
   "ip_addresses":[
      
   ],
   "established":2010,
   "types":[
      "Education"
   ],
   "relationships":[
      {
         "label":"ESPCI Paris",
         "type":"Child",
         "id":"https://ror.org/03zx86w41"
      },
      {
         "label":"Subcellular Structure and Cellular Dynamics",
         "type":"Child",
         "id":"https://ror.org/04w11tv37"
      },
      {
         "label":"École Pratique des Hautes Études",
         "type":"Child",
         "id":"https://ror.org/046b3cj80"
      }
   ],
   "addresses":[
      {
         "lat":48.854692,
         "lng":2.33781,
         "state":null,
         "state_code":null,
         "city":"Paris",
         "geonames_city":{
            "id":2988507,
            "city":"Paris",
            "geonames_admin1":{
               "name":"Île-de-France",
               "id":3012874,
               "ascii_name":"Ile-de-France",
               "code":"FR.11"
            },
            "geonames_admin2":{
               "name":"Paris",
               "id":2968815,
               "ascii_name":"Paris",
               "code":"FR.11.75"
            },
            "license":{
               "attribution":"Data from geonames.org under a CC-BY 3.0 license",
               "license":"http://creativecommons.org/licenses/by/3.0/"
            },
            "nuts_level1":{
               "name":"ÎLE DE FRANCE",
               "code":"FR1"
            },
            "nuts_level2":{
               "name":"Île de France",
               "code":"FR10"
            },
            "nuts_level3":{
               "name":"Paris",
               "code":"FR101"
            }
         },
         "postcode":null,
         "primary":false,
         "line":null,
         "country_geonames_id":3017382
      }
   ],
   "links":[
      "https://www.psl.eu/en/university"
   ],
   "aliases":[
      "Université PSL"
   ],
   "acronyms":[
      "PSL"
   ],
   "status":"active",
   "wikipedia_url":"https://en.wikipedia.org/wiki/PSL_Research_University",
   "labels":[
      {
         "label":"Université de recherche Paris Sciences et Lettres",
         "iso639":"fr"
      }
   ],
   "country":{
      "country_name":"France",
      "country_code":"FR"
   },
   "external_ids":{
      "ISNI":{
         "preferred":null,
         "all":[
            "0000 0004 1784 3645"
         ]
      },
      "OrgRef":{
         "preferred":null,
         "all":[
            "31274670"
         ]
      },
      "Wikidata":{
         "preferred":null,
         "all":[
            "Q1163431"
         ]
      },
      "GRID":{
         "preferred":"grid.440907.e",
         "all":"grid.440907.e"
      }
   }
}

Other resources you might find helpful