Skip to main content

Porkbun

@shrug/porkbunv2026.10.31.1· MIT· 1d agoBEHAVIORS
01README

Porkbun registrar and DNS API (v3) read-only provider model: validate credentials and snapshot domains, nameservers, DNS records, contacts, DNSSEC, availability, and pricing. Body auth (vaulted apikey+secretapikey) lives in a single injectable fetch seam; every request is a POST gated on the SUCCESS/ERROR envelope. Reads only - no registration, renewal, or record mutations.

02Behaviors1
@shrug/porkbunv2026.10.31.1porkbun.ts
fn validateCredentials()
Credential probe: POST /ping. Succeeds only on a SUCCESS envelope;
fn listDomains()
Snapshot every domain in the account (POST /domain/listAll, paged by
fn getDomain()
Resolve a single domain's detail. Derived from `/domain/listAll` by
fn getNameservers()
Snapshot a domain's authoritative nameservers (POST
fn listRecords()
Snapshot a domain's DNS records (POST /dns/retrieve/{domain}).
fn getContacts()
Snapshot a domain's registrant/admin/tech/billing contacts (POST
fn getDnssec()
Snapshot a domain's DNSSEC records (POST
fn checkAvailability()
Check a domain's availability + price (POST
fn getPricing()
Snapshot Porkbun's per-TLD default pricing (POST /pricing/get).

Resources

ping(infinite)— The credential-probe result (`/ping`): checkedAt + the egress yourIp
domain-list(infinite)— A snapshot of the account's domains (`/domain/listAll`, paged)
domain(infinite)— A single domain's detail, derived from `/domain/listAll` by name
nameservers(infinite)— A domain's authoritative nameservers (`/domain/getNs`)
records(infinite)— A domain's DNS records (`/dns/retrieve`)
contacts(infinite)— A domain's registrant/admin/tech/billing contacts
dnssec(infinite)— A domain's DNSSEC records (`/dns/getDnssecRecords`)
availability(infinite)— A domain's availability + price (`/domain/checkDomain`)
pricing(infinite)— Per-TLD registration/renewal/transfer pricing (`/pricing/get`)
03Stats
A
100 / 100
Downloads
0
Archive size
14.1 KB
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Docs keep secrets in a vault1/1earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License2/2earned
  • Verified public repository2/2earned
04Platforms
05Labels