DocsSDKs & LibrariesTypeScript / Node.js SDK

TypeScript / Node.js SDK

Official TypeScript/JavaScript SDK for Node.js, Bun, and Deno.

Updated: July 20261 min read

Installation

Install @addressvalid/sdk via your preferred package manager:

1
2
3
bun add @addressvalid/sdk
# or
npm install @addressvalid/sdk

Usage Example

Initialize the client and call address methods with full TypeScript autocomplete:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
import { AddressValid } from '@addressvalid/sdk';

const client = new AddressValid({
  apiKey: process.env.ADDRESSVALID_API_KEY!,
});

async function main() {
  const result = await client.address.autocomplete({
    query: '14 Admiralty Way',
    country: 'NG',
  });

  console.log('Suggestions:', result.data);
}

main();

Was this documentation page helpful?

Your feedback helps us continuously improve our developer docs.

PreviousWebhooks & Event Subscriptions NextPython SDK