Getting started / Quick start

Quick start

Send your first search request in under five minutes. You need an API key from your dashboard and any tool that can make HTTP requests.

Install the client

bash

npm install @quarry/client

Add your key

Keep your key on the server. Never put it in code that runs in the browser.

javascript

import { Quarry } from "@quarry/client";

const quarry = new Quarry(process.env.QUARRY_KEY);
const results = await quarry.search("blue running shoes", { limit: 10 });
// results.items is an array of matches

Tip. Test keys start with qk_test_ and never charge you. Switch to a live key when you go to production.

Options

Name	Type	Description
`limit`	number	Results to return, 1 to 100. Default 20.
`filters`	object	Only return items that match, for example `{ color: "blue" }`.
`typo`	boolean	Allow small spelling mistakes. Default true.

Free template from 100 CSS Designs