# tracktik-sdk

> TrackTik Javascript API SDK

Latest version **1.0.1** (published 2026-04-17) · none license · 0 weekly downloads

## Install

```sh
npm install tracktik-sdk
pnpm add tracktik-sdk
yarn add tracktik-sdk
bun add tracktik-sdk
```

## Health

**Score 55/100 (C)** — status: active.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2026-04-17 |
| First published | 2019-07-25 |
| Weekly downloads | 0 |
| License | none |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 233.4 KB |
| Known vulnerabilities | 0 (+36 in 1 direct dependencies) |
| Install scripts | no |
| Author | TrackTik |
| Maintainers | vanackp, tuliodiaz, diegooliveiratt |
| Keywords | TrackTik, SDK |

## Links

- npm: https://www.npmjs.com/package/tracktik-sdk
- Repository: https://github.com/tracktik/tracktik-sdk-js
- Issues: https://github.com/tracktik/tracktik-sdk-js/issues
- npm.io page: https://npm.io/package/tracktik-sdk

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) 1.15.0

## Recent versions

- 1.0.1 (latest) — 2026-04-17
- 1.0.0 — 2026-04-16
- 0.3.18 — 2026-03-13
- 0.3.17 — 2026-03-05
- 0.3.16 — 2026-02-03
- 0.3.15 — 2025-07-30
- 0.3.14 — 2025-04-02
- 0.3.13 — 2025-03-04
- 0.3.12 — 2024-11-01
- 0.3.11 — 2024-08-13
- 0.3.10 — 2024-06-03
- 0.3.9 — 2024-05-29
- 0.3.8 — 2024-01-11
- 0.3.7 — 2023-12-08
- 0.3.6 — 2023-03-03
- … 34 more at https://npm.io/package/tracktik-sdk/versions

## README

# TrackTik JavaScript SDK

The TrackTik JavaScript SDK is a lightweight, promise based
interface to the TrackTik v1 API that works in both nodejs
and browser environments. It provides common services for
making API requests and helper utilities.

## Documentation
Please view our full JavaScript SDK documentation at
<https://github.com/TrackTik/tracktik-sdk-js>.

## Quickstart

Install the latest version of the SDK

``` bash
# instalation
npm install tracktik/tracktik-sdk#master --save
#or
yarn add tracktik/tracktik-sdk#master
```

Import the library using ES6 syntax

``` javascript
import Api, { RestApiConnectorAuth } from "tracktik-sdk";
```

ES5 and require to load the SDK
 
``` javascript
var SDK = require('tracktik-sdk');
var Api = SDK.default
var RestApiConnectorAuth = SDK.RestApiConnectorAuth
```

Once the module was imported, procceed to authenticate with the REST API

``` javascript
const connector = await RestApiConnectorAuth({ username: 'foo', password:'bar' })
const api = new Api(connector)
```

With the Api initialized, the next step is to consume the API resources.

``` javascript
//Create entity
const newEmployee = await api.employees.create({
  firstName: 'bob',
  lastName: 'security'
})

//Update entity
const updatedEmployee = await api.employees.update(employee.id, {
  firstName: 'alice',
  lastName: 'guard'
})

//Edit entity
const editedEmployee = await api.employees.edit(employee.id, {
  lastName: 'officer'
})

//Get one entity
const aliceEmployee = await api.employee.get(employee.id)

//Get a collection of entities
const collection = await api.employee.getAll({
  filters: [{
    field: 'lastName',
    operator: 'eq',
    value: 'officer'
  }]
})
```

## Contributing
Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for information on how
to contribute, setup the development environment and run tests.

## Versioning
We will try to follow [semver](http://semver.org/) as close as possible.
That means bug fixes will be patch releases (1.0.1 -> 1.0.2), additional
functionality like new endpoints will be minor releases (1.0.1 -> 1.1.0)
and breaking changes to both the library and the API endpoints it hits,
will be major releases (1.0.1 -> 2.0.0).

---
_Source: https://npm.io/package/tracktik-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._