Getting Started


Download AlgoliaSearch using

go get github.com/algolia/algoliasearch-client-go/algoliasearch

Quick Start

In 30 seconds, this quick start tutorial will show you how to index and search objects.

Initialize the client

You first need to initialize the client. For that you need your Application ID and API Key. You can find both of them on your Algolia account.

import "github.com/algolia/algoliasearch-client-go/algoliasearch"

client := algoliasearch.NewClient("YourApplicationID", "YourAPIKey")

The api key that is displayed here is your ADMIN API Key, never use it in your frontend nor give it to anyone.

In your frontend, you should use the SEARCH ONLY API Key or any other key that has search rights only

Push data

Without any prior configuration, you can start indexing 500 contacts in the contacts index using the following code:

index := client.InitIndex("contacts")
content, _ := ioutil.ReadFile("contacts.json")

var objects []algoliasearch.Object
if err := json.Unmarshal(content, &objects); err != nil {

res, err := index.AddObjects(objects)

You can now search for contacts using firstname, lastname, company, etc. (even with typos):

// Search by firstname
res, err := index.Search("jimmie", nil)

// Search by firstname with typo
res, err = index.Search("jimie", nil)

// Search for a company
res, err = index.Search("california paint", nil)

// Search for a firstname & company
res, err = index.Search("jimmie paint", nil)


Settings can be customized to tune the search behavior. For example, you can add a custom sort by number of followers to the already great built-in relevance:

settings := algoliasearch.Map{
  "customRanking": []string{"desc(followers)"},

res, err := index.SetSettings(settings)

You can also configure the list of attributes you want to index by order of importance (first = most important):

Since the engine is designed to suggest results as you type, you’ll generally search by prefix. In this case the order of attributes is very important to decide which hit is the best:

settings := algoliasearch.Map{
  "searchableAttributes": []string{

res, err := index.SetSettings(settings)

If you are building a web application, you may be more interested in using our JavaScript client to perform queries.

It brings two benefits:

  • Your users get a better response time by not going through your servers
  • It will offload unnecessary tasks from your servers
<script src="https://cdn.jsdelivr.net/algoliasearch/3/algoliasearch.min.js"></script>
var client = algoliasearch('ApplicationID', 'apiKey');
var index = client.initIndex('indexName');

// perform query "jim"
index.search('jim', searchCallback);

// the last optional argument can be used to add search parameters
  'jim', {
    hitsPerPage: 5,
    facets: '*',
    maxValuesPerFacet: 10

function searchCallback(err, content) {
  if (err) {


Getting Help

Did you find this page helpful?

We're always looking for advice to help improve our documentation! Please let us know what's working (or what's not!) - we're constantly iterating thanks to the feedback we receive.

Send us your suggestions!