Our REST API is largely used for retrieval of metadata by machines. But, there are some manual queries that can be performed by you or me to retrieve metadata. Let’s take a look at a common question of the support team from a member looking for information about her colleagues:
I work at the Science State University and I am trying to learn how to use the Crossref API in order to retrieve data about the publications of the researchers of my institution.
In particular, I would like to retrieve the list of the publications of at least one author affiliated to Science State University. Could you please help me with this?
I always like starting with a straightforward query like this: https://api.crossref.org/works?query.affiliation=Science+State+University&select=DOI,title,firstname.lastname@example.org
In this query, I am searching our whole corpus for any affiliation that includes the word Science or State or University; I am limiting the metadata that is returned to me for each DOI to:
- title of the work
- the contributor/author list for that DOI
The results are in order of relevance to the query affiliation, so the top results will have a higher match or relevance score for the words Science+State+University than the results down the page. By adding my email address, I can identify myself and thus access the Polite pool of the REST API (you can omit it, if you need to stay anonymous, which will result in querying our Public pool).
Let’s say that I also want the cited-by counts of those same DOIs that I received in my results above. I’d simply add the
is-reference-by-count parameter to my query:
We, Crossref staff, keep a list of some of the more useful queries that members and metadata users have sent to or requested of us. I thought it worthwhile to share these with you. You’ll see those below with a brief explanation of the query. It’s also important to note that, if you’re interested in getting started with constructing your own REST API queries, you can use the functionality with our REST API documentation (Swagger) to assist.
Some of the more common REST API query requests we see:
All works on a particular prefix: https://api.crossref.org/prefixes/10.35195/works
Article titles on a particular prefix: https://api.crossref.org/prefixes/10.35195/works?select=DOI,title
If you want the journal title too, it’s: https://api.crossref.org/prefixes/10.35195/works?select=DOI,container-title,title
Which DOIs for a specific prefix have license information deposited for them?
https://api.crossref.org/prefixes/10.1098/works?filter=has-license:true&rows=300 (300 results at a time)
All works by title for a prefix:
All works for this ISSN sorted with these elements DOI, title, volume, issue and page number (first 20 results returned):
All works for this ISSN sorted with these elements DOI, title, volume, issue and page number (first 1000 results returned):
All works registered with a specific ORCID iD:
All works registered with a specific ORCID iD with results sorted with only the following metadata: DOI, title, and citation count:
All chapter-level DOIs registered against an ISBN with the results sorted with elements DOI, title, type, container (book-level) title, links, and ISBN:
List of DOI counts registered against a prefix and the type of content registered for those DOI counts:
What is the most recently deposited DOI that has been indexed in the REST API on a particular prefix Today: https://api.crossref.org/prefixes/10.1021/works?filter=from-created-date:2021-05-14,until-created-date:2021-05-14&sort=deposited&order=desc
Show me who is registering grants:
List of top 10 (and, 1000) most-cited DOIs for a prefix (results limited to DOI, title, and citation count):
Works created between two dates:
All DOIs registered with the isTranslationOf relation: https://api.crossref.org/works?filter=relation.type:is-translation-of
I should also note, if you are eager to get started with manual queries and you do not have a JSON formatter installed in the browser of your choice, now might be the time to reconsider that. I use this extension for Google Chrome, but there are other extensions and other browsers, so I encourage you to find one that is right for you: JSON Formatter - Chrome Web Store
Let us know what you think. Thanks for reading!