Meilisearch Dart

Meilisearch | Documentation | Slack | Roadmap | Website | FAQ

Pub Version GitHub Workflow Status License Bors enabled

⚡ The Meilisearch API client written in Dart

Meilisearch Dart is the Meilisearch API client for Dart and Flutter developers.

Meilisearch is an open-source search engine. Discover what Meilisearch is!

Table of Contents <!-- omit in toc -->

📖 Documentation

See our Documentation or our API References.

🔧 Installation

You can install the meilisearch package by adding a few lines into pubspec.yaml file.

  meilisearch: ^0.6.0

Then open your terminal and update dart packages.

pub get

Run Meilisearch <!-- omit in toc -->

There are many easy ways to download and run a Meilisearch instance.

For example, using the curl command in your Terminal:

#Install Meilisearch
curl -L | sh

# Launch Meilisearch
./meilisearch --master-key=masterKey

NB: you can also download Meilisearch from Homebrew or APT or even run it using Docker.

🚀 Getting Started

Add Documents <!-- omit in toc -->

import 'package:meilisearch/meilisearch.dart';

void main() async {
  var client = MeiliSearchClient('', 'masterKey');

  // An index is where the documents are stored.
  var index = client.index('movies');

  const documents = [
    { 'id': 1, 'title': 'Carol', 'genres': ['Romance', 'Drama'] },
    { 'id': 2, 'title': 'Wonder Woman', 'genres': ['Action', 'Adventure'] },
    { 'id': 3, 'title': 'Life of Pi', 'genres': ['Adventure', 'Drama'] },
    { 'id': 4, 'title': 'Mad Max: Fury Road', 'genres': ['Adventure', 'Science Fiction'] },
    { 'id': 5, 'title': 'Moana', 'genres': ['Fantasy', 'Action']},
    { 'id': 6, 'title': 'Philadelphia', 'genres': ['Drama'] },

  // If the index 'movies' does not exist, Meilisearch creates it when you first add the documents.
  var task = await index.addDocuments(documents); // => { "uid": 0 }

With the uid, you can check the status (enqueued, processing, succeeded or failed) of your documents addition using the task.

Basic Search <!-- omit in toc -->

// Meilisearch is typo-tolerant:
var result = await'carlo');


JSON Output:

    "id": 1,
    "title": "Carol",
    "genres": ["Romance", "Drama"]

Custom Search <!-- omit in toc -->

All the supported options are described in the search parameters section of the documentation.

var result = await
  attributesToHighlight: ['title'],

JSON output:

    "hits": [
            "id": 1,
            "title": "Carol",
            "_formatted": {
                "id": 1,
                "title": "<em>Carol</em>"
    "offset": 0,
    "limit": 20,
    "processingTimeMs": 0,
    "query": "carol"

Custom Search With Filters <!-- omit in toc -->

If you want to enable filtering, you must add your attributes to the filterableAttributes index setting.

await index.updateFilterableAttributes(['id', 'genres']);

You only need to perform this operation once.

Note that MeiliSearch will rebuild your index whenever you update filterableAttributes. Depending on the size of your dataset, this might take time. You can track the process using the task status.

Then, you can perform the search:

await'wonder', filter: ['id > 1 AND genres = Action']);
  "hits": [
      "id": 2,
      "title": "Wonder Woman",
      "genres": ["Action","Adventure"]
  "offset": 0,
  "limit": 20,
  "estimatedTotalHits": 1,
  "processingTimeMs": 0,
  "query": "wonder"

🤖 Compatibility with Meilisearch

This package only guarantees the compatibility with the version v0.28.0 of Meilisearch.

💡 Learn More

The following sections may interest you:

⚙️ Development Workflow and Contributing

Any new contribution is more than welcome in this project!

If you want to know more about the development workflow or want to contribute, please visit our contributing guidelines for detailed instructions!

Meilisearch provides and maintains many SDKs and Integration tools like this one. We want to provide everyone with an amazing search experience for any kind of project. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the integration-guides repository.