PHPackages                             lupasearch/lupasearch-php-client - 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. lupasearch/lupasearch-php-client

ActiveLibrary[API Development](/categories/api)

lupasearch/lupasearch-php-client
================================

LupaSearch API PHP Client

0.6.0(1mo ago)020.7k↓37.5%32MITPHPPHP ^7.2 || ^8.0

Since Mar 23Pushed 1mo agoCompare

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

READMEChangelogDependencies (2)Versions (11)Used By (2)

LupaSearch API PHP Client
=========================

[](#lupasearch-api-php-client)

- Current client version: v0.6.0
- Supports PHP ^7.2

Getting Started
---------------

[](#getting-started)

### Authentication and authorization

[](#authentication-and-authorization)

Initiate client object and set the API key for authorization (recommended).

```
$client = new \LupaSearch\LupaClient();
$client->setApiKey("your_api_key_here");

```

Alternatively, you can use email and password credentials for authentication and JWT token for authorization.

```
$client = new \LupaSearch\LupaClient();
$client
    ->setEmail('account@search.com')
    ->setPassword('password')
    ->authenticate();

```

### Data indexing

[](#data-indexing)

Import documents into search index:

```
$indexId = '7a31899f-31bc-46ac-b782-a44d71c5d622';
$documents = [
    'documents' => [
        [
            'id' => 1,
            'name' => 'Bag',
            'category' => 'Bags'
        ],
        [
            'id' => '2',
            'name' => 'Glasses',
            'price' => 9.99,
            'category' => 'Accessories'
        ]
    ]
];

$lupaDocumentsApi = new \LupaSearch\Api\DocumentsApi($client);
$importResponse = $lupaDocumentsApi->importDocuments(
    $indexId,
    $documents
);

```

Track progress of asynchronous tasks:

```
$lupaTasksApi = new \LupaSearch\Api\TasksApi($client);
$tasks = $lupaTasksApi->getTasks($indexId, [
    'batchKey' => $importResponse['batchKey']
]);

```

### Search

[](#search)

Send search request:

```
$publicQueryKey = 'qraljpj1reo9';
$lupaPublicQueriesApi = new \LupaSearch\Api\PublicQueryApi($client);
$searchResponse = $lupaPublicQueriesApi->search($queryKey, [
    'searchText' => '',
    'filters' => ['category' => ['Accessories']]
]);

```

### Facets

[](#facets)

Send facet retrieval request:

```
$publicQueryKey = 'qraljpj1reo9';
$lupaPublicQueriesApi = new \LupaSearch\Api\PublicQueryApi($client);
$facetsResponse = $lupaPublicQueriesApi->getFacets($publicQueryKey, [
    'searchText' => '',
    'filters' => ['category' => ['Accessories']]
]);

```

Resources
---------

[](#resources)

- [Swagger API](https://api.lupasearch.com/docs/)
- [LupaSearch documentation](https://console.lupasearch.com/docs/getting-started/overview)

###  Health Score

48

—

FairBetter than 95% of packages

Maintenance89

Actively maintained with recent releases

Popularity28

Limited adoption so far

Community16

Small or concentrated contributor base

Maturity50

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 83.3% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~182 days

Recently: every ~201 days

Total

9

Last Release

56d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/e731dcdb8b5eb320746e071e16e6dc71c6403eb1e2ab874485900ad476adfa7b?d=identicon)[aurzal](/maintainers/aurzal)

---

Top Contributors

[![aurzal](https://avatars.githubusercontent.com/u/101714175?v=4)](https://github.com/aurzal "aurzal (15 commits)")[![aivaras-ciurlionis](https://avatars.githubusercontent.com/u/17146643?v=4)](https://github.com/aivaras-ciurlionis "aivaras-ciurlionis (1 commits)")[![altdovydas](https://avatars.githubusercontent.com/u/8860049?v=4)](https://github.com/altdovydas "altdovydas (1 commits)")[![mzukauskas](https://avatars.githubusercontent.com/u/83348072?v=4)](https://github.com/mzukauskas "mzukauskas (1 commits)")

### Embed Badge

![Health badge](/badges/lupasearch-lupasearch-php-client/health.svg)

```
[![Health](https://phpackages.com/badges/lupasearch-lupasearch-php-client/health.svg)](https://phpackages.com/packages/lupasearch-lupasearch-php-client)
```

###  Alternatives

[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[convertkit/convertkitapi

Kit PHP SDK for the Kit API

2167.1k1](/packages/convertkit-convertkitapi)[mapado/rest-client-sdk

Rest Client SDK for hydra API

1125.9k2](/packages/mapado-rest-client-sdk)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)