  
Algolia Recommend

The perfect starting point to integrate Algolia Recommend (https://www.algolia.com/products/recommendations) within your JavaScript project

  Documentation (https://www.algolia.com/doc/api-client/methods/recommend/)  •
  UI library (https://www.algolia.com/doc/ui-libraries/recommend/introduction/what-is-recommend/)  •
  Community Forum (https://discourse.algolia.com)  •
  Stack Overflow (http://stackoverflow.com/questions/tagged/algolia)  •
  Report a bug (https://github.com/algolia/algoliasearch-client-javascript/issues)  •
  Support (https://www.algolia.com/support)

## ✨ Features

- Thin & **minimal low-level HTTP client** to interact with Algolia's Recommend API
- Works both on the **browser** and **node.js**
- **UMD compatible**, you can use it with any module loader
- Built with TypeScript

## 💡 Getting Started

First, install Algolia Recommend API Client via the [npm](https://www.npmjs.com/get-npm) package manager:

```bash
npm install @algolia/recommend
```

Then, let's retrieve recommendations:

```js
const algoliarecommend = require('@algolia/recommend');

const client = algoliarecommend('YourApplicationID', 'YourAdminAPIKey');

client
  .getFrequentlyBoughtTogether([
    {
      indexName: 'your_index_name',
      objectID: 'your_object_id',
    },
  ])
  .then(({ results }) => {
    console.log(results);
  })
  .catch(err => {
    console.log(err);
  });

client
  .getRelatedProducts([
    {
      indexName: 'your_index_name',
      objectID: 'your_object_id',
    },
  ])
  .then(({ results }) => {
    console.log(results);
  })
  .catch(err => {
    console.log(err);
  });
```

For full documentation, visit the **[online documentation](https://www.algolia.com/doc/api-client/methods/recommend/)**.

## 📄 License

Algolia Recommend API Client is an open-sourced software licensed under the [MIT license](LICENSE.md).
