Skip to content

latitudesh/latitudesh-typescript-sdk

BranchesTags

Repository files navigation

latitudesh-typescript-sdk

Summary

Latitude.sh API: The Latitude.sh API is a RESTful API to manage your Latitude.sh account. It allows you to perform the same actions as the Latitude.sh dashboard.

Table of Contents

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add latitudesh-typescript-sdk

PNPM

pnpm add latitudesh-typescript-sdk

Bun

bun add latitudesh-typescript-sdk

Yarn

yarn add latitudesh-typescript-sdk

Note

This package is published with CommonJS and ES Modules (ESM) support.

Model Context Protocol (MCP) Server

This SDK is also an installable MCP server where the various SDK methods are exposed as tools that can be invoked by AI applications.

Node.js v20 or greater is required to run the MCP server from npm.

Claude installation steps

Add the following server definition to your claude_desktop_config.json file:

{
  "mcpServers": {
    "Latitudesh": {
      "command": "npx",
      "args": [
        "-y", "--package", "latitudesh-typescript-sdk",
        "--",
        "mcp", "start",
        "--bearer", "..."
      ]
    }
  }
}
Cursor installation steps

Create a .cursor/mcp.json file in your project root with the following content:

{
  "mcpServers": {
    "Latitudesh": {
      "command": "npx",
      "args": [
        "-y", "--package", "latitudesh-typescript-sdk",
        "--",
        "mcp", "start",
        "--bearer", "..."
      ]
    }
  }
}

You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:

curl -L -o mcp-server \
    https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
chmod +x mcp-server

If the repo is a private repo you must add your Github PAT to download a release -H "Authorization: Bearer {GITHUB_PAT}".

{
  "mcpServers": {
    "Todos": {
      "command": "./DOWNLOAD/PATH/mcp-server",
      "args": [
        "start"
      ]
    }
  }
}

For a full list of server arguments, run:

npx -y --package latitudesh-typescript-sdk -- mcp start --help

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Latitudesh } from "latitudesh-typescript-sdk";

const latitudesh = new Latitudesh({
  bearer: process.env["LATITUDESH_BEARER"] ?? "",
});

async function run() {
  const result = await latitudesh.apiKeys.list();

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme Environment Variable
bearer apiKey API key LATITUDESH_BEARER

To authenticate with the API the bearer parameter must be set when initializing the SDK client instance. For example:

import { Latitudesh } from "latitudesh-typescript-sdk";

const latitudesh = new Latitudesh({
  bearer: process.env["LATITUDESH_BEARER"] ?? "",
});

async function run() {
  const result = await latitudesh.apiKeys.list();

  console.log(result);
}

run();

Available Resources and Operations

Available methods

ApiKeys

Billing

ElasticIps

Events

  • list - List events

Firewalls

Firewalls.Assignments

  • create - Assign server to firewall

IpAddresses

  • list - List IPs
  • get - Retrieve an IP

KubernetesClusters

OperatingSystems

Plans

Plans.Vm

  • list - List VM plans

PrivateNetworks

Projects

Projects.SshKeys

Regions

  • get - List regions
  • fetch - Retrieve region

Roles

  • list - List roles
  • get - Retrieve role

Servers

SSHKeys

Storage

Tags

TeamMembers

Teams

Teams.Members

Traffic

  • get - Retrieve traffic
  • getQuota - Retrieve traffic quota

UserData

UserProfile

VirtualMachines

VirtualNetworks

VpnSessions

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will also be an async iterable that can be consumed using the for await...of syntax.

Here's an example of one such pagination call:

import { Latitudesh } from "latitudesh-typescript-sdk";

const latitudesh = new Latitudesh({
  bearer: process.env["LATITUDESH_BEARER"] ?? "",
});

async function run() {
  const result = await latitudesh.events.list({});

  for await (const page of result) {
    console.log(page);
  }
}

run();

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { Latitudesh } from "latitudesh-typescript-sdk";

const latitudesh = new Latitudesh({
  bearer: process.env["LATITUDESH_BEARER"] ?? "",
});

async function run() {
  const result = await latitudesh.apiKeys.list({
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Latitudesh } from "latitudesh-typescript-sdk";

const latitudesh = new Latitudesh({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  bearer: process.env["LATITUDESH_BEARER"] ?? "",
});

async function run() {
  const result = await latitudesh.apiKeys.list();

  console.log(result);
}

run();

Error Handling

LatitudeshError is the base class for all HTTP error responses. It has the following properties:

Property Type Description
error.message string Error message
error.statusCode number HTTP response status code eg 404
error.headers Headers HTTP response headers
error.body string HTTP body. Can be empty string if no body is returned.
error.rawResponse Response Raw HTTP response
error.data$ Optional. Some errors may contain structured data. See Error Classes.

Example

import { Latitudesh } from "latitudesh-typescript-sdk";
import * as errors from "latitudesh-typescript-sdk/models/errors";

const latitudesh = new Latitudesh({
  bearer: process.env["LATITUDESH_BEARER"] ?? "",
});

async function run() {
  try {
    const result = await latitudesh.elasticIps.createElasticIp({
      data: {
        type: "elastic_ips",
        attributes: {
          projectId: "proj_AoW6vRnwkvLn0",
          serverId: "sv_2GmAlJ6BXlK1a",
        },
      },
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.LatitudeshError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.ErrorObject) {
        console.log(error.data$.errors); // ErrorT[]
      }
    }
  }
}

run();

Error Classes

Primary error:

Less common errors (7)

Network errors:

Inherit from LatitudeshError:

  • ErrorObject: Applicable to 20 of 129 methods.*
  • ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

* Check the method documentation to see if the error is applicable.

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx: number optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

# Server Variables Description
0 https://api.latitude.sh latitude_api_key
1 http://api.latitude.sh latitude_api_key

If the selected server has variables, you may override its default values through the additional parameters made available in the SDK constructor:

Variable Parameter Default Description
latitude_api_key latitudeApiKey: string "<insert your api key here>"

Example

import { Latitudesh } from "latitudesh-typescript-sdk";

const latitudesh = new Latitudesh({
  serverIdx: 0,
  latitudeApiKey: "<insert your api key here>",
  bearer: process.env["LATITUDESH_BEARER"] ?? "",
});

async function run() {
  const result = await latitudesh.apiKeys.list();

  console.log(result);
}

run();

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { Latitudesh } from "latitudesh-typescript-sdk";

const latitudesh = new Latitudesh({
  serverURL: "http://api.latitude.sh",
  bearer: process.env["LATITUDESH_BEARER"] ?? "",
});

async function run() {
  const result = await latitudesh.apiKeys.list();

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to:

  • route requests through a proxy server using undici's ProxyAgent
  • use the "beforeRequest" hook to add a custom header and a timeout to requests
  • use the "requestError" hook to log errors
import { Latitudesh } from "latitudesh-typescript-sdk";
import { ProxyAgent } from "undici";
import { HTTPClient } from "latitudesh-typescript-sdk/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Latitudesh({ httpClient: httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

Warning

Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Latitudesh } from "latitudesh-typescript-sdk";

const sdk = new Latitudesh({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable LATITUDESH_DEBUG to true.

About

💻 Latitude.sh's Typescript SDK - Fetch resources and perform actions on Latitude.sh on your project.

latitude.sh

Topics

sdk bare-metal

Resources

Readme

License

MIT license

Contributing

Contributing
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

1 fork
Report repository

Releases 16

typescript - v0.3.9 - 2026-04-10 15:05:41 Latest
Apr 10, 2026
+ 15 releases

Packages

 
 
 

Contributors

Languages