Crossref API Reference

class crossref.CrossRefAPIClient(api_host='https://api.crossref.org', api_version='v1', api_auth_token=None, api_mailto=None)[source]

Bases: object

get(path: str, params: Optional[dict] = None, headers: dict = {})[source]

get_funder(funder_id: str)[source]

get_funder_works(funder_id: str, params: Optional[dict] = None)[source]

get_funders(params: Optional[dict] = None)[source]

get_journal(issn: str)[source]

get_journal_works(issn: str, params: Optional[dict] = None)[source]

get_journals(params: Optional[dict] = None)[source]

get_licenses(params: Optional[dict] = None)[source]

get_member(member_id: int)[source]

get_member_works(member_id: int, params: Optional[dict] = None)[source]

get_members(params: Optional[dict] = None)[source]

get_prefix_metadata(prefix_id: str)[source]

get_prefix_works(prefix_id: str, params: Optional[dict] = None)[source]

get_type(type_id: str)[source]

get_type_works(type_id: str, params: Optional[dict] = None)[source]

get_types(params: Optional[dict] = None)[source]

get_work(doi: str)[source]

get_work_reference(doi: str, style: str)[source]

get_works(params: Optional[dict] = None)[source]

property headers

property user_agent

crossref.backoff_hdlr(details)[source]

crossref.fatal_code(e)[source]

crossref.get_url(url, headers=None, params=None)[source]

crossref.giveup_hdlr(details)[source]

crossref.log_request_headers(r)[source]

crossref.crossref_cli.epilog(*args, **kwargs)[source]: Return Epilog.

crossref.crossref_cli.main()[source]: Main CLI EntryPoint.

crossref.crossref_cli.usage(args)[source]: Print Usage.

crossref.utils.create_api_client(args)[source]: Create an API Client.

crossref.utils.print_colored_json(formatted_json: str, format_on: bool = False, formatter=<pygments.formatters.terminal256.Terminal256Formatter object>)[source]: Print Colored JSON.

crossref.argument_checkers.funders_filter_type(arg_val, **kwargs)[source]: Validate –filter argument in funders command.

crossref.argument_checkers.works_facets_type(arg_val, **kwargs)[source]: Validate –facets arguments in pubs or works command.

crossref.argument_checkers.works_filter_type(arg_val, **kwargs)[source]: Validate –filter arguments in pubs or works command.

crossref.argument_checkers.works_query_fields_type(arg_val, **kwargs)[source]: Validate –query-filter arguments in pubs or works command.