CrossRef Local

Getting Started

  • Installation
    • Requirements
    • Install from PyPI
    • Install from Source
    • Database Setup
    • HTTP Mode (No Local Database)
    • Verify Installation
  • Quickstart
    • Python API
      • Basic Search
      • Get by DOI
      • HTTP Mode
    • Command Line Interface
      • Search
      • Get by DOI
      • HTTP Relay Server
      • MCP Server
    • Environment Variables

User Guide

  • CLI Reference
    • Global Options
    • Commands
      • search
      • search-by-doi
      • status
      • relay
    • MCP Commands
      • mcp start
      • mcp tools
      • list-apis
  • HTTP API Reference
    • Starting the Server
    • Endpoints
      • Root
      • Health Check
      • Database Info
      • Search Works
      • Get Work by DOI
      • Batch Lookup
    • Citations
      • Get Citing Papers
      • Get Cited Papers
      • Citation Count
      • Citation Network
    • FTS5 Query Syntax

API Reference

  • crossref_local API
    • Main Functions
      • search()
      • get()
      • get_many()
      • count()
      • exists()
      • configure()
      • configure_http()
      • enrich()
      • enrich_dois()
      • get_mode()
      • info()
    • Data Classes
      • Work
      • SearchResult
CrossRef Local
  • Search

© Copyright 2025, Yusuke Watanabe.

Built with Sphinx using a theme provided by Read the Docs.