---
id: opensearch-protobufs
version: "1.6.0"
license: Apache-2.0
license_treatment: permissive
maintenance: active
---

# opensearch-protobufs

License: permissive · Maintenance: active · Downloads: 14.5M/mo

## What it is and what it does

opensearch-protobufs is a Python package containing pre-compiled Protocol Buffer message definitions and gRPC service stubs for OpenSearch. Instead of downloading raw `.proto` files and running protoc yourself, you install this package and import message types (like SearchRequest, BulkRequest, IndexDocumentRequest) and service clients (like SearchServiceStub) directly into your code.

The package is maintained as a downstream consumer of the opensearch-api-specification repository, meaning its protobuf definitions track the official API spec. It depends on protobuf and grpcio at runtime and requires Python 3.10 or later. It's intended for Python developers building OpenSearch clients or integrations who want to avoid the build-and-compile step and use stable, pre-generated gRPC bindings instead.

Use it for:

- Building a Python OpenSearch client library that uses gRPC for server communication.
- Integrating OpenSearch search and indexing operations into a Python application via pre-built protobuf message types.
- Rapid prototyping of OpenSearch-based services without needing to compile protobuf definitions locally.
- Ensuring API compatibility across multiple OpenSearch client libraries by using centrally maintained protobuf definitions.

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

Provides pre-generated Python Protocol Buffer message types and gRPC service stubs for OpenSearch client-server communication, eliminating the need to compile `.proto` files yourself.

Yes, if you are building a Python application that communicates with OpenSearch via gRPC and want to avoid managing protobuf compilation yourself. The package is actively maintained, has low install friction, carries a permissive Apache-2.0 license, and has no known vulnerabilities. Install it only if your project actually uses gRPC for OpenSearch communication.

## Install

pip install opensearch-protobufs
uv add opensearch-protobufs
poetry add opensearch-protobufs

## Installing opensearch-protobufs

Before you install: Low friction install with only two runtime dependencies (protobuf and grpcio). Active maintenance with recent releases; last commit 2026-08-14 and latest release 2026-06-11 indicate ongoing project activity.

License in practice: Apache-2.0 permissive license allows commercial and private use with minimal restrictions; you must include a copy of the license and note any modifications.

Quickstart:

pip install opensearch-protobufs

from opensearch.protobufs.schemas import SearchRequest
from opensearch.protobufs.services import SearchServiceStub

request = SearchRequest()
request.query = "elasticsearch"
request.size = 10

client = SearchServiceStub(channel)
response = client.Search(request)

Requires Python 3.10 or later; you must have a gRPC channel already established to use the service stubs.

Verify before relying:

- Whether the package includes all OpenSearch API operations or only a subset of the message types shown in examples.
- Whether generated code is kept in sync with the opensearch-api-specification automatically or requires manual updates.
- Performance characteristics or overhead of using pre-generated stubs versus compiling protobufs on-demand.

## Package facts

- License: Apache-2.0 (permissive)
- Python support: supports_current
- Install friction: low
- Maintenance: active
- Downloads: 14.5M/month (top 5,000 on PyPI)
- Known vulnerabilities: none known

## Tags

protobuf message types opensearch, grpc client stubs opensearch, opensearch protocol buffers python, opensearch api protobufs, pre-generated protobuf code, grpc, opensearch, protobuf

[View on SkillFed](https://skillfed.io/packages/opensearch-protobufs) · [View on PyPI](https://pypi.org/project/opensearch-protobufs/)