SDK

We provide official Software Development Kits (SDKs) for Python and JavaScript with libraries that interact with the Cognite Data Fusion API.

The Scala SDK is available as a public beta. Do not use the SDK in production systems.

In this article:

The Python Software Development Kit (SDK)

The Cognite Python library requires Python 3.5+ and provides access to the Cognite Data Fusion API from applications written in the Python language. For detailed information, see the Cognite Python SDK Documentation.

To download and install Python, visit Python.org.

To install the Cognite Python library:

pip install cognite-sdk
1

The JavaScript Software Development Kit (SDK)

The JavaScript library provides access to the Cognite Data Fusion API from applications written in client- or server-side JavaScript. The library supports authentication through API keys (for server-side applications) and bearer tokens (for web applications). For detailed information, see the SDK reference docs or our github repository.

Install the Cognite JavaScript library with yarn:

yarn add @cognite/sdk
1

Or with npm:

npm install @cognite/sdk --save
1

What to do next?
Click here to learn how to build an application using Cognite JavaScript SDK.

The Beta Scala Software Development Kit (SDK)

The Scala SDK is available for Scala 2.11, 2.12, and 2.13, and provides access to the Cognite Data Fusion API from applications written in the Scala language.

The SDK is currently in public beta, and we recommended that you don't use it in production systems. Visit the GitHub repository to follow the progress and to request features.

Visit the Maven Repository to see the available versions. In the following examples, replace x.y.z with the version you want to use.

To use the SDK with sbt, add the following to your build.sbt:

libraryDependencies += "com.cognite" %% "cognite-sdk-scala" % "x.y.z"
1

To build your project with Apache Maven, add the following to your pom.xml. Change 2.13 to match the version of the Scala SDK you're using:

<dependency>
    <groupId>com.cognite</groupId>
    <artifactId>cognite-sdk-scala_2.13</artifactId>
    <version>x.y.z</version>
</dependency>
1
2
3
4
5

To import the SDK if you are using Ammonite as an interactive shell:

import $ivy.`com.cognite::cognite-sdk-scala:x.y.z`
import com.cognite.sdk.scala.v1._
1
2

See our GitHub repository for examples and more information about the Scala SDK.

Last Updated: 10/30/2019, 10:12:09 AM