Guides / Getting started / Quick start

Quickstart with the Go API Client

On this page

Supported platforms

The Algolia Go API client requires Go version 1.8 or higher.

Install

The recommended way to install the Go API client is via Go modules.

If you already initialized a Go project, run:

Copy 
1

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

You can initialize a new Go project with:

Copy 
1

go mod init algolia-go-example

Quickstart

If you want to get started quickly with self-contained code examples that you can run directly from your code editor, you can explore the quickstart samples on GitHub.

See quickstarts on GitHub

In the following sections, you can learn how to index and search objects in 30 seconds.

Initialize the client

To start, you need to initialize the client. To do this, you need your Application ID and API Key. You can find both on your Algolia account.

Copy 
1
2

client := search.NewClient("YourApplicationID", "YourAdminAPIKey")
index := client.InitIndex("your_index_name")

The API key displayed here is your Admin API key. To maintain security, never use your Admin API key on your front end, nor share it with anyone. In your front end, use the search-only API key or any other key that has search-only rights.

Push data

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

Copy 
1
2
3
4
5
6
7
8
9
10
11
12
13

type Contact struct {
  Firstname string
  Lastname  string
  Company   string
  // Other fields omitted
}

var contacts []Contact
content, err := ioutil.ReadFile("contacts.json")
err = json.Unmarshal(content, &contacts)

index := client.InitIndex("contacts")
res, err := index.SaveObjects(contacts, opt.AutoGenerateObjectIDIfNotExist(true))

Configure

You can customize settings to fine tune the search behavior. For example, you can add a custom ranking by number of followers to further enhance the built-in relevance:

Copy 
1
2
3
4
5

settings := search.Settings{
  CustomRanking: opt.CustomRanking("desc(followers)"),
}

res, err := index.SetSettings(settings)

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

Algolia is designed to suggest results as you type, which means you’ll generally search by prefix. In this case, the order of attributes is crucial to decide which hit is the best.

Copy 
1
2
3
4
5
6
7
8
9
10
11
12

settings := search.Settings{
    SearchableAttributes: opt.SearchableAttributes(
        "firstname",
        "lastname",
        "company",
        "email",
        "city",
        "address",
    ),
}

res, err := index.SetSettings(settings)

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

Copy 
1
2
3
4
5
6
7
8
9
10
11

// Search for a first name
res, err := index.Search("jimmie")

// Search for a first name with typo
res, err := index.Search("jimie")

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

// Search for a first name and a company
res, err := index.Search("jimmie paint")

Search UI

If you’re building a web application, you may be interested in using one of Algolias front-end search UI libraries.

The following example shows how to quickly build a front-end search using InstantSearch.js

index.html

Copy 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

<!doctype html>
<head>
  <meta charset="UTF-8">
  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/instantsearch.css@7.4.5/themes/satellite-min.css" integrity="sha256-TehzF/2QvNKhGQrrNpoOb2Ck4iGZ1J/DI4pkd2oUsBc=" crossorigin="anonymous">
</head>
<body>
  <header>
    <div id="search-box"></div>
  </header>

  <main>
      <div id="hits"></div>
      <div id="pagination"></div>
  </main>

  <script type="text/html" id="hit-template">
    <div class="hit">
      <p class="hit-name">
        {{#helpers.highlight}}{ "attribute": "firstname" }{{/helpers.highlight}}
        {{#helpers.highlight}}{ "attribute": "lastname" }{{/helpers.highlight}}
      </p>
    </div>
  </script>

  <script src="https://cdn.jsdelivr.net/npm/algoliasearch@4.5.1/dist/algoliasearch-lite.umd.js" integrity="sha256-EXPXz4W6pQgfYY3yTpnDa3OH8/EPn16ciVsPQ/ypsjk=" crossorigin="anonymous"></script>
  <script src="https://cdn.jsdelivr.net/npm/instantsearch.js@4.8.3/dist/instantsearch.production.min.js" integrity="sha256-LAGhRRdtVoD6RLo2qDQsU2mp+XVSciKRC8XPOBWmofM=" crossorigin="anonymous"></script>
  <script src="app.js"></script>
</body>

app.js

Copy 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

// Replace with your own values
const searchClient = algoliasearch(
  'YourApplicationID',
  'YourSearchOnlyAPIKey' // search only API key, not admin API key
);

const search = instantsearch({
  indexName: 'contacts',
  searchClient,
  routing: true,
});

search.addWidgets([
  instantsearch.widgets.configure({
    hitsPerPage: 10,
  })
]);

search.addWidgets([
  instantsearch.widgets.searchBox({
    container: '#search-box',
    placeholder: 'Search for contacts',
  })
]);

search.addWidgets([
  instantsearch.widgets.hits({
    container: '#hits',
    templates: {
      item: document.getElementById('hit-template').innerHTML,
      empty: `We didn't find any results for the search <em>"{{query}}"</em>`,
    },
  })
]);

search.start();
Did you find this page helpful?
Golang v3