Vepler API Documentation

Requirements

Before installing the Vepler SDK, ensure you have:

Node.js 18.0 or higher
npm, yarn, pnpm, or bun package manager
A Vepler API key (get one here)

Installation

Choose your preferred package manager:

npm
yarn
pnpm
bun

npm install @vepler/sdk

yarn add @vepler/sdk

pnpm add @vepler/sdk

bun add @vepler/sdk

Verify Installation

Check that the SDK is installed correctly:

npm list @vepler/sdk

Basic Setup

1. Import the SDK

import { SDK } from '@vepler/sdk';

const { SDK } = require('@vepler/sdk');

2. Initialise with API Key

const vepler = new SDK({
  apiKey: 'vpr_live_abc123...'
});

3. Make Your First Call

const response = await vepler.property.getV1PropertyLocationIds({
  locationIds: 'p_0x000123456789'
});

if (response.propertyListResponse) {
  console.log(response.propertyListResponse.result);
}

Environment Variables

Never hardcode API keys in your source code. Use environment variables instead.

Create .env File

.env

VEPLER_API_KEY=vpr_live_abc123...

Load Environment Variables

import dotenv from 'dotenv';
import { SDK } from '@vepler/sdk';

dotenv.config();

const vepler = new SDK({
  apiKey: process.env.VEPLER_API_KEY!
});

// Environment variables loaded automatically
import { SDK } from '@vepler/sdk';

const vepler = new SDK({
  apiKey: process.env.VEPLER_API_KEY!
});

import { SDK } from '@vepler/sdk';

const vepler = new SDK({
  apiKey: import.meta.env.VITE_VEPLER_API_KEY
});

Framework-Specific Setup

Next.js

// app/lib/vepler.ts
import { SDK } from '@vepler/sdk';

const vepler = new SDK({
  apiKey: process.env.VEPLER_API_KEY!
});

export default vepler;

// app/api/property/route.ts
import vepler from '@/lib/vepler';

export async function GET(request: Request) {
  const response = await vepler.property.getV1PropertyLocationIds({
    locationIds: 'p_0x000123456789'
  });
  return Response.json(response.propertyListResponse);
}

Express.js

// src/config/vepler.ts
import { SDK } from '@vepler/sdk';

const vepler = new SDK({
  apiKey: process.env.VEPLER_API_KEY!
});

export default vepler;

// src/routes/property.ts
import express from 'express';
import vepler from '../config/vepler';
const router = express.Router();

router.get('/property/:id', async (req, res) => {
  try {
    const response = await vepler.property.getV1PropertyLocationIds({
      locationIds: req.params.id
    });
    res.json(response.propertyListResponse);
  } catch (error) {
    res.status(500).json({ error: (error as Error).message });
  }
});

NestJS

// vepler.module.ts
import { Module, Global } from '@nestjs/common';
import { SDK } from '@vepler/sdk';

@Global()
@Module({
  providers: [
    {
      provide: 'VEPLER_SDK',
      useFactory: () => {
        return new SDK({
          apiKey: process.env.VEPLER_API_KEY!
        });
      }
    }
  ],
  exports: ['VEPLER_SDK']
})
export class VeplerModule {}

// property.service.ts
import { Injectable, Inject } from '@nestjs/common';
import { SDK } from '@vepler/sdk';

@Injectable()
export class PropertyService {
  constructor(@Inject('VEPLER_SDK') private vepler: SDK) {}

  async getProperty(id: string) {
    return this.vepler.property.getV1PropertyLocationIds({
      locationIds: id
    });
  }
}

TypeScript Configuration

The SDK includes TypeScript definitions. Recommended tsconfig settings:

tsconfig.json

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "commonjs",
    "lib": ["ES2020"],
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "moduleResolution": "node"
  }
}

Troubleshooting

Module not found error

Ensure the package is installed:

npm install @vepler/sdk

Clear your package manager cache:

npm cache clean --force

TypeScript errors

Update TypeScript to latest version:

npm install -D typescript@latest

Ensure your tsconfig.json has:

{
  "compilerOptions": {
    "moduleResolution": "node",
    "esModuleInterop": true
  }
}

API key not working

Check that:

The key starts with vpr_live_
No extra spaces or quotes around the key
The key has not expired

Version Management

Check Installed Version

npm list @vepler/sdk

Update to Latest

npm update @vepler/sdk

Next Steps

TypeScript Guide

Full SDK usage guide

Examples

See working examples

Authentication

Authentication details

API Reference

Full endpoint documentation

​Requirements

​Installation

​Verify Installation

​Basic Setup

​1. Import the SDK

​2. Initialise with API Key

​3. Make Your First Call

​Environment Variables

​Create .env File

​Load Environment Variables

​Framework-Specific Setup

​TypeScript Configuration

​Troubleshooting

​Version Management

​Check Installed Version

​Update to Latest

​Next Steps

TypeScript Guide

Examples

Authentication

API Reference

Requirements

Installation

Verify Installation

Basic Setup

1. Import the SDK

2. Initialise with API Key

3. Make Your First Call

Environment Variables

Create .env File

Load Environment Variables

Framework-Specific Setup

TypeScript Configuration

Troubleshooting

Version Management

Check Installed Version

Update to Latest

Next Steps