OpenAlex Local

Getting Started

  • Installation
    • Requirements
    • Install from PyPI
    • Install from Source
    • Database Setup
    • HTTP Mode (No Local Database)
    • Verify Installation
    • Environment Variables
  • Quickstart
    • Python API
      • Basic Search
      • Get by ID or DOI
      • Work Attributes
      • Configuration
    • CLI Usage
    • MCP Integration

User Guide

  • CLI Reference
    • Main Commands
      • openalex-local
      • search
      • search-by-doi
      • relay
    • MCP Commands
      • mcp start
      • mcp doctor
      • mcp installation
      • mcp list-tools
  • HTTP API Reference
    • Starting the Server
    • Endpoints
      • Root
      • Health Check
      • Database Info
      • Search Works
      • Get Work by ID
      • Batch Lookup
    • FTS5 Query Syntax
    • Python Client
    • Environment Variables

API Reference

  • openalex_local API
    • search()
    • count()
    • get()
    • get_many()
    • exists()
    • info()
    • enrich()
    • enrich_ids()
    • configure()
    • get_mode()
    • Work
      • Work.openalex_id
      • Work.doi
      • Work.title
      • Work.abstract
      • Work.authors
      • Work.year
      • Work.source
      • Work.issn
      • Work.volume
      • Work.issue
      • Work.pages
      • Work.publisher
      • Work.type
      • Work.concepts
      • Work.topics
      • Work.cited_by_count
      • Work.referenced_works
      • Work.is_oa
      • Work.oa_url
      • Work.openalex_id
      • Work.doi
      • Work.title
      • Work.abstract
      • Work.authors
      • Work.year
      • Work.source
      • Work.issn
      • Work.volume
      • Work.issue
      • Work.pages
      • Work.publisher
      • Work.type
      • Work.concepts
      • Work.topics
      • Work.cited_by_count
      • Work.referenced_works
      • Work.is_oa
      • Work.oa_url
      • Work.scitex_if
      • Work.source_h_index
      • Work.source_cited_by_count
      • Work.from_openalex()
      • Work.from_db_row()
      • Work.to_dict()
      • Work.citation()
      • Work._citation_apa()
      • Work._format_author_apa()
      • Work._citation_bibtex()
      • Work.to_text()
      • Work.save()
      • Work.__init__()
    • SearchResult
      • SearchResult.works
      • SearchResult.total
      • SearchResult.query
      • SearchResult.elapsed_ms
      • SearchResult.works
      • SearchResult.total
      • SearchResult.query
      • SearchResult.elapsed_ms
      • SearchResult.save()
      • SearchResult.__init__()
    • save()
    • Core Functions
      • search
        • search()
      • get
        • get()
      • count
        • count()
      • info
        • info()
    • Configuration
      • configure
        • configure()
      • configure_http
      • get_mode
        • get_mode()
    • Data Classes
      • Work
        • Work
      • SearchResult
        • SearchResult
      • Config
OpenAlex Local
  • Search


© Copyright 2025, Yusuke Watanabe.

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