> For the complete documentation index, see [llms.txt](https://docs.predicthq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.predicthq.com/sdks/javascript-sdk.md).

# JavaScript SDK

The official PredictHQ JavaScript Client provides a consistent JavaScript interface to our API.

<table data-view="cards"><thead><tr><th></th><th data-hidden></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>NPM</strong></td><td></td><td></td><td><a href="https://www.npmjs.com/package/predicthq">https://www.npmjs.com/package/predicthq</a></td></tr><tr><td><strong>GitHub</strong></td><td></td><td></td><td><a href="https://github.com/predicthq/sdk-js">https://github.com/predicthq/sdk-js</a></td></tr></tbody></table>

## Example

### Installation

Install the SDK from npm:

```bash
npm install predicthq
```

### Setup the SDK

Import the client and initialize it with your access token:

```javascript
import Client from 'predicthq'

// Initialises PredictHQ client library using your access token
// Note: You can find/create your access token at https://control.predicthq.com/clients
const client = new Client({access_token: '$API_TOKEN'})
```

### Search events

Perform a basic search of events using the `title` parameter:

```javascript
client.events.search({title: 'Aviation Festival'})
    .then(
        (results) => {
            for (const event of results) {
                console.info(event);
            }
        }
    ).catch(
        err => console.error(err)
    )
```

## Further examples

Browse through our [use case examples](https://github.com/predicthq/sdk-js/tree/master/usecases) on our GitHub repository.

## Found an issue?

[Log an issue](https://github.com/predicthq/sdk-js/issues/new) on our GitHub repository.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.predicthq.com/sdks/javascript-sdk.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
