---
title: "Altss developer reference."
description: "Read Altss public catalogs, schemas and Markdown with the JavaScript client or CLI. Copy working requests, connect documentation MCP and install research skills."
canonical: "https://altss.com/developers"
last-updated: "2026-10-22T13:41:49.402Z"
---

# Altss developer reference.

Read Altss public catalogs, schemas and documents with JavaScript, the command line or HTTP. Connect documentation MCP or install a focused research skill.

Last modified: 2026-10-22T13:41:49.402Z

## Start with a public read

Published catalogs describe fields, commercial terms and manually reviewed tasks. GET and HEAD require no account or token. These resources contain public descriptions and schemas; subscription records and task execution stay within their existing access controls.

## JavaScript SDK and command-line client

The Altss public client reads named catalogs, JSON Schemas and Markdown documents. It includes TypeScript declarations and requires Node.js 22 or newer. Each read makes one GET to an allowlisted public Altss resource, with a bounded timeout, no credentials and no automatic retries.

## Install the published client

Install the tested GitHub release into your project. This command uses the public repository; an npm registry listing is not required.

```bash
npm install --ignore-scripts github:Altssdata/public-client#v0.1.0
```

## Read with the JavaScript client

The same import works with TypeScript. A conditional 304 returns data: null; reuse the representation associated with the ETag you supplied.

```javascript
import { AltssPublicClient } from "altss-public-client";

const client = new AltssPublicClient({ timeoutMs: 10000 });
const response = await client.getCatalog("data");
if (response.status === 200) console.log(response.data);
```

## Read from the command line

After installation, run the local CLI to read public resources. Commands print a JSON envelope; help and resource enumeration work offline.

```bash
npx --no-install altss-public catalog data
npx --no-install altss-public schema company
npx --no-install altss-public document pricing
npx --no-install altss-public resources
```

## Client source and releases

- [Altss public client repository](https://github.com/Altssdata/public-client): Source, TypeScript API, conditional reads, response limits, error handling and tests.
- [Version 0.1.0 release](https://github.com/Altssdata/public-client/releases/tag/v0.1.0): Tagged source and the packaged JavaScript SDK and CLI.
- [Report a client issue](https://github.com/Altssdata/public-client/issues): Include the resource name and observed behavior. Omit credentials and private records.

## Read the data catalog

This request returns JSON field descriptions. Use the versioned base URL for new integrations.

```bash
curl --fail-with-body --silent --show-error \
  --header "Accept: application/json" \
  "https://altss.com/api/v1/data-catalog.json"
```

## Public HTTP resources

- [OpenAPI specification](https://altss.com/openapi.json): Operation IDs, response schemas, examples, supported methods and versioning policy.
- [Data catalog](https://altss.com/api/v1/data-catalog.json): Entity and field definitions, availability and access labels.
- [Task catalog](https://altss.com/api/v1/task-catalog.json): Inputs, outputs and maximum scope of manually reviewed tasks.
- [Commercial catalog](https://altss.com/api/v1/commercial-catalog.json): Current public products, prices, terms and purchase routes.
- [API discovery catalog](https://altss.com/.well-known/api-catalog): The actual resource URLs and their specification, in RFC 9727 linkset format.

## Use the catalog in JavaScript

Native fetch works in current browsers and Node.js. Check the status before parsing; keep timeouts bounded.

```javascript
const response = await fetch(
  "https://altss.com/api/v1/data-catalog.json",
  { headers: { Accept: "application/json" }, signal: AbortSignal.timeout(10000) }
);
if (!response.ok) throw new Error("Altss HTTP " + response.status);
const catalog = await response.json();
console.log(catalog.entities.map(entity => entity.label));
```

## Handle responses correctly

- Retain the ETag from a successful response and send it in If-None-Match on the next request. A 304 has no body; reuse your stored representation.
- Read current Cache-Control and Retry-After headers. Back off after temporary failures. No numeric request allowance is published.
- A catalog's update date describes that document. Field availability and source dates remain specific to each underlying record.
- The original root catalog URLs remain supported. Use /api/v1 for the versioned descriptive contract and consult the OpenAPI document before relying on an operation.

## Inspect JSON Schemas

Each link returns a schema document, with its permitted fields and evidence structure.

- [company.json](https://altss.com/api/v1/schemas/company.json)
- [organization.json](https://altss.com/api/v1/schemas/organization.json)
- [family-office.json](https://altss.com/api/v1/schemas/family-office.json)
- [institutional-investor.json](https://altss.com/api/v1/schemas/institutional-investor.json)
- [person.json](https://altss.com/api/v1/schemas/person.json)
- [fund.json](https://altss.com/api/v1/schemas/fund.json)
- [transaction.json](https://altss.com/api/v1/schemas/transaction.json)
- [relationship.json](https://altss.com/api/v1/schemas/relationship.json)
- [commitment.json](https://altss.com/api/v1/schemas/commitment.json)
- [event.json](https://altss.com/api/v1/schemas/event.json)
- [evidence.json](https://altss.com/api/v1/schemas/evidence.json)
- [task-result.json](https://altss.com/api/v1/schemas/task-result.json)

## Request a page as Markdown

The canonical URL supports explicit Accept negotiation. The .md alternate is also available, and citations should retain the canonical HTML URL.

```bash
curl --fail-with-body --silent --show-error \
  --header "Accept: text/markdown" \
  "https://altss.com/pricing"
```

## Read and cite published material

- [Public document index](https://altss.com/llms.txt)
- [Agent reading guidance](https://altss.com/agents.md)
- [Public access and authentication](https://altss.com/auth.md)
- [Methodology](https://altss.com/methodology)
- [Developer reference as Markdown](https://altss.com/developers.md)

## Connect to the documentation MCP

Add https://docs.altss.com/mcp as a remote HTTP MCP server in a client that supports it. The server reads public technical documentation without an API key.

Inspect tools/list after initialization to see the provider's current tool names and descriptions. Documentation retrieval and provider feedback are distinct operations; feedback can write to the provider. The endpoint does not query subscription records or execute paid tasks.

## Documentation MCP connection

Clients use different configuration formats. These are the remote server connection details to enter in your client's MCP setup.

```json
{
  "name": "Altss Documentation",
  "url": "https://docs.altss.com/mcp",
  "transport": "streamable-http",
  "authentication": "none for public documentation"
}
```

## Verify the publisher

- [Official Altss public skill repository](https://github.com/Altssdata/skills)
- [Altss Documentation MCP registry record](https://registry.modelcontextprotocol.io/v0.1/servers/io.github.altss-data%2Fdocs/versions/1.0.0)
- [Altss Documentation MCP on Glama](https://glama.ai/mcp/connectors/io.github.altss-data/docs)

## Install an Altss skill

This installs the public research instructions into the current Codex project. Choose a focused skill below for profile verification or listing preparation.

```bash
npx --yes skills@1.7.4 add Altssdata/skills \
  --skill altss-public-research --agent codex --yes
```

## Choose the workflow

- [Public research](https://altss.com/skills/altss-public-research/SKILL.md): Read the right public source and return evidence with canonical citations.
- [Profile verification](https://altss.com/skills/altss-profile-verification/SKILL.md): Check identity, source dates, contradictions and unknowns before proposing a correction.
- [Listing preparation](https://altss.com/skills/altss-listing-preparation/SKILL.md): Prepare a Basic, Enhanced or correction email for manual review.
- [All three skills on skills.sh](https://skills.sh/altssdata/skills)

[Open the API specification](https://altss.com/openapi.json)

[Read technical documentation](https://docs.altss.com/)

Canonical URL: https://altss.com/developers