Official SDKs

Official client libraries for FreeCustom.Email. Full API coverage, typed responses, built-in WebSocket, and real-time OTP extraction — ready in under 30 seconds.

Start in 30 secondsJavaScript
01

Install

npm install freecustom-email
02

Import + init

import { FreecustomEmailClient } from 'freecustom-email';
const client = new FreecustomEmailClient({ apiKey: process.env.FCE_API_KEY });
03

Register + get OTP

await client.inboxes.register('test@ditapi.info');
const otp = await client.otp.waitFor('test@ditapi.info');

Available SDKs

npmJavaScript / TypeScript
v1.0.0
$npm install freecustom-email
  • Full TypeScript types
  • ESM + CommonJS dual build
  • Async-first API
  • Auto-reconnect WebSocket
  • Typed error classes
import { FreecustomEmailClient } from 'freecustom-email';

const client = new FreecustomEmailClient({ apiKey: 'fce_...' });

// Get OTP in one line
const otp = await client.otp.waitFor('test@ditapi.info');
console.log(otp); // '847291'
PyPIPython
v1.0.0
$pip install freecustom-email
  • Async (asyncio) + sync modes
  • Full type annotations
  • dataclass response models
  • Auto-reconnect WebSocket
  • Typed exception hierarchy
from freecustom_email import FreeCustomEmail
import asyncio

client = FreeCustomEmail(api_key="fce_...")

async def main():
    otp = await client.otp.wait_for("test@ditapi.info")
    print(otp)  # '847291'

asyncio.run(main())

What's covered

Both SDKs cover the full API surface — every endpoint, every response type, and the real-time WebSocket layer.

ResourceMethods
client.inboxesregister, list, unregister
client.messageslist, get, delete, waitFor
client.otpget, waitFor
client.domainslist, listWithExpiry, listCustom, addCustom, verifyCustom, removeCustom
client.webhooksregister, list, unregister
client.accountinfo, usage
client.analyticstimeline, insights
client.realtimeWebSocket client (on, once, connect, disconnect, wait)

Using another language?

Any HTTP client works with the REST API. See the Quickstart for cURL, Go, and Ruby examples. The OpenAPI spec can generate a client in 50+ languages via openapi-generator.