Skip to main content

EZID introduces a batch download feature

EZID has just implemented a feature allowing clients to download a copy of all or some of their identifiers and descriptive information (i.e. metadata). We call it “batch” download, because EZID returns all requested identifiers in one large file. Clients can actually download everything they own or just a subset, such as only their DOIs or only their test identifiers.

Concrete Batch
Image courtesy of Fresno County Public LibraryInitially, the feature is available only via EZID’s application programming interface (API).


Unlike the OAI-PMH interface (described here) that only returns public identifiers, batch download is aimed at clients retrieving all identifiers and metadata that they own. To use batch download, you must have a valid EZID login account. With the account, you can request anything that you own:

  • real and test  identifiers
  • public and private identifiers
  • identifiers with or without metadata
  • identifiers with or without an external-facing target URL
  • DOIs and ARKs

As a reminder, the term “target URL” means the digital location of the resource being registered with an identifier. DOIs are digital object identifiers, commonly used in scholarly communication. ARKs are archival research keys, in use by a wide range of researchers, museums and libraries. EZID clients have registered roughly twice as many ARKs as DOIs, for a total of just over 3 million identifiers.

For any client, the number of identifiers such an inquiry may retrieve will depend on number of identifiers they own, as well as the specific request submitted. Some clients have registered very few identifiers, and others have created many thousands. The download will retrieve a file in one of several formats suitable for analysis in common tools, such as CSV (comma separated value), XML (extensible markup language), and ANVL (a name-value language). We believe batch download will enable new opportunities for clients to manage their identifiers and metadata.

More details about the interface are available here. Let us know if you have questions.