Specify Publisher SDK

JavaScript SDK for Specify Publishers to serve targeted content based on wallet addresses

Now in beta!

The Specify Publisher SDK enables publishers to serve targeted ad content to users based on their wallet addresses.

Installation

# Using bun
bun add @specify-sh/sdk

# Using npm
npm install @specify-sh/sdk

# Using yarn
yarn add @specify-sh/sdk

Basic Usage

import Specify, { AuthenticationError, ValidationError } from "@specify-sh/sdk";

// Initialize with your publisher key
const specify = new Specify({
  publisherKey: "your_publisher_key",
});

// Serve content based on wallet address
async function serveContent() {
  try {
    const walletAddress = "0x1234567890123456789012345678901234567890";
    const content = await specify.serve(walletAddress);
  } catch (error) {
    if (error instanceof AuthenticationError) {
      // Handle authentication errors
    } else if (error instanceof ValidationError) {
      // Handle validation errors
    } else {
        // Handle other errors
    }
  }
}

serveContent();

API Reference

`new Specify(config)`

Creates a new instance of the Specify client.

config.publisherKey - Your publisher API key (required, format: spk_ followed by 30 alphanumeric characters)

`specify.serve(address)`

Serves content based on the provided wallet address.

address - Ethereum or EVM-compatible wallet address (format: 0x followed by 40 hexadecimal characters)
Returns: Promise resolving to ad content object

Build from Source

Requirements:

# Clone the repository
git clone https://github.com/internetcommunitycompany/specify-publisher-sdk.git
cd specify-publisher-sdk

# Install dependencies
bun install

# Run tests
bun test

# Build the library (output to dist directory)
bun run build

Examples

Check out our examples repository for complete implementation examples in different frameworks and environments.

License

MIT

Package detail

@specify-sh/sdk

readme