Data SDK

The DIMO Data SDK is used to access vehicle data via our APIs. Available in TypeScript, Python, and C#.

DIMO Data SDKs

1

Create a Developer License & App in the Dev Console

You can skip this step if you've already created an application on the Developer Console.

Sign in or sign up to the DIMO Developer Console ↗ and create an application.

Generate an API Key and add at least 1 RedirectUri (you'll need these later, along with your Client ID).

A sample app configured in the DIMO Developer Console

2

Install the SDK

TypeScript

npm install @dimo-network/data-sdk

# Or install with yarn
yarn add @dimo-network/data-sdk

npm: @dimo-network/data-sdknpm

The TypeScript Data SDK on npm

Python

pip install dimo-python-sdk

dimo-python-sdkPyPI

The Python Data SDK on PyPI

C#

# Windows users:
Install-Package Dimo.Client

# Mac/ Linux users:
dotnet add package Dimo.Client

3

Import + Initiate the SDK

TypeScript

Import the SDK:

# ES Modules: 
import { DIMO } from '@dimo-network/data-sdk';

# Or Common JS
const { DIMO } = require('@dimo-network/data-sdk/dist/index.cjs';

Initiate the SDK depending on the environment of your interest. We currenty support both Production and Dev environments, but recommend using Production at this time.

const dimo = new DIMO('Production');

# or

const dimo = new DIMO('Dev');

Python

Import the SDK:

from dimo import DIMO 

Initiate the SDK depending on the environment of your interest. We currenty support both Production and Dev environments, but recommend using Production at this time.

dimo = DIMO("Production")

# Or:

dimo = DIMO("Dev")

C#

4

Perform Auth Function Calls

Use the credentials from your Developer Console application (Step 1) to obtain a Developer JWT, and a Vehicle JWT for vehicle tokenIds that have shared privileged vehicle access with you. You can learn more about these in Authentication.

The domain value is any of the configured redirectUri's you've added in the console.

The private_key value is the API Key you generated.

Get Developer JWT

TypeScript

const auth = await dimo.auth.getToken({
  client_id: '<client_id>',
  domain: '<redirect_uri>',
  private_key: '<api_key>',
});

Python

auth_header = dimo.auth.get_token(
    client_id = '<client_id>',
    domain = '<redirect_uri>',
    private_key = '<api_key>'
)

# Store the Developer JWT from the auth_header dictionary
dev_jwt = auth_header["access_token"]

C#

Get Vehicle JWT

TypeScript

await dimo.tokenexchange.exchange({
  ...auth,
  privileges: [1,3,4],
  tokenId: <vehicle_token_id>
});

Python

# Call to get a Vehicle JWT
get_vehicle_jwt = dimo.token_exchange.exchange(
    developer_jwt = dev_jwt, 
    privileges=[1, 3, 4, 5],
    token_id=<token_id> 
    )

# Store the Vehicle JWT from the get_vehicle_jwt response
vehicle_jwt = get_vehicle_jwt['token']

C#

For more information on Vehicle JWTs, see: Token Exchange ↗

5

Make Your First API Call

Once authenticated with a Vehicle JWT, you're ready to make your first API call. Try with logging the following to your terminal:

TypeScript

const latestSignals = await dimo.telemetry.query({
  ...vehicleJwt,
  query: `
    query GetSignalsLatest {
  signalsLatest(tokenId: 
<insert_token_id>
Replace with the privileged tokenId you're making a request for
) {
    powertrainTransmissionTravelledDistance {
      timestamp
      value
    }
    powertrainType {
      timestamp
      value
    }
    lastSeen
  }}
  `
});

console.log(latestSignals)

Python

  latest_signals = dimo.telemetry.query(
  vehicle_jwt= vehicle_jwt,
  query= """
    query GetSignalsLatest {
  signalsLatest(tokenId: <insert_token_id>) {
    powertrainTransmissionTravelledDistance {
      timestamp
      value
    }
    powertrainType {
      timestamp
      value
    }
    lastSeen
  }}
  """
);

print(latest_signals)

C#

6

Success! 🎉

You're now ready to customize your app with the SDKs!

All of our SDKs are open-source. Check them out in more detail here:

• TypeScript Data SDK: Github | npm

• Python Data SDK: Github | PyPI

• C# Data SDK: Github