Crossref Search Filters

crossref module API:

  • filter_names
  • filter_details

Example usage:

from habanero import Crossref
cr = Crossref()
cr.filter_names()
cr.filter_details()

filters API

Crossref.filter_names(type='works')[source]

Filter names - just the names of each filter

Filters are used in the Crossref search API to modify searches. As filters are introduced or taken away, we may get out of sync; check the docs for the latest https://github.com/CrossRef/rest-api-doc

Parameters:type – [str] what type of filters, i.e., what API route, matches methods here. one of “works”, “members”, or “funders”. Default: “works”
Returns:list

Usage:

from habanero import Crossref
cr = Crossref()
cr.filter_names()
cr.filter_names("members")
cr.filter_names("funders")
Crossref.filter_details(type='works')[source]

Filter details - filter names, possible values, and description

Filters are used in the Crossref search API to modify searches. As filters are introduced or taken away, we may get out of sync; check the docs for the latest https://github.com/CrossRef/rest-api-doc

Parameters:type – [str] what type of filters, i.e., what API route, matches methods here. one of “works”, “members”, or “funders”. Default: “works”
Returns:dict

Usage:

from habanero import Crossref
cr = Crossref()
cr.filter_details()
cr.filter_details("members")
cr.filter_details("funders")
# Get descriptions for each filter
x = cr.filter_details()
[ z['description'] for z in x.values() ]