Data SDK

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

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

• TypeScript/NodeJS Data SDK: Github | npm

• Python Data SDK: Github | PyPI

• C# Data SDK: Github | NuGET

Pre-requisites

• Sign in or sign up to the DIMO Developer Console ↗ and create a license to obtain a Client ID.

• Generate and save your API Key and add at least one Redirect URI of your choice.

A sample app configured in the DIMO Developer Console

Using the Data SDKs

1

Install the SDK

TypeScript/NodeJS

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

Dimo.Client 1.0.5nuget

The .NET Data SDK on NuGET

2

Import + Initiate the SDK

TypeScript/NodeJS

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 currently 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 currently support both Production and Dev environments, but recommend using Production at this time.

dimo = DIMO("Production")

# Or:

dimo = DIMO("Dev")

C#

Without Dependency Injection:

using Dimo.Client;

var dimoClient = new DimoClientBuilder().AddAllServices().Build();

With Dependency Injection:

using Dimo.Client;

services.AddDimoClient(options =>
{
    options.Environment = DimoEnvironment.Production;
});

3

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/NodeJS

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

// The TS/JS data SDK references the "access_token" and formats it 
// in the format you need in later steps

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#

var auth = await dimoClient.AuthenticationService.GetTokenAsync(
    clientId: "<your client id>",
    domain: "<your domain>",
    privateKey: "<your private key>",
    address: "<your address>" // This value is the same as clientId
);

Console.WriteLine(auth.AccessToken);

Get Vehicle JWT

TypeScript/NodeJS

const vehicleJwt = await dimo.tokenexchange.getVehicleJwt({
  ...developerJwt,
  tokenId: <vehicle_token_id>
});

Python

# Call to get a Vehicle JWT
get_vehicle_jwt = dimo.token_exchange.exchange(
    developer_jwt = dev_jwt, 
    token_id=<token_id> 
)

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

C#

var vehicleTokenId = 123456; // The token id of the vehicle
var vehicleJwt = await dimoClient.TokenExchangeService.GetPrivilegeTokenAsync(
    accessToken: auth.AccessToken,
    tokenId: vehicleTokenId,
    privileges: [ 
        PrivilegeSharing.AllTimeNoLocationData,
        PrivilegeSharing.Commands, 
        PrivilegeSharing.CurrentLocation, 
        PrivilegeSharing.AllTimeLocation 
    ]); // The privileges you want to get for the vehicle

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

4

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/NodeJS

const latestSignals = await dimo.telemetry.query({
  ...vehicleJwt,
  query: `
    query GetSignalsLatest {
      signalsLatest(tokenId: <insert_token_id>) {
        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#

var query = @"
  query GetSignalsLatest {
      signalsLatest(tokenId: <insert_token_id>) {
        powertrainTransmissionTravelledDistance {
          timestamp
          value
        }
        powertrainType {
          timestamp
          value
        }
        lastSeen
      }
    }
";

// Variables are optional
var variables = new
{
    VariableName = "VariableValue"
};

var result = await dimoClient.TelemetryService.ExecuteQueryAsync<TResponse>(query, variables, vehicleJwt.Token);

Console.WriteLine(result);

5

Success! 🎉

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