WOLFRAM

Wolfram Language & System Documentation Center
"CrossRef" (Service Connection)

"CrossRef" (Service Connection)

Connect to the CrossRef API to search for journal articles and other scholarly works, using the Wolfram Language.

Connecting & Authenticating

ServiceConnect["CrossRef"] creates a connection to the CrossRef API. If a previously saved connection can be found, it will be used; otherwise, a new authentication request will be launched.

Requests

ServiceExecute["CrossRef","request",params] sends a request to the CrossRef API, using parameters params. The following gives possible requests.

Search Articles and Other Works

"WorkList" — a List of works matching search criteria

"WorkDataset" — a Dataset of works matching search criteria

Parameters:
  • "Query"Nonequery terms
    MaxItems20maximum results to return
    "StartIndex"0index of first search result to return
    "SortBy"Nonefield to sort by ("Score", "Relevance", "Updated", "Deposited", "Indexed", "Published")
    "FunderID"Nonefilter works by funder
    "TypeID"Nonefilter works by type
    "OwnerPrefix"Nonefilter works by owner prefix
    "MemberID"Nonefilter works by member
    "ISSN"Nonefilter works by journal ISSN
    "IssuedDate"Nonedate or date interval of publication
    "DepositedDate"Nonedate or date interval for work deposit
    "IndexedDate"Nonedate or date interval for work index
    "UpdatedDate"Nonedate or date interval for work update
    "License"Nonelicense URL
    "HasFullText"Nonewhether to return only works with full text available

    • Search Funders

    "FunderList" — a List of funders matching some criteria

    "FunderDataset" — a Dataset of funders matching some criteria

    Parameters:
  • "Query"Nonequery terms
    MaxItems20results per page
    "StartIndex"0results offset

    • Search Members

    "MemberList" — a List of members matching some criteria

    "MemberDataset" — a Dataset of members matching some criteria

    Parameters:
  • "Query"Nonequery terms
    MaxItems20results per page
    "StartIndex"0results offset
    "OwnerPrefix"Nonefilter members by owner prefix

    • Search Journals

    "JournalList" — a List of journals matching some criteria

    "JournalDataset" — a Dataset of journals matching some criteria

    Parameters:
  • "Query"Nonequery terms
    MaxItems20results per page
    "StartIndex"0results offset

    • Search Licenses

    "LicenseList" — a List of licenses matching some criteria

    "LicenseDataset" — a Dataset of licenses matching some criteria

    Parameters:
  • "Query"Nonequery terms
    MaxItems20results per page

    • List Work Types

    "WorkTypes" — a List of work types

    Work Details

    "WorkInformation" — detailed information for the specified CrossRef DOI

    Parameters:
  • "DOI"(required)DOI

    • Funder Details

    "FunderInformation" — detailed information for a specified funder and its suborganizations

    Parameters:
  • "FunderID"(required)funder ID

    • Owner Prefix Details

    "OwnerPrefixInformation" — detailed information for the DOI owner prefix

    Parameters:
  • "OwnerPrefix"(required)owner prefix

    • Member Details

    "MemberInformation" — detailed information for a CrossRef member

    Parameters:
  • "MemberID"(required)member ID

    • Work Type Details

    "TypeInformation" — information about a work type

    Parameters:
  • "TypeID"(required)type ID

    • Journal Details

    "JournalInformation" — information about a journal with the given ISSN

    Parameters:
  • "ISSN"(required)ISSN

    • Examples

    open all close all

    Basic Examples  (1)

    Create a new connection by launching an authentication dialog:

    Wolfram Language code: crossref = ServiceConnect["CrossRef"]

    Search journal articles by keyword:

    Wolfram Language code: works = crossref["WorksDataset", <|"Query" -> "genome project", "TypeID" -> "journal-article", "SortBy" -> "Score", MaxItems -> 20|>];
    Wolfram Language code: works[1]

    Paginate over search results:

    Wolfram Language code: results = ServiceExecute["CrossRef", "WorksList", <|"Query" -> "genome project", "SortBy" -> "Score", MaxItems -> 1000, "StartIndex" -> 1000|>]

    Information about a specific work:

    Wolfram Language code: ServiceExecute["CrossRef", "WorkInformation", <|"DOI" -> results[[1]]["DOI"]|>]

    Scope  (1)

    Search works published in a certain date range:

    Wolfram Language code: works = ServiceExecute["CrossRef", "WorksDataset", <|"Query" -> "biology", "IssuedDate" -> {DateObject[{2014, 9, 10}], DateObject[{2015, 9, 10}]}|>]; works[3]
    Wolfram Language code: works[All, "Issued"]//Normal//Union

    Search members:

    Wolfram Language code: members = ServiceExecute["CrossRef", "MemberDataset", <|"Query" -> "biology", MaxItems -> 5|>]

    Search journals:

    Wolfram Language code: journals = ServiceExecute["CrossRef", "JournalDataset", <|"Query" -> "medicine", MaxItems -> 5|>]

    Search works by ISSN:

    Wolfram Language code: works = ServiceExecute["CrossRef", "WorksDataset", <|"ISSN" -> journals[1, "ISSN"][[1]], MaxItems -> 10|>];
    Wolfram Language code: works[[6]]