> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Overview — Kinetica TypeScript API

<div className="kinetica-typedoc">
  <div className="tsd-page-title" />

  <div className="tsd-panel tsd-typography">
    <h1 id="kinetica-typescript-api" className="tsd-anchor-link">Kinetica TypeScript API</h1>
    <p>The TypeScript API is published to npm as <code>@kinetica/gpudb-api</code>:</p>

    <div>
      ```
      npm install @kinetica/gpudb-api
      ```
    </div>

    <p>Type declarations for every request and response ship with the package and are picked up automatically; no separate <code>@types</code> package is needed.</p>

    <div>
      ```
      import { GPUdb } from '@kinetica/gpudb-api';

      const gpudb = new GPUdb('http://localhost:9191', {
          username: 'admin',
          password: 'password'
      });

      const response = await gpudb.show_system_properties({});
      ```
    </div>

    <p>Each endpoint is available in two forms, both returning a <code>Promise</code> and both accepting an optional callback:</p>

    <ul>
      <li>positional parameters, e.g. <code>admin\_add\_host(host\_address, options)</code></li>
      <li>a single request object, e.g. <code>admin\_add\_host\_request({"{"} host\_address, options {"}"})</code></li>
    </ul>

    <p>The request and response shapes are listed under <strong>Request Types</strong> and <strong>Response Types</strong>.</p>
    <p>The same package serves Node.js and browser applications; see the Node.js and JavaScript API references for the specifics of each. The source is on <a href="https://github.com/kineticadb/kinetica-api-typescript">GitHub</a>.</p>
  </div>
</div>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.