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
    • Core Functions
      • search
        • search()
      • get
        • get()
      • count
        • count()
      • info
        • info()
    • Configuration
      • configure
        • configure()
      • get_mode
        • get_mode()
    • Data Classes
      • Work
        • Work
      • SearchResult
        • SearchResult
      • Config
        • Config
OpenAlex Local
  • Search

© Copyright 2025, Yusuke Watanabe.

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