Cognite Javascript SDK

The package @cognite/sdk provides convenient access to the stable Cognite API from applications written in client- or server-side javascript.

The SDK supports authentication through api-keys (for server-side applications) and bearer tokens (for web applications).

Installation

Install the package with yarn:

$ yarn add @haved/cogsdk

or npm

$ npm install @haved/cogsdk --save

Usage

const { CogniteClient } = require('@haved/cogsdk');

Using ES modules

import { CogniteClient } from '@haved/cogsdk';

Using typescript

The SDK is written in native typescript, so no extra types need to be defined.

Quickstart

Web

import { CogniteClient } from '@haved/cogsdk';

async function quickstart() {
  const client = new CogniteClient({ appId: 'YOUR APPLICATION NAME' });
  client.loginWithOAuth({
    project: 'publicdata',
  });

  const assets = await client.assets
    .list()
    .autoPagingToArray({ limit: 100 });
}
quickstart();

For more details about SDK authentication see this document. Also, more comprehensive intro guide with a demo app can be found here

Backend

const { CogniteClient } = require('@haved/cogsdk');

async function quickstart() {
  const client = new CogniteClient({ appId: 'YOUR APPLICATION NAME' });
  client.loginWithApiKey({
    project: 'publicdata',
    apiKey: 'YOUR_SECRET_API_KEY',
  });

  const assets = await client.assets
    .list()
    .autoPagingToArray({ limit: 100 });
}
quickstart();

Documentation

• API documentation
• API reference documentation
• CogniteClient typedoc

The API reference documentation contains snippets for each endpoint, giving examples of SDK use. See also the samples section in this repo.

Guides

• Migration guide on how to migrate from version 1.x.x to version 2.x.x.