Python Elasticsearch client
  • Elasticsearch API
  • DSL
  • Helpers
  • Exceptions & Warnings

Async

  • Async Elasticsearch API
  • Async DSL
  • Async Helpers
Python Elasticsearch client
  • Python Elasticsearch Client
  • View page source

Python Elasticsearch Client

Welcome to the API documentation of the official Python client for Elasticsearch! The goal of this client is to provide common ground for all Elasticsearch-related code in Python; because of this it tries to be opinion-free and very extendable.

High-level documentation for this client is also available.

  • Elasticsearch API
    • Elasticsearch
    • Async Search
    • Autoscaling
    • Cat
    • Cross-Cluster Replication (CCR)
    • Cluster
    • Connector
    • Dangling Indices
    • Enrich Policies
    • Event Query Language (EQL)
    • ES|QL
    • Fleet
    • Graph Explore
    • Index Lifecycle Management (ILM)
    • Indices
    • Inference
    • Ingest Pipelines
    • License
    • Logstash
    • Migration
    • Machine Learning (ML)
    • Monitoring
    • Nodes
    • Query rules
    • Rollup Indices
    • Search Applications
    • Searchable Snapshots
    • Security
    • Shutdown
    • Simulate
    • Snapshot Lifecycle Management (SLM)
    • Snapshots
    • Snapshottable Features
    • SQL
    • Synonyms
    • TLS/SSL
    • Tasks
    • Text Structure
    • Transforms
    • Watcher
    • X-Pack
  • DSL
    • Search
    • Multi-Search
    • Document
    • Index
    • Mapping
    • Faceted Search
    • Update by Query
  • Helpers
    • Streaming Bulk
    • Parallel Bulk
    • Bulk
    • Scan
    • Reindex
  • Exceptions & Warnings
    • API Errors
    • Transport and Connection Errors
    • Warnings

Async

  • Async Elasticsearch API
    • Elasticsearch
  • Async DSL
    • Search
    • Multi-Search
    • Document
    • Index
    • Mapping
    • Faceted Search
    • Update by Query
  • Async Helpers
    • Streaming Bulk
    • Bulk
    • Scan
    • Reindex

License

Copyright 2023 Elasticsearch B.V. Licensed under the Apache License, Version 2.0.

Indices and tables

  • Index

  • Module Index

  • Search Page

Next

© Copyright 2025, Elasticsearch B.V.

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