@signalhouse/sdk

A lightweight Node.js SDK for the Signal House platform.

Installation

npm install @signalhouse/sdk

Agent skills

The package bundles the Signal House agent skills, which teach a coding agent the order the platform enforces, what carriers require, and what a send cannot do before a campaign is approved.

If your project already has a .claude/ or .agents/ directory, installing the SDK offers to copy them in. Otherwise, install them yourself:

npx signalhouse-skills            # install into the current project
npx signalhouse-skills --force    # create the agent directory if the project has none yet
npx signalhouse-skills --path ..  # install somewhere else

The installer only ever writes inside the project, never your home directory, and never overwrites a skill you have edited. Set SIGNALHOUSE_SKILLS=0 to turn it off, or SIGNALHOUSE_SKILLS=1 to install during a postinstall into a project that has no agent directory yet. The automatic postinstall is skipped in CI; running the command yourself is not.

Quick Start

import { SignalHouseSDK } from '@signalhouse/sdk';

const sdk = new SignalHouseSDK({
  apiKey: 'your-api-key',
  baseUrl: 'api url'
});

const token = await sdk.auth.login({
    email: 'youremail',
    password: 'yourpassword'
});

console.log(token);

Features Full support for Signal House API v2 Integrated Axios with standardized returns Lightweight and tree-shakeable

Documentation For full API reference and advanced usage, visit https://api.signalhouse.io

License ISC © Signal House

Geographic availability search

The availability path supports optional city as a case-insensitive prefix within an explicit country (CA or US) and state (province/state code). City must be supplied with both country and state. Example: getAvailablePhoneNumbers({ country: "CA", state: "QC", city: "Charny", npa: "367", nxx: "883", limit: 10 }). Canadian province, city, NPA and NXX matches are checked before the result limit; unrelated substring matches are excluded. Availability may change before purchase.

Canadian message estimates return per-recipient phoneNumber, rate, amount and fallback, plus segment count and total in microdollars. They use cached carrier information without exposing carrier names or making a paid lookup. Rates remain 75,500 for standard carriers and 81,000 for Ice Wireless/Iristel or unresolved carriers; MMS/group MMS use one segment per recipient.

Available-number searches return { numbers, numberCount? }. numberCount is omitted when the total is unknown, including Canadian geographic and US city searches; the page length is not a total. These filtered searches have a 20-second discovery deadline and return HTTP 503 when incomplete. Narrow the location/NPA/NXX or retry later. Successful Infobip samples may be cached for 15 seconds across pages; purchase rechecks availability.