Quickstart

Get your first API call running in under 5 minutes. You need a free LK API account and your API key.

1. Install the SDK

bash
$ npm install @apivault/sdk

2. Make your first call

javascript
import { APIVault } from '@apivault/sdk'
    const vault = new APIVault({ apiKey: 'ak_live_••••••••' })
    const loc = await vault.geolocate.lookup('8.8.8.8')
    console.log(loc.city) // "Mountain View"
Find your API key in Dashboard → API Keys after signing in.

Authentication

All requests must include your API key in the Authorization header using the Bearer scheme.

http
Authorization: Bearer ak_live_••••••••
    Content-Type: application/json
Never expose your API key in client-side code. Use environment variables.

Rate Limits

Rate limits are applied per API key and reset every calendar month. Exceeding your quota returns 429 Too Many Requests.

Plan Monthly Requests Requests/sec
Free 1,000 —
Standard 5,000 —
Premium 10,000 —

GeoLocate API

Look up location data from an IP address — country, region, city, timezone, and coordinates.

GET/v1/geo/ip/{address}Look up an IP
Parameter Type Description
address required string IPv4 or IPv6 address
fields string Comma-separated fields (default: all)

PayStream API

Process payments, refunds, and manage transactions with multi-currency support.

POST/v1/payment/chargeCharge a payment method
Parameter Type Description
amount required integer Amount in cents
currency required string ISO 4217 currency code
source required string Payment method token

Error Codes

All errors return JSON with error.code and error.message fields.

HTTP Code Description
400 bad_request Missing or invalid parameters
401 unauthorized Invalid or missing API key
403 forbidden API not in your plan
429 rate_limited Monthly limit exceeded
500 server_error Internal server error