Performing Search Queries

Once your data is imported and your index is up and running, you can start performing search queries using one of our Official SDKs. Orama offers SDKs for JavaScript, Swift, Kotlin, PHP and Python.

The Official SDKs are the recommended way to communicate with Orama Cloud, providing out of the box connection management, cache, telemetry, and type safety for all your search operations.

Installing the Orama SDK

You can find the guide on installing the SDK here.

The supported languages are: JavaScript, Swift, Kotlin, PHP, and Python.

Quick start

You can install the Javascript SDK using npm, yarn, pnpm, bun, or any other package manager of your choice:

npm

npm install @oramacloud/client

Yarn

yarn add @oramacloud/client

pnpm

pnpm install @oramacloud/client

When developing using Deno, you can import the SDK using the npm namespace:

import { OramaClient } from "npm:@oramacloud/client";

This SDK aims to be 100% compatible with every JavaScript environment, including Node.js, Deno, Bun, and browsers.

---

The SDK provides an OramaClient class that you can use to interact with the Orama Cloud API.

From there, you can connect to the Orama Cloud API and start making requests:

import { OramaClient } from "@oramacloud/client";

const client = new OramaClient({
  endpoint: "YOUR_ENDPOINT_URL",
  api_key: "YOUR_PUBLIC_API_KEY",
});