• Guides
  • API Reference API
  • Integrations
  • Log in
  • Sign up
  • Dashboard
Guides

Learn how Algolia works and how you can use it to create search and discovery experiences.

Home
Getting started
Sending and managing data
Managing results
Building Search UI
Building Search UI
Building Search UI
Building Search UI
Building Search UI
Building Search UI
Building Search UI
Sending events
Search analytics
Personalization
A/B testing
Algolia Recommend
Algolia AI
Going to production
Scaling
Security
Solutions
API clients
PHP
Ruby
JavaScript
Python
Swift
Kotlin
.NET
Java
Go
Scala
UI libraries
InstantSearch.js
React InstantSearch
Vue InstantSearch
Angular InstantSearch
InstantSearch iOS
InstantSearch Android
Algolia for Flutter
Autocomplete
Recommend
API parameters
Index settings and search parameters
REST API
A full reference of API endpoints
Crawler
Configuration API
Integrations

Speed up your implementation with Algolia's integrations and tools.

Web frameworks
Rails
Symfony
Django
Laravel
Tools
Crawler
CLI
Platforms
Magento 2
WordPress
Shopify
commercetools
BigCommerce
Salesforce Commerce Cloud B2C
Netlify
Zendesk
  • Home
  • API Reference
    • API Methods
    • API Parameters
    • REST API
    • Tools
      • Algolia CLI
      • Algolia Crawler
    • API Clients
      • PHP
      • Ruby
      • JavaScript
      • Python
      • Swift
      • Kotlin
      • .NET
      • Java
      • Go
      • Scala
    • UI Components
      • InstantSearch.js
      • React InstantSearch
      • Vue InstantSearch
      • Angular InstantSearch
      • InstantSearch iOS
      • InstantSearch Android
      • Algolia for Flutter
      • Autocomplete
      • Recommend
  • Integrations
    • Frameworks
      • Rails
      • Symfony
      • Django
      • Laravel
    • Platforms
      • Magento 2
      • WordPress
      • Shopify
      • commercetools
      • BigCommerce
      • Salesforce Commerce Cloud B2C
      • Netlify
      • Zendesk
  • Getting started
    • What is Algolia?
    • NeuralSearch
    • How Algolia works
      • In depth
        • Algolia's ecosystem
        • Algolia's features
    • Quick start
      • Tutorials
      • Get started with the dashboard
      • Track usage and performance in the dashboard
      • Quickstart with the PHP API client
      • Quickstart with the Ruby API client
      • Quickstart with the JavaScript API client
      • Quickstart with the Python API client
      • Quickstart with the Swift API client
      • Quickstart with the Kotlin API client
      • Quickstart with the .NET API client
      • Quickstart with the Java API client
      • Quickstart with the Go API client
      • Quickstart with the Scala API client
    • Glossary
  • Sending and managing data
    • Prepare your records for indexing
      • How to
        • Setting searchable attributes
        • Creating and using nested attributes
        • Reducing record size
        • Handling data relationships
        • Indexing long pages
        • Creating parent-child relationships
        • Structure ecommerce product records
      • In depth
        • Prepare your index
        • What is in a record
        • Data cleaning
        • Data, record size, and usage limits
    • Send and update your data
      • Connectors
        • Overview
        • JSON
        • CSV
        • Google BigQuery
        • MySQL
        • Elasticsearch
      • How to
        • Importing from the dashboard
        • Importing with the API
        • Incremental updates
        • Sending records in batches
      • In depth
        • Different synchronization strategies
        • Index operations are asynchronous
        • Handling concurrency with versioning
    • Manage indices and apps
      • Manage indices
        • How to
          • Export and import indices
          • Move indices
          • Copy indices
          • Delete indices
        • Concepts
          • Choosing between one or more indices
          • Indices and analytics
        • Tutorial
          • Generate a sitemap from an Algolia index
      • Manage your Algolia applications
  • Managing results
    • Relevance overview
      • In depth
        • The eight ranking criteria
        • Defining relevance
        • Search is more than textual matching
    • Must do
      • Searchable attributes
        • How to
          • Configuring searchable attributes the right way
      • Custom ranking
        • How to
          • Create custom ranking attributes
          • Boosting or penalizing records
          • Controlling precision of custom ranking metrics
          • Enrich your records with Google Analytics data
          • Using the Bayesian average in custom ranking
          • Custom ranking of results per category
    • Refine results
      • Sorting results
        • How to
          • Sort by attribute
          • Sort an index by date
          • Sort an index alphabetically
          • Create a replica index
          • Search in a replica index
          • Delete a replica index
          • Rename a replica index
          • Manage multiple indices
          • UI sorting widgets
        • In depth
          • Exhaustive sorting
          • Relevant sorting
          • Understanding replicas
          • What is the effect of a replica on the number of records?
      • Faceting
        • How to
          • How to declare attributes for faceting with the API
          • How to declare attributes for faceting in the dashboard
      • Filtering
        • How to
          • Filter by attributes
        • In depth
          • Filters and boolean operators
          • Filter scoring
          • Filters and facet filters
      • Grouping results
        • How to
          • How to group results
          • Item variations
      • Geo location
        • How to
          • Filter results around a location
          • Filter results inside a rectangle
          • Filter results inside a polygon
          • Geo ranking info
          • How to solve the 180th meridian issue
        • In depth
          • Geographical ranking precision
    • Rules
      • Rules overview
        • How to
          • Using conditionless Rules
          • Adding default search parameters with Rules
          • Using rules to customize search results by platform
        • In depth
          • Implementing Rules
          • Rule matching algorithm
          • Debugging Rules
      • Detecting intent
        • How to
          • Adding filters based on the query
          • Dynamic filtering with Rules
          • Adding search parameters dynamically
          • Detecting keywords
      • Merchandising
        • How to
          • Promoting hits
          • Hiding results with Rules
          • Promote records with optional filters
          • Redirect searches to a URL
          • Adding banners
          • Merchandising on empty queries
          • Combining multiple consequences
          • Merchandise category pages
          • Merchandising facets
          • Add search parameters with JSON
        • In depth
          • Optional filters
    • Optimize search results
      • Adding synonyms
        • How to
          • Manage synonyms in the dashboard
        • In depth
          • Regular synonyms
          • One-way synonyms
          • Alternative correction synonyms
          • Synonym placeholders
      • Typo tolerance
        • How to
          • Preventing typosquatting
          • Searching in hyphenated attributes
        • In depth
          • Configuring typo tolerance
      • Handling natural languages
        • How to
          • Multilingual search
          • Set an index's query language
          • Customize stop words
          • Customize plurals and other declensions
          • Customize word segmentation
        • In depth
          • Language-specific configurations
          • Normalization
          • Tokenization
          • Splitting and concatenation
          • Algolia's supported languages
      • Empty or insufficient results
        • In depth
          • Removing words to improve results
      • Override engine defaults
        • How to
          • Querying in the middle of a word
        • In depth
          • Prefix searching
          • Adjusting the Exact criterion
    • Troubleshooting
      • Troubleshooting search
      • Troubleshooting relevance
  • Building Search UI
    • What is InstantSearch Android?
    • What is Angular InstantSearch?
    • Algolia for Flutter
    • What is InstantSearch iOS?
    • What is InstantSearch.js?
    • What is React InstantSearch?
    • What is Vue InstantSearch?
    • Getting started
    • Getting started
    • Getting started
    • Getting started
    • Getting started
    • Getting started
    • Getting started
    • Installation
    • Installation
    • Installation
    • Installation
    • Installation
    • Installation
    • Installation
    • Click and conversion events
    • Click and conversion events
    • Click and conversion events
    • Click and conversion events
    • Click and conversion events
    • Click and conversion events
    • Click and conversion events
    • Upgrade guide for InstantSearch Android
    • Upgrade guides
    • Upgrade guide for InstantSearch iOS
    • Upgrade guides
    • Upgrade guides
    • Upgrade guides
    • Widgets
      • Widgets showcase
      • Components showcase
      • Widgets showcase
      • Widgets showcase
      • Widgets showcase
      • Widgets showcase
      • Widgets showcase
      • Customize an existing widget
      • Customize an existing widget
      • Customize an existing widget
      • Customize an existing widget
      • Customize an existing widget
      • Customize an existing widget
      • Create your own widgets
      • Create your own widgets
      • Create your own widgets
      • Create your own widgets
      • Create your own widgets
      • Create your own widgets
      • Show and hide widgets
      • Show and hide widgets
      • Change browser defaults for custom search inputs
      • Change browser defaults for custom search inputs
      • Change browser defaults for custom search inputs
      • Change browser defaults for custom search inputs
    • UI & UX patterns
      • Autocomplete
      • Autocomplete
      • Autocomplete
      • Autocomplete
      • Autocomplete
      • Autocomplete
      • Multi-index search
      • Multi-index search
      • Multi-index search
      • Multi-index search
      • Multi-index search
      • Multi-index search
      • Query Suggestions
      • Query Suggestions
      • Query Suggestions
      • Query Suggestions
      • Query Suggestions
      • Query Suggestions
      • Highlighting and snippeting
      • Highlighting and snippeting
      • Highlighting and snippeting
      • Highlighting and snippeting
      • Highlighting and snippeting
      • Highlighting and snippeting
      • Highlighting and snippeting
      • Pagination
      • Pagination
      • Pagination
      • Pagination
      • Pagination
      • Pagination
      • Infinite scroll
      • Infinite scroll
      • Infinite scroll
      • Infinite scroll
      • Infinite scroll
      • Infinite scroll
      • Geo search
      • Geo search
      • Geo search
      • Geographical search
      • Geographical search
      • Geo search
      • Recommend
      • Recommend
      • OpenSearch protocol
      • OpenSearch protocol
      • OpenSearch protocol
      • OpenSearch protocol
      • Sorting refinements
      • Sorting refinements
      • Filtering patterns
      • Filtering patterns
      • Redirects
      • Redirects
      • Redirects
      • Redirects
      • Redirects
      • Redirects
      • Structured results
      • Structured results
      • Structured results
      • Structured results
      • Facet Display
      • Facet Display
      • Facet Display
      • Facet Display
      • Facet Display
      • Facet dropdown
      • Facet dropdown
      • Voice search
      • Voice search
      • Injecting content between hits
      • Injecting content between hits
      • Injecting content between hits
      • Injecting content between hits
      • Loading indicator
      • Loading indicator
      • Loading indicator
    • Going further
      • Conditional display
      • Conditional display
      • Conditional display
      • Conditional display
      • Conditional display
      • Conditional display
      • Conditional requests
      • Conditional requests
      • Conditional requests
      • Conditional requests
      • Conditional requests
      • Conditional requests
      • API keys/security
      • API keys/security
      • API keys/security
      • API keys/security
      • API keys/security
      • API keys/security
      • Routing URLs
      • Routing URLs
      • Routing URLs
      • Routing URLs
      • Integrate Google Analytics
      • Integrate Google Analytics
      • Integrate Google Analytics
      • Integrate Google Analytics
      • Improve performance
      • Improve performance
      • Improve performance
      • Improve performance
      • Improve performance
      • Improve performance
      • Optimize search requests
      • Optimize search requests
      • Optimize search requests
      • Optimize search requests
      • Optimize search requests
      • Optimize search requests
      • Backend search
      • Backend search
      • Backend search
      • Backend search
      • Backend search
      • Backend search
      • Native
      • Native
      • React Native
      • Native
      • Access state outside the lifecycle
      • Server-side rendering
      • Server-side rendering
      • Server-side rendering
      • Server-side rendering
      • Telemetry
      • Telemetry
      • Turn off automatic filtering
      • Turn off automatic filtering
    • Ecommerce ui template
      • Overview
      • Getting started
      • Components
    • Resources
      • UI Design Kit
      • UI Design Kit
      • UI Design Kit
      • UI Design Kit
      • UI Design Kit
      • UI Design Kit
      • UI Design Kit
      • Demos
      • Demos
      • Demos
      • Demos
      • Demos
      • Demos
      • SEO-ready search experience checklist
      • SEO-ready search experience checklist
      • SEO-ready search experience checklist
      • SEO-ready search experience checklist
      • Privacy manifests
    • Troubleshooting
      • FAQ
      • FAQ
      • FAQ
      • FAQ
      • FAQ
      • FAQ
  • Sending events
    • Get started
    • Concepts
      • Event types
      • User token
    • Guides
      • Plan your implementation
      • Keep track of query IDs
      • Validate your events
    • Connectors
      • Google Tag Manager
      • Segment
      • Tealium
  • Search analytics
    • Overview
    • Concepts
      • Metrics
      • Query aggregation
    • Guides
      • Distinguish users for analytics
      • Exclude queries
      • Segment your analytics data
  • Personalization
    • What is Personalization?
      • In depth
        • How Personalization works
    • Personalizing results
      • In depth
        • Configuring Personalization
    • Going to production
      • How to
        • A/B testing Personalization
        • Enabling Personalization
      • In depth
        • Implementation checklist
  • A/B testing
    • What is A/B testing
      • How to
        • Prepare your environment for A/B testing
        • Create and run an A/B test
      • In depth
        • Why do A/B testing?
        • How A/B test scores are calculated
    • A/B test implementation checklist
    • How to read your A/B test results
    • FAQ
      • FAQ
  • Algolia Recommend
    • Overview
    • How to
      • Upload events via CSV
      • Set up Recommend
      • Get image-based recommendations with Looking Similar
      • Recommend rules
      • Deduplicate recommendations
      • Batching Recommend requests
    • Going further
      • Recommend with React Native
      • Recommend with React meta-frameworks
  • Algolia AI
    • Dynamic Synonym Suggestions
    • Dynamic Re-Ranking
      • Tutorials
        • Add Dynamic Re-Ranking to category pages
    • Query Categorization
  • Going to production
    • Prepare your project
    • Implementation checklist
    • Case study for an online clothing company
  • Scaling
    • Servers and clusters
      • How to
        • Capacity alerts
      • In depth
        • Server specs
    • Distributed Search Network (DSN)
    • Multi-cluster management (MCM)
      • How to
        • Implementing MCM
    • Scaling to larger datasets
    • Algolia service limits
  • Security
    • API keys
      • How to
        • User-restricted access to data
        • How to restore an API key
      • In depth
        • API key restrictions
    • Security best practices
      • In depth
        • Shared responsibility
    • Algolia Vault
  • Solutions
    • Ecommerce
      • Search
        • Autocomplete
          • Autocomplete with Federated Search
          • Animated placeholders
          • Predictive search suggestions
      • Browse
        • Tutorials
          • Category Pages
        • Product carousels
          • Static product carousels
          • Dynamic product carousels
      • Filtering and Navigation
        • Tutorials
          • Auto-selected facets
          • Filter suggestions
          • Visual facets
          • Guided search
      • B2B catalog management
        • Tutorials
          • Searching by SKU
          • Personalized catalogs
          • Personalized pricing
      • Visual image search
        • Tutorials
          • Image classification and tagging
          • Search by image
      • Build a voice to text search
Algolia.com Developer Hub
API reference

Algolia APIs

Edit this page A Edit this page

The Algolia Service Level Agreement doesn’t cover using the REST APIs directly.

Search API

Monitoring API

Usage API

Analytics API

Insights API

A/B Testing API

Recommend API

Ingestion API

Personalization API

Query Suggestions API

Crawler API

© Algolia · Privacy Policy ·

Support Need help?