Package selection guidance compiled from public package information, community data, and project usage.
The algolia_client_search package is a Dart/Flutter library designed for integrating Algolia's powerful search and discovery features into applications. It provides a clean, type-safe API to perform searches, manage indices, and handle autocomplete functionality across multiple platforms. Built as part of the AlgoliaSearch ecosystem, it enables developers to deliver fast, relevant, and scalable search experiences in Flutter apps. The package supports real-time results, faceting, and customizable ranking, making it ideal for e-commerce, content discovery, and app navigation.
Use cases
E-commerce product search
Content discovery in apps
Real-time autocomplete
User-driven filtering
App navigation with search
Dynamic content indexing
Key features
Fast, scalable search
Faceted search support
Autocomplete and typo tolerance
Index management API
Real-time result updates
Type-safe Dart interface
Suitable for
Flutter apps needing robust search
Developers using Algolia backend
Apps with large datasets
Projects requiring instant search
Teams prioritizing developer experience
Considerations
Requires Algolia account and API keys
Limited to Algolia’s infrastructure
Needs proper index configuration
May require additional setup for advanced features
Dependent on network connectivity
Original README
Original README snapshot from the linked source repository. Visit the repository for the latest content.
The perfect starting point to integrate Algolia within your Dart project
algoliasearch is a comprehensive Dart package that provides access to Algolia's robust search and insights features. It is an all-in-one solution designed to help you integrate Algolia within your Dart project seamlessly and efficiently.
The package currently offers the following clients:
Search Client: Allows you to leverage Algolia's search capabilities, including instant search results, search-as-you-type, and typo-tolerance.
Insights Client: Enables you to collect events related to your search and discovery experience, providing valuable insights into user behavior. With it, you can unlock powerful features such as recommendations, personalization, and smarter search results.
Search Lite Client: A lighter, search-only version of the library, perfect for projects that require search functionality without the need for features like indexing.
Future updates will include more clients to cover the entirety of Algolia's feature set, providing a complete toolset for building powerful, interactive search experiences in your Dart or Flutter application.
✨ Features
Low-Level HTTP Client: Provides a thin and minimal low-level HTTP client to interact directly with Algolia's API, giving you maximum control over your requests.
Cross-Platform Compatibility: Designed to work seamlessly on both native and web platforms, making it ideal for any Dart project.
Pure Dart Construction: Built with pure Dart for superior performance and maximum compatibility across Dart projects.
💡 Getting Started
Step 1: Add Dependency
To use this package in your project, add it as a dependency:
For Dart projects:
dart pub add algoliasearch
For Flutter projects:
flutter pub add algoliasearch
Step 2: Import the Package
You can now import the Algolia API client in your project and play with it.
import'package:algolia_client_search/algolia_client_search.dart';
// Alternatively, you can import `algoliasearch_lite`, a **search-only** version of the library, if you do not need the full feature set:// import 'package:algoliasearch/algoliasearch_lite.dart';final client = SearchClient(appId: 'YOUR_APP_ID', apiKey: 'YOUR_API_KEY');
// Add a new record to your Algolia indexfinal response = await client.saveObject(
indexName: "<YOUR_INDEX_NAME>",
body: {
'objectID': "id",
'test': "val",
},
);
// Poll the task status to know when it has been indexedawait client.waitTask('<YOUR_INDEX_NAME>', response.taskID);
// Fetch search results, with typo tolerancefinal response = await client.search(
searchMethodParams: SearchMethodParams(
requests: [
SearchForHits(
indexName: "<YOUR_INDEX_NAME>",
query: "<YOUR_QUERY>",
hitsPerPage: 50,
),
],
),
);
❓ Troubleshooting
Encountering an issue? Before reaching out to support, we recommend heading to our FAQ where you will find answers for the most common issues and gotchas with the client. You can also open a GitHub issue
Contributing
This repository hosts the code of the generated Algolia API client for Dart, if you'd like to contribute, head over to the main repository. You can also find contributing guides on our documentation website.
📄 License
The Algolia Dart API Client is an open-sourced software licensed under the MIT license.