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

# Getting started

## Installation

### For a new project

1. Initialize your project with Yarn or npm:<br>

   ```bash
   yarn init
   # or
   npm init
   ```
2. Add the library to your project:<br>

   ```sh
   npm i @ubidots/ubidots-javascript-library --save-dev
   # or
   yarn add @ubidots/ubidots-javascript-library -D
   ```

### For existing projects <a href="#for-existing-projects" id="for-existing-projects"></a>

Go to your project's root directory and run:

```sh
npm i @ubidots/ubidots-javascript-library --save-dev
# or
yarn add @ubidots/ubidots-javascript-library -D
```

## Importing the library

Depending on whether your project uses CommonJS or ES Modules, import the library as follows:

### CommonJS <a href="#commonjs" id="commonjs"></a>

```javascript
const { Ubidots } = require('@ubidots/ubidots-javascript-library');
```

### ES Modules <a href="#es-modules" id="es-modules"></a>

```typescript
import { Ubidots } from '@ubidots/ubidots-javascript-library';
```

## Usage

```javascript
// Uncomment the correct import syntax shown above
// const { Ubidots } = require('@ubidots/ubidots-javascript-library');
// or
// import { Ubidots } from '@ubidots/ubidots-javascript-library';

// Set custom domain
// Do not call this method if you want to use the default Ubidots host.
// Ubidots.setBaseUrl('custom-domain');

// Authenticate with the API
Ubidots.authenticate('<ubidots-token>');

// Get the first 100 devices from the account
Ubidots.devices.get().then(devices => {
  // Prints an array of Device objects
  console.log(devices);

  // YOUR LOGIC FOR THESE 100 DEVICES
});
```

{% hint style="info" %}
To use this SDK in the HTML Canvas widget, see the [dedicated page](/dashboards-and-widgets/html-canvas/built-in-library/api.md).
{% endhint %}


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://dev.ubidots.com/sdks/javascript/getting-started.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.