Manticore Javascript client

February 13, 2026 · View on GitHub

Сlient for Manticore Search.

❗ WARNING: this is a development version of the client. The latest release's readme is https://github.com/manticoresoftware/manticoresearch-javascript/tree/9.0.0

Compatibility Table

Minimum Manticore Search version is 2.5.1 with HTTP protocol enabled.

*manticoresearch-javascriptManticore SearchNodeCompatibility
manticoresearch-devdev (latest development version)Node 18 or newer✅ Fully Compatible
9.0.0 or newer17.5.1 or newerNode 18 or newer✅ Fully Compatible
9.0.0 or newer9.2.14 to 17.5.1Node 18 or newer⚠️ Partially Compatible
8.0.0 to 9.0.09.2.14 to 17.5.1Node 18 or newer✅ Fully Compatible
7.0.0 to 8.0.07.4.6 to 9.2.14Node 18 or newer✅ Fully Compatible
6.0.0 to 7.0.07.0.0 to 7.4.6Node 18 or newer✅ Fully Compatible
6.0.0 to 7.0.06.2.1 to 7.0.0Node 18 or newer⚠️ Partially Compatible
3.3.1 to 6.0.07.0.0 or newerNode 10 or newer⚠️ Partially Compatible
3.3.1 to 6.0.06.2.1 to 7.0.0Node 10 or newer✅ Fully Compatible
3.0.0 to 3.3.16.2.0 or newerNode 10 or newer⚠️ Partially Compatible
3.0.0 to 3.3.14.2.1 to 6.2.0Node 10 or newer✅ Fully Compatible
2.0.3 to 3.0.04.0.2 to 4.2.1Node 10 or newer✅ Fully Compatible
2.0.2 to 2.0.34.0.2 to 4.2.1Node 8 or newer⚠️ Partially Compatible
2.0.2 to 2.0.32.5.1 to 4.0.2Node 8 or newer✅ Fully Compatible

Installation

npm install manticoresearch

Getting Started

Please follow the installation instruction and execute the following JS code:

var Manticoresearch = require('manticoresearch');


# Create instances of API classes
var client= new Manticoresearch.ApiClient();
client.basePath="http://127.0.0.1:9308";
indexApi = new Manticoresearch.IndexApi(client);
searchApi = new Manticoresearch.SearchApi(client);

# Perform insert and search operations
await indexApi.insert({"index": "products", "doc" : {"title" : "Crossbody Bag with Tassel", "price" : 19.85}});
await indexApi.insert({"index": "products", "doc" : {"title" : "microfiber sheet set", "price" : 19.99}});

var search_query = new Manticoresearch.SearchQuery()
search_query.query_string = "@title bag"
      
var search_request = new Manticoresearch.SearchRequest()
search_request.index = "products"
search_request.query = search_query
var query_highlight = new Manticoresearch.Highlight()
query_highlight.fields = {"title":{}}
search_request.highlight = query_highlight
  
var search_response = await searchApi.search(search_request)
console.log("The response of SearchApi->search:\n")    
console.log(search_response)

# Alternatively, you can pass all request arguments as JSON strings
search_response = await searchApi.search({"index": "products", "query": {"query_string": "@title bag"}, "highlight": {"fields": ["title"]}});
console.log("The response of SearchApi->search:\n")    
console.log(search_response)


Documentation for API Endpoints

All URIs are relative to http://127.0.0.1:9308

ClassMethodHTTP requestDescription
Manticoresearch.IndexApibulkPOST /bulkBulk table operations
Manticoresearch.IndexApicallDeletePOST /deleteDelete a document in a table
Manticoresearch.IndexApiinsertPOST /insertCreate a new document in a table
Manticoresearch.IndexApipartialReplacePOST /{table}/_update/{id}Partially replaces a document in a table
Manticoresearch.IndexApireplacePOST /replaceReplace new document in a table
Manticoresearch.IndexApiupdatePOST /updateUpdate a document in a table
Manticoresearch.SearchApiautocompletePOST /autocompletePerforms an autocomplete search on a table
Manticoresearch.SearchApipercolatePOST /pq/{table}/searchPerform reverse search on a percolate table
Manticoresearch.SearchApisearchPOST /searchPerforms a search on a table
Manticoresearch.UtilsApisqlPOST /sqlPerform SQL requests

Documentation for Models

Documentation for Authorization

Endpoints do not require authorization.