PHPackages                             meilisearch/meilisearch-php - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. meilisearch/meilisearch-php

ActiveLibrary[API Development](/categories/api)

meilisearch/meilisearch-php
===========================

PHP wrapper for the Meilisearch API

v1.16.1(8mo ago)74513.7M—2.7%117[38 issues](https://github.com/meilisearch/meilisearch-php/issues)[16 PRs](https://github.com/meilisearch/meilisearch-php/pulls)20MITPHPPHP ^7.4 || ^8.0CI passing

Since Jan 7Pushed 3w ago9 watchersCompare

[ Source](https://github.com/meilisearch/meilisearch-php)[ Packagist](https://packagist.org/packages/meilisearch/meilisearch-php)[ RSS](/packages/meilisearch-meilisearch-php/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (11)Versions (101)Used By (20)

 [![Meilisearch-PHP](https://raw.githubusercontent.com/meilisearch/integration-guides/main/assets/logos/meilisearch_php.svg)](https://raw.githubusercontent.com/meilisearch/integration-guides/main/assets/logos/meilisearch_php.svg)

Meilisearch PHP
===============

[](#meilisearch-php)

####  [Meilisearch](https://github.com/meilisearch/meilisearch) | [Meilisearch Cloud](https://www.meilisearch.com/cloud?utm_campaign=oss&utm_source=github&utm_medium=meilisearch-php) | [Documentation](https://www.meilisearch.com/docs) | [Discord](https://discord.meilisearch.com) | [Roadmap](https://roadmap.meilisearch.com/tabs/1-under-consideration) | [Website](https://www.meilisearch.com) | [FAQ](https://www.meilisearch.com/docs/faq)

[](#--meilisearch---meilisearch-cloud---documentation---discord---roadmap---website---faq)

 [![Codecov coverage](https://camo.githubusercontent.com/81006dba069867491b5623ec30c842d1288d10f1c848223494cc721d96e72913/68747470733a2f2f636f6465636f762e696f2f67682f6d65696c697365617263682f6d65696c697365617263682d7068702f6272616e63682f6d61696e2f67726170682f62616467652e737667)](https://codecov.io/gh/meilisearch/meilisearch-php/branch/main) [![Latest Stable Version](https://camo.githubusercontent.com/ac00e69993e9172d34edc09ade09894eb5f1c5c7736c76b352ac428d33e85952/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6d65696c697365617263682f6d65696c697365617263682d706870)](https://packagist.org/packages/meilisearch/meilisearch-php) [![Test](https://github.com/meilisearch/meilisearch-php/workflows/Tests/badge.svg)](https://github.com/meilisearch/meilisearch-php/actions) [![License](https://camo.githubusercontent.com/221ae99f391396653ec4cf4158e721ec628894184f54dd612610bb095a02125c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d696e666f726d6174696f6e616c)](https://github.com/meilisearch/meilisearch-php/blob/main/LICENSE)

⚡ The Meilisearch API client written for PHP 🐘

**Meilisearch PHP** is the Meilisearch API client for PHP developers.

**Meilisearch** is an open-source search engine. [Learn more about Meilisearch.](https://github.com/meilisearch/Meilisearch)

Table of Contents
------------------

[](#table-of-contents-)

- [📖 Documentation](#-documentation)
- [🔧 Installation](#-installation)
- [🚀 Getting started](#-getting-started)
- [🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch)
- [💡 Learn more](#-learn-more)
- [🧰 HTTP Client Compatibilities](#-http-client-compatibilities)
    - [Customize your HTTP Client](#customize-your-http-client)
- [⚙️ Contributing](#%EF%B8%8F-contributing)

📖 Documentation
---------------

[](#-documentation)

To learn more about Meilisearch PHP, refer to the in-depth [Meilisearch PHP Documentation](https://php-sdk.meilisearch.com). To learn more about Meilisearch in general, refer to our [documentation](https://www.meilisearch.com/docs/learn/getting_started/quick_start) or our [API reference](https://www.meilisearch.com/docs/reference/api/overview).

🔧 Installation
--------------

[](#-installation)

To get started, simply require the project using [Composer](https://getcomposer.org/).
You will also need to install packages that "provide" [`psr/http-client-implementation`](https://packagist.org/providers/psr/http-client-implementation) and [`psr/http-factory-implementation`](https://packagist.org/providers/psr/http-factory-implementation).
A list with compatible HTTP clients and client adapters can be found at [php-http.org](http://docs.php-http.org/en/latest/clients.html).

**If you don't know which HTTP client to use, we recommend using Guzzle 7**:

```
composer require meilisearch/meilisearch-php guzzlehttp/guzzle http-interop/http-factory-guzzle:^1.0
```

Here is an example of installation with the `symfony/http-client`:

```
composer require meilisearch/meilisearch-php symfony/http-client nyholm/psr7:^1.0
```

💡 *More HTTP client installations compatible with this package can be found [in this section](#-http-client-compatibilities).*

### Run Meilisearch

[](#run-meilisearch-)

⚡️ **Launch, scale, and streamline in minutes with Meilisearch Cloud**—no maintenance, no commitment, cancel anytime. [Try it free now](https://cloud.meilisearch.com/login?utm_campaign=oss&utm_source=github&utm_medium=meilisearch-php).

🪨 Prefer to self-host? [Download and deploy](https://www.meilisearch.com/docs/learn/self_hosted/getting_started_with_self_hosted_meilisearch?utm_campaign=oss&utm_source=github&utm_medium=meilisearch-php) our fast, open-source search engine on your own infrastructure.

🚀 Getting started
-----------------

[](#-getting-started)

#### Add documents

[](#add-documents-)

```