search mobile facets autocomplete spellcheck crawler rankings weights synonyms analytics engage api customize documentation install setup technology content domains user history info home business cart chart contact email activate analyticsalt analytics autocomplete cart contact content crawling custom documentation domains email engage faceted history info install mobile person querybuilder search setup spellcheck synonyms weights engage_search_term engage_related_content engage_next_results engage_personalized_results engage_recent_results success add arrow-down arrow-left arrow-right arrow-up caret-down caret-left caret-right caret-up check close content conversions-small conversions details edit grid help small-info error live magento minus move photo pin plus preview refresh search settings small-home stat subtract text trash unpin wordpress x alert case_deflection advanced-permissions keyword-detection predictive-ai sso

App Search API Clients

To enjoy the clients, one needs an active App Search account. Sign up for a free trial.


Swiftype App Search has an assortment of official API clients. You will need to have an active account with at least one available engine in order to put the clients to work. Below you will find repository links and basic configuration details for...

Ruby

The App Search API has an official Ruby client. It is hosted by RubyGems.org and has no dependencies. Check out the GitHub repository for further documentation on installation, configuration, available methods, testing, and debugging.

Java

App Search has an official Java client. However, the client is not published to any public repositories and will need to be installed manually. You can find the latest builds, installation and configuration instructions, within GitHub.

JavaScript

The App Search API has an official JavaScript client. The package is hosted within npmjs.com. You have two ways that you can install it within your code-base. Check out the GitHub repository for further documentation on installation, configuration, available functions, testing, and debugging.

Python

App Search offers an official Python client. The client depends on requests and PyJWT. It supports Python 2.7 and Python 3.3+. Check out the GitHub repository for further information on how to make use of the client.

Node.js

The App Search API has an official Node.js client. The package is hosted within npmjs.com. Check out the GitHub repository for further documentation on installation, configuration, available methods, and testing.


Stuck? Looking for help? Contact Support!