API Reference

Authorization: Bearer YOUR_API_KEY

X-API-Key: YOUR_API_KEY

GET /domains/search

{
  "available": [
    { "domain": "example.com", "price": 12.99, "isPremium": false },
    { "domain": "example.io", "price": 49.99, "isPremium": false }
  ],
  "unavailable": [
    { "domain": "example.org" }
  ]
}

GET /domains/availability

POST /domains/register

{
  "domainName": "example.com",
  "years": 1,
  "registrant": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@example.com",
    "phone": "+1.4155551234",
    "address": "123 Main St",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94102",
    "country": "US"
  },
  "whoisPrivacy": true,
  "autoRenew": true
}

GET /domains

GET /domains/{domainName}

POST /domains/{domainName}/renew

{
  "years": 1
}

PATCH /domains/{domainName}/settings

{
  "autoRenew": true,
  "whoisPrivacy": true,
  "registrarLock": true
}

GET /domains/{domainName}/auth-code

PUT /domains/{domainName}/nameservers

{
  "nameservers": [
    "ns1.example.com",
    "ns2.example.com"
  ]
}

GET /domains/{domainName}/contacts

PUT /domains/{domainName}/contacts/{contactType}

GET /domains/{domainName}/dns

POST /domains/{domainName}/dns

{
  "type": "A",
  "name": "@",
  "value": "203.0.113.1",
  "ttl": 3600
}

PATCH /domains/{domainName}/dns/{recordId}

DELETE /domains/{domainName}/dns/{recordId}

POST /domains/{domainName}/dns/presets

{
  "preset": "TRANSACTIONAL_EMAIL"
}

POST /domains/{domainName}/dnssec/enable

POST /domains/{domainName}/dnssec/disable

GET /domains/{domainName}/dnssec

GET /domains/{domainName}/dnssec/ds

POST /domains/transfer

{
  "domainName": "example.com",
  "authCode": "abc123",
  "registrant": { ... }
}

GET /domains/transfers/{transferId}

DELETE /domains/transfers/{transferId}

POST /domains/webhooks

{
  "url": "https://yourapp.com/webhooks/domains",
  "events": ["domain.registered", "domain.expiring_soon"]
}

GET /domains/webhooks

DELETE /domains/webhooks/{webhookId}

import { Transactional } from '@usetransactional/node';
 
const client = new Transactional({
  apiKey: process.env.TRANSACTIONAL_API_KEY,
});
 
// Search
const results = await client.domains.search('mycompany');
const availability = await client.domains.checkAvailability('example.com');
 
// Register
const domain = await client.domains.register({
  domainName: 'example.com',
  years: 1,
  registrant: { ... },
});
 
// List & Get
const domains = await client.domains.list();
const domain = await client.domains.get('example.com');
 
// Settings
await client.domains.updateSettings('example.com', { autoRenew: true });
 
// DNS
const records = await client.domains.dns.list('example.com');
await client.domains.dns.create('example.com', { type: 'A', name: '@', value: '...' });
await client.domains.dns.update('example.com', recordId, { value: '...' });
await client.domains.dns.delete('example.com', recordId);
await client.domains.dns.applyPreset('example.com', { preset: 'TRANSACTIONAL_EMAIL' });
 
// DNSSEC
await client.domains.dnssec.enable('example.com');
await client.domains.dnssec.disable('example.com');
const status = await client.domains.dnssec.getStatus('example.com');
 
// Webhooks
const webhook = await client.domains.webhooks.create({ url, events });

from usetransactional import Transactional
 
client = Transactional(api_key="your_api_key")
 
# Search
results = client.domains.search("mycompany")
availability = client.domains.check_availability("example.com")
 
# Register
domain = client.domains.register(
    domain_name="example.com",
    years=1,
    registrant={ ... },
)
 
# List & Get
domains = client.domains.list()
domain = client.domains.get("example.com")
 
# Settings
client.domains.update_settings("example.com", auto_renew=True)
 
# DNS
records = client.domains.dns.list("example.com")
client.domains.dns.create("example.com", type="A", name="@", value="...")
client.domains.dns.update("example.com", record_id, value="...")
client.domains.dns.delete("example.com", record_id)
client.domains.dns.apply_preset("example.com", preset="TRANSACTIONAL_EMAIL")
 
# DNSSEC
client.domains.dnssec.enable("example.com")
client.domains.dnssec.disable("example.com")
status = client.domains.dnssec.get_status("example.com")
 
# Webhooks
webhook = client.domains.webhooks.create(url=url, events=events)

{
  "id": "evt_xxx",
  "type": "domain.registered",
  "timestamp": "2024-01-15T10:30:00.000Z",
  "data": {
    "domain": {
      "domainName": "example.com",
      "status": "ACTIVE",
      "expiresAt": "2025-01-15T00:00:00.000Z"
    }
  }
}