@filooapp/sdk

Official TypeScript SDK for the Filoo URL shortener API.

Install

npm install @filooapp/sdk

Quick start

import { Filoo } from '@filooapp/sdk';

const filoo = new Filoo({ apiKey: process.env.FILOO_KEY! });

const link = await filoo.links.create({
  destination: 'https://example.com/long-url',
  username: 'myname',
  slug: 'campaign-1',
});

console.log(link.short_url); // → https://filoo.app/myname/campaign-1

Available methods

• filoo.me()
• filoo.usage()
• filoo.usernames()
• filoo.links.create({...})
• filoo.links.list({ limit, cursor })
• filoo.links.get(code)
• filoo.links.update(code, {...})
• filoo.links.delete(code)
• filoo.links.stats(code)

Tier requirement

The Filoo API is available on Pro (€9/month, 100 req/min) and Agents (€29/month, 1000 req/min) plans. Get a key at filoo.app/dashboard/api-keys.

Errors

FilooError is thrown on non-2xx responses. Check error.status (number) and error.body (raw response text).

try {
  await filoo.links.create({ destination: '...' });
} catch (e) {
  if (e instanceof FilooError && e.status === 429) {
    console.log('Rate limited, retry later');
  }
}

License

MIT