DataCite Support

DataCite Support

Welcome to DataCite's support site. Here you will find helpful information about our services. We have included comprehensive technical guides, training materials, and tips to help you successfully use DataCite services.

Get Started    API Reference

Retrieving a list of DOIs

Responses from each of your requests fall into two basic categories: Singletons (i.e., a single record) and Lists (i.e., a list of records). This section of the guide will cover lists. The previous section (Retrieving a single DOI) covered singletons.

List results can contain multiple entries. Searching or filtering (see Making and filtering queries) typically returns a list result. If you want to include "registered" and "draft" state DOIs (basically any DOIs that are not public facing) you will need to authenticate.

See the documenatation about pagination for details of how this is handled with the REST API.

What's in a list?

A list has four parts:

  • data, which will contain the items matching the query or filter.
  • included, which will contain side-loaded associations, via the ?include=x parameter.
  • meta, which includes information about the query, e.g. number of results returned.
  • links, which includes links to the current and next page.

For example, retrieving the metadata records for a list of DOIs can be done as follows:

# GET /dois
$ curl https://api.test.datacite.org/dois/
{
  "data": [{
      "id": "10.15468/dl.ydqssk",
      "type": "dois",
      "attributes": {
        "doi": "10.15468/dl.ydqssk",
        "identifiers": [{
            "identifier": "https://doi.org/10.15468/dl.ydqssk",
            "identifierType": "DOI"
          },
          {
            "identifier": "0036778-181108115102211",
            "identifierType": "GBIF"
          }
        ],
        "creators": [{
          "name": "Occdownload Gbif.Org"
        }],
        "titles": [{
          "title": "GBIF Occurrence Download"
        }],
        "publisher": "The Global Biodiversity Information Facility",
        "container": null,
        "publicationYear": 2019,
        "subjects": [{
            "lang": "eng",
            "subject": "GBIF"
          },
          {
            "lang": "eng",
            "subject": "biodiversity"
          },
          {
            "lang": "eng",
            "subject": "species occurrences"
          }
        ],
        "contributors": null,
        "dates": [{
            "date": "2019-02-06",
            "dateType": "Created"
          },
          {
            "date": "2019-02-06",
            "dateType": "Updated"
          },
          {
            "date": "2019",
            "dateType": "Issued"
          }
        ],
        "language": null,
        "types": {
          "ris": "DATA",
          "bibtex": "misc",
          "citeproc": "dataset",
          "schemaOrg": "Dataset",
          "resourceTypeGeneral": "Dataset"
        },
        "relatedIdentifiers": [{
            "relationType": "References",
            "relatedIdentifier": "10.15468/xtjld4",
            "relatedIdentifierType": "DOI"
          },
          {
            "relationType": "References",
            "relatedIdentifier": "10.15468/xmki52",
            "relatedIdentifierType": "DOI"
          },
          {
            "relationType": "References",
            "relatedIdentifier": "10.15468/ul946t",
            "relatedIdentifierType": "DOI"
          },
          {
            "relationType": "References",
            "relatedIdentifier": "10.15468/dg1xxz",
            "relatedIdentifierType": "DOI"
          },
          {
            "relationType": "References",
            "relatedIdentifier": "10.15468/jxs9rn",
            "relatedIdentifierType": "DOI"
          },
          {
            "relationType": "References",
            "relatedIdentifier": "10.15468/cpnhcc",
            "relatedIdentifierType": "DOI"
          },
          {
            "relationType": "References",
            "relatedIdentifier": "10.15468/hnhrg3",
            "relatedIdentifierType": "DOI"
          },
          {
            "relationType": "References",
            "relatedIdentifier": "10.15468/ypoair",
            "relatedIdentifierType": "DOI"
          },
          {
            "relationType": "References",
            "relatedIdentifier": "10.15468/nc6rxy",
            "relatedIdentifierType": "DOI"
          },
          {
            "relationType": "References",
            "relatedIdentifier": "10.15468/rvjdu1",
            "relatedIdentifierType": "DOI"
          },
          {
            "relationType": "References",
            "relatedIdentifier": "10.15468/tqcbr0",
            "relatedIdentifierType": "DOI"
          },
          {
            "relationType": "References",
            "relatedIdentifier": "10.15468/mug7kr",
            "relatedIdentifierType": "DOI"
          },
          {
            "relationType": "References",
            "relatedIdentifier": "10.15468/ly60bx",
            "relatedIdentifierType": "DOI"
          }
        ],
        "sizes": [
          "2926"
        ],
        "formats": [
          "Darwin Core Archive"
        ],
        "version": null,
        "rightsList": [{
          "rights": "Creative Commons Attribution Non Commercial (CC-BY-NC) 4.0",
          "rightsUri": "http://creativecommons.org/licenses/by-nc/4.0/legalcode"
        }],
        "descriptions": [{
          "lang": "eng",
          "description": "A dataset containing 19 species occurrences available in GBIF matching the query: TaxonKey: Oxytropis fominii Grossh.. The dataset includes 19 records from 13 constituent datasets: \n 1 records from Universidad del Paí­s Vasco/EHU, Bilbao: Herbario BIO. \n 1 records from Colección de plantas vasculares del herbario de la Universitat de València (VAL).. \n 1 records from Herbario de Plantas Vasculares de la Universidad de Salamanca: SALA. \n 1 records from Herbaria of the University and ETH Zürich. \n 1 records from Aranzadi Zientzi Elkartea. \n 2 records from Moscow University Herbarium (MW). \n 1 records from NMNH Extant Specimen Records. \n 6 records from Royal Botanic Garden Edinburgh Herbarium (E). \n 1 records from The vascular plants collection (P) at the Herbarium of the Muséum national d'Histoire Naturelle (MNHN - Paris). \n 1 records from Geneva Herbarium – General Collection (G). \n 1 records from VIT Herbarium - Vascular Plants (The Natural History Museum of Alava). \n 1 records from CSIC-Real Jardín Botánico-Colección de Plantas Vasculares (MA). \n 1 records from Royal Botanic Gardens, Kew - Herbarium Specimens. Data from some individual datasets included in this download may be licensed under less restrictive terms.",
          "descriptionType": "Abstract"
        }],
        "geoLocations": null,
        "fundingReferences": null,
        "url": "https://www.gbif.org/occurrence/download/0036778-181108115102211",
        "contentUrl": null,
        "metadataVersion": 0,
        "schemaVersion": "http://datacite.org/schema/kernel-3",
        "source": "mds",
        "isActive": true,
        "state": "findable",
        "reason": null,
        "created": "2019-02-06T19:42:33.000Z",
        "registered": "2019-02-06T19:42:33.000Z",
        "updated": "2019-02-06T19:42:34.000Z"
      },
      "relationships": {
        "client": {
          "data": {
            "id": "gbif.gbif",
            "type": "clients"
          }
        }
      }
    },
    {
      "id": "10.21994/loar160",
      "type": "dois",
      "attributes": {
        "doi": "10.21994/loar160",
        "identifiers": [{
            "identifier": "https://doi.org/10.21994/loar160",
            "identifierType": "DOI"
          },
          {
            "identifier": "https://loar.kb.dk/handle/1902/330",
            "identifierType": "uri"
          }
        ],
        "creators": [{
          "name": "Meyer-Helmund, Erik",
          "nameType": "Personal",
          "givenName": "Erik",
          "familyName": "Meyer-Helmund"
        }],
        "titles": [{
          "title": "Zauberlied"
        }],
        "publisher": "Royal Danish Library",
        "container": {},
        "publicationYear": 2018,
        "subjects": [{
          "subject": "valse"
        }],
        "contributors": [{
            "name": "Management, Royal Danish Library Data",
            "nameType": "Personal",
            "givenName": "Royal Danish Library Data",
            "familyName": "Management",
            "contributorType": "DataManager"
          },
          {
            "name": "Library, Royal Danish",
            "nameType": "Personal",
            "givenName": "Royal Danish",
            "familyName": "Library",
            "contributorType": "HostingInstitution"
          }
        ],
        "dates": [{
            "date": "2018-08-16",
            "dateType": "Accepted"
          },
          {
            "date": "2018-08-16",
            "dateType": "Available"
          },
          {
            "date": "2018",
            "dateType": "Issued"
          }
        ],
        "language": null,
        "types": {
          "ris": "GEN",
          "bibtex": "misc",
          "citeproc": "article",
          "schemaOrg": "CreativeWork"
        },
        "relatedIdentifiers": [],
        "sizes": [],
        "formats": [],
        "version": null,
        "rightsList": [{
            "rights": "Attribution-NonCommercial-ShareAlike 2.5 Denmark"
          },
          {
            "rightsUri": "http://creativecommons.org/licenses/by-nc-sa/2.5/dk"
          }
        ],
        "descriptions": [{
          "description": "Af den klaverakkompagnerede sang synges første vers og andet omkvæd. Sanger senere kendt som Peter Cornelius.",
          "descriptionType": "Abstract"
        }],
        "geoLocations": [],
        "fundingReferences": [],
        "url": null,
        "contentUrl": null,
        "metadataVersion": 13,
        "schemaVersion": "http://datacite.org/schema/kernel-3",
        "source": "mds",
        "isActive": false,
        "state": "registered",
        "reason": null,
        "created": "2018-08-16T18:00:44.000Z",
        "registered": null,
        "updated": "2019-02-06T19:42:22.000Z"
      },
      "relationships": {
        "client": {
          "data": {
            "id": "dk.sb",
            "type": "clients"
          }
        }
      }
    }
  ],
  "included": [{
      "id": "gbif.gbif",
      "type": "clients",
      "attributes": {
        "name": "Global Biodiversity Information Facility",
        "symbol": "GBIF.GBIF",
        "year": 2018,
        "contactName": "Daniel Noesgaard",
        "contactEmail": "[email protected]",
        "description": "GBIF is an international organisation that is working to make the world's biodiversity data accessible everywhere in the world. GBIF and its many partners work to mobilize the data, and to improve search mechanisms, data and metadata standards, web services, and the other components of an Internet-based information infrastructure for biodiversity.\r\nGBIF makes available data that are shared by hundreds of data publishers from around the world. These data are shared according to the GBIF Data Use Agreement, which includes the provision that users of any data accessed through or retrieved via the GBIF Portal will always give credit to the original data publishers.",
        "domains": "*",
        "url": "https://www.gbif.org/",
        "created": "2018-12-20T14:03:45.000Z",
        "updated": "2018-12-20T15:48:55.000Z",
        "isActive": true,
        "hasPassword": true
      },
      "relationships": {
        "provider": {
          "data": {
            "id": "gbif",
            "type": "providers"
          }
        },
        "repository": {
          "data": {
            "id": "10.17616/R3J014",
            "type": "repositories"
          }
        },
        "prefixes": {
          "data": [{
              "id": "10.15469",
              "type": "prefixes"
            },
            {
              "id": "10.15468",
              "type": "prefixes"
            },
            {
              "id": "10.26161",
              "type": "prefixes"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "total": 16163585,
    "totalPages": 400,
    "page": 1,
    "states": [{
        "id": "findable",
        "title": "Findable",
        "count": 13988297
      },
      {
        "id": "registered",
        "title": "Registered",
        "count": 2038055
      },
      {
        "id": "draft",
        "title": "Draft",
        "count": 137233
      }
    ],
    "resourceTypes": [{
        "id": "dataset",
        "title": "Dataset",
        "count": 5638256
      },
      {
        "id": "text",
        "title": "Text",
        "count": 3677624
      },
      {
        "id": "other",
        "title": "Other",
        "count": 1329137
      },
      {
        "id": "image",
        "title": "Image",
        "count": 1136857
      },
      {
        "id": "physical-object",
        "title": "PhysicalObject",
        "count": 879433
      },
      {
        "id": "collection",
        "title": "Collection",
        "count": 595510
      },
      {
        "id": "audiovisual",
        "title": "Audiovisual",
        "count": 85732
      },
      {
        "id": "workflow",
        "title": "Workflow",
        "count": 83144
      },
      {
        "id": "software",
        "title": "Software",
        "count": 82965
      },
      {
        "id": "interactive-resource",
        "title": "InteractiveResource",
        "count": 55409
      },
      {
        "id": "event",
        "title": "Event",
        "count": 8446
      },
      {
        "id": "sound",
        "title": "Sound",
        "count": 5586
      },
      {
        "id": "model",
        "title": "Model",
        "count": 3229
      },
      {
        "id": "film",
        "title": "Film",
        "count": 1630
      },
      {
        "id": "data-paper",
        "title": "DataPaper",
        "count": 756
      }
    ],
    "created": [{
        "id": "2011",
        "title": "2011",
        "count": 748443
      },
      {
        "id": "2012",
        "title": "2012",
        "count": 665761
      },
      {
        "id": "2013",
        "title": "2013",
        "count": 948008
      },
      {
        "id": "2014",
        "title": "2014",
        "count": 1894065
      },
      {
        "id": "2015",
        "title": "2015",
        "count": 2565786
      },
      {
        "id": "2016",
        "title": "2016",
        "count": 2340736
      },
      {
        "id": "2017",
        "title": "2017",
        "count": 3109411
      },
      {
        "id": "2018",
        "title": "2018",
        "count": 3682899
      },
      {
        "id": "2019",
        "title": "2019",
        "count": 208476
      }
    ],
    "registered": [{
        "id": "2004",
        "title": "2004",
        "count": 24
      },
      {
        "id": "2005",
        "title": "2005",
        "count": 255104
      },
      {
        "id": "2006",
        "title": "2006",
        "count": 216729
      },
      {
        "id": "2007",
        "title": "2007",
        "count": 78837
      },
      {
        "id": "2008",
        "title": "2008",
        "count": 35176
      },
      {
        "id": "2009",
        "title": "2009",
        "count": 82492
      },
      {
        "id": "2010",
        "title": "2010",
        "count": 332088
      },
      {
        "id": "2011",
        "title": "2011",
        "count": 156156
      },
      {
        "id": "2012",
        "title": "2012",
        "count": 494205
      },
      {
        "id": "2013",
        "title": "2013",
        "count": 713764
      },
      {
        "id": "2014",
        "title": "2014",
        "count": 1891581
      },
      {
        "id": "2015",
        "title": "2015",
        "count": 2563675
      },
      {
        "id": "2016",
        "title": "2016",
        "count": 2335420
      },
      {
        "id": "2017",
        "title": "2017",
        "count": 3104446
      },
      {
        "id": "2018",
        "title": "2018",
        "count": 3600461
      },
      {
        "id": "2019",
        "title": "2019",
        "count": 169411
      }
    ],
    "providers": [{
        "id": "ethz",
        "title": "ETH Zurich",
        "count": 1861598
      },
      {
        "id": "sage",
        "title": "SAGE Publishing",
        "count": 1686336
      },
      {
        "id": "tib",
        "title": "German National Library of Science and Technology",
        "count": 1503525
      },
      {
        "id": "bl",
        "title": "British Library",
        "count": 1210667
      },
      {
        "id": "figshare",
        "title": "figshare",
        "count": 1202643
      },
      {
        "id": "fao",
        "title": "FAO",
        "count": 829032
      },
      {
        "id": "cdl",
        "title": "California Digital Library",
        "count": 826959
      },
      {
        "id": "cern",
        "title": "CERN - European Organization for Nuclear Research",
        "count": 809016
      },
      {
        "id": "rg",
        "title": "ResearchGate",
        "count": 771107
      },
      {
        "id": "gesis",
        "title": "GESIS - Leibniz Institute for the Social Sciences",
        "count": 695568
      },
      {
        "id": "estdoi",
        "title": "Tartu University",
        "count": 679720
      },
      {
        "id": "gbif",
        "title": "Global Biodiversity Information Facility",
        "count": 546932
      },
      {
        "id": "usc",
        "title": "University of Southern California",
        "count": 446178
      },
      {
        "id": "cul",
        "title": "Columbia University Libraries",
        "count": 431649
      },
      {
        "id": "cisti",
        "title": "National Research Council Canada",
        "count": 344324
      }
    ],
    "clients": [{
        "id": "sage.dplanet",
        "title": "Data Planet",
        "count": 1686336
      },
      {
        "id": "figshare.ars",
        "title": "figshare Academic Research System",
        "count": 1148737
      },
      {
        "id": "fao.itpgrfa",
        "title": "International Treaty on Plant Genetic Resources for Food and Agriculture",
        "count": 829027
      },
      {
        "id": "rg.rg",
        "title": "ResearchGate",
        "count": 771107
      },
      {
        "id": "bl.ccdc",
        "title": "The Cambridge Crystallographic Data Centre",
        "count": 768734
      },
      {
        "id": "ethz.seals",
        "title": "E-Periodica",
        "count": 758570
      },
      {
        "id": "tib.pangaea",
        "title": "PANGAEA",
        "count": 742307
      },
      {
        "id": "estdoi.bio",
        "title": "Plutof.  Data Management and Publishing Platform",
        "count": 675463
      },
      {
        "id": "cern.zenodo",
        "title": "Zenodo",
        "count": 610448
      },
      {
        "id": "gbif.gbif",
        "title": "Global Biodiversity Information Facility",
        "count": 546932
      },
      {
        "id": "usc.dl",
        "title": "University of Southern California Digital Library",
        "count": 446165
      },
      {
        "id": "ethz.epics-ba",
        "title": "E-Pics Bildarchiv",
        "count": 434457
      },
      {
        "id": "cul.columbia",
        "title": "Columbia University Libraries",
        "count": 404859
      },
      {
        "id": "gesis.die",
        "title": "Deutsches Institut für Erwachsenenbildung",
        "count": 373236
      },
      {
        "id": "gdcc.harvard-dv",
        "title": "Harvard IQSS Dataverse",
        "count": 308640
      }
    ],
    "prefixes": [{
        "id": "10.6068",
        "title": "10.6068",
        "count": 1686336
      },
      {
        "id": "10.6084",
        "title": "10.6084",
        "count": 1148753
      },
      {
        "id": "10.18730",
        "title": "10.18730",
        "count": 829027
      },
      {
        "id": "10.1594",
        "title": "10.1594",
        "count": 797692
      },
      {
        "id": "10.13140",
        "title": "10.13140",
        "count": 771107
      },
      {
        "id": "10.5517",
        "title": "10.5517",
        "count": 764938
      },
      {
        "id": "10.5169",
        "title": "10.5169",
        "count": 758570
      },
      {
        "id": "10.15156",
        "title": "10.15156",
        "count": 675463
      },
      {
        "id": "10.5281",
        "title": "10.5281",
        "count": 609722
      },
      {
        "id": "10.15468",
        "title": "10.15468",
        "count": 547861
      },
      {
        "id": "10.25549",
        "title": "10.25549",
        "count": 446165
      },
      {
        "id": "10.3932",
        "title": "10.3932",
        "count": 434457
      },
      {
        "id": "10.7916",
        "title": "10.7916",
        "count": 404859
      },
      {
        "id": "10.12764",
        "title": "10.12764",
        "count": 373236
      },
      {
        "id": "10.7910",
        "title": "10.7910",
        "count": 308551
      }
    ],
    "schemaVersions": [{
        "id": "3",
        "title": "Schema 3",
        "count": 9033486
      },
      {
        "id": "4",
        "title": "Schema 4",
        "count": 5938542
      },
      {
        "id": "2.2",
        "title": "Schema 2.2",
        "count": 1179453
      },
      {
        "id": "2.1",
        "title": "Schema 2.1",
        "count": 7582
      }
    ],
    "sources": [{
        "id": "mds",
        "title": "Mds",
        "count": 3903491
      },
      {
        "id": "legacy",
        "title": "Legacy",
        "count": 111233
      },
      {
        "id": "ez",
        "title": "Ez",
        "count": 86898
      },
      {
        "id": "fabrica",
        "title": "Fabrica",
        "count": 12458
      },
      {
        "id": "fabricaForm",
        "title": "Fabrica Form",
        "count": 1974
      }
    ],
    "linkChecksStatus": [{
        "id": "200",
        "title": "200",
        "count": 213000
      },
      {
        "id": "404",
        "title": "404",
        "count": 2735
      },
      {
        "id": "400",
        "title": "400",
        "count": 846
      },
      {
        "id": "429",
        "title": "429",
        "count": 836
      },
      {
        "id": "403",
        "title": "403",
        "count": 577
      },
      {
        "id": "500",
        "title": "500",
        "count": 477
      },
      {
        "id": "503",
        "title": "503",
        "count": 208
      },
      {
        "id": "401",
        "title": "401",
        "count": 61
      },
      {
        "id": "502",
        "title": "502",
        "count": 30
      },
      {
        "id": "410",
        "title": "410",
        "count": 29
      },
      {
        "id": "504",
        "title": "504",
        "count": 2
      },
      {
        "id": "408",
        "title": "408",
        "count": 1
      }
    ],
    "linksChecked": 77854,
    "linksWithSchemaOrg": [{
        "id": "0",
        "title": "0",
        "count": 230056
      },
      {
        "id": "1",
        "title": "1",
        "count": 16527
      }
    ],
    "linkChecksSchemaOrgId": 10898,
    "linkChecksDcIdentifier": 49202,
    "linkChecksCitationDoi": 0,
    "subjects": [{
        "id": "Plant Genetic Resource for Food and Agriculture",
        "title": "Plant Genetic Resource For Food And Agriculture",
        "count": 804370
      },
      {
        "id": "Crystallography",
        "title": "Crystallography",
        "count": 764946
      },
      {
        "id": "Cell Parameters",
        "title": "Cell Parameters",
        "count": 764807
      },
      {
        "id": "Crystal System",
        "title": "Crystal System",
        "count": 764807
      },
      {
        "id": "Space Group",
        "title": "Space Group",
        "count": 764807
      },
      {
        "id": "Crystal Structure",
        "title": "Crystal Structure",
        "count": 764729
      },
      {
        "id": "Experimental 3D Coordinates",
        "title": "Experimental 3 D Coordinates",
        "count": 764688
      },
      {
        "id": "biodiversity",
        "title": "Biodiversity",
        "count": 509050
      },
      {
        "id": "GBIF",
        "title": "Gbif",
        "count": 500120
      },
      {
        "id": "species occurrences",
        "title": "Species Occurrences",
        "count": 500087
      },
      {
        "id": "69999 Biological Sciences not elsewhere classified",
        "title": "69999 Biological Sciences Not Elsewhere Classified",
        "count": 303719
      },
      {
        "id": "Medicine",
        "title": "Medicine",
        "count": 255970
      },
      {
        "id": "Genetics",
        "title": "Genetics",
        "count": 245211
      },
      {
        "id": "Strain-linked information about bacterial and archaeal biodiversity",
        "title": "Strain Linked Information About Bacterial And Archaeal Biodiversity",
        "count": 238459
      },
      {
        "id": "Molecular Biology",
        "title": "Molecular Biology",
        "count": 208642
      }
    ]
  },
  "links": {
    "self": "https://api.datacite.org/dois",
    "next": "https://api.datacite.org/dois?page%5Bcursor%5D=1549482093000&page%5Bsize%5D=25"
  }
}

To save space, we have truncated the response to show only two records in this list and to show only the resource type meta counts.

👍

What's in the response?

The REST API response includes all metadata in JSON format.

What kinds of lists can I ask for?

There are many other resources in the API (see table below) and all of them can be retrieved in the same fashion. Major resource components supported by the DataCite API are (in alphabetical order) presented below and can be used alone like this:

ResourceDescription
/clientsreturns a list of all DataCite clients
/doisreturns a list of all dois (datasets, text documents, etc.)
/eventsreturns a list of all events from the DataCite Event Data service
/prefixesreturns a list of all DOI prefixes
/providersreturns a list of all DataCite providers
/reportsreturns a list of all usage reports

Results of queries are also returned as lists. The next section of this guide (Queries and Filtering) will cover making and filtering queries.

Updated 6 months ago

Retrieving a list of DOIs


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.