{"id":24540800,"url":"https://github.com/code-gio/porkbun-js","last_synced_at":"2026-02-19T15:35:50.913Z","repository":{"id":265473063,"uuid":"895593809","full_name":"code-gio/porkbun-js","owner":"code-gio","description":null,"archived":false,"fork":false,"pushed_at":"2024-11-29T14:09:36.000Z","size":37,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-29T09:49:49.241Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/code-gio.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-28T13:54:35.000Z","updated_at":"2024-11-29T14:09:40.000Z","dependencies_parsed_at":"2024-11-29T22:16:40.685Z","dependency_job_id":null,"html_url":"https://github.com/code-gio/porkbun-js","commit_stats":null,"previous_names":["code-gio/porkbun-js"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/code-gio/porkbun-js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-gio%2Fporkbun-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-gio%2Fporkbun-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-gio%2Fporkbun-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-gio%2Fporkbun-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/code-gio","download_url":"https://codeload.github.com/code-gio/porkbun-js/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-gio%2Fporkbun-js/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29620144,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-19T13:04:20.082Z","status":"ssl_error","status_checked_at":"2026-02-19T13:03:33.775Z","response_time":117,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-22T18:14:56.505Z","updated_at":"2026-02-19T15:35:50.896Z","avatar_url":"https://github.com/code-gio.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Porkbun JS\n\nA TypeScript client for the Porkbun API v3.\n\n## Installation\n\n```bash\nnpm install porkbun-js\n```\n\n## Usage\n\n```typescript\nimport { PorkbunAPI } from 'porkbun-js';\n\nconst client = new PorkbunAPI({\n  apiKey: 'YOUR_API_KEY',\n  secretApiKey: 'YOUR_SECRET_API_KEY'\n});\n\n// Domain operations\nconst domains = await client.domain.listAll();\nconst nameservers = await client.domain.getNameServers('example.com');\n\n// DNS operations\nconst dnsRecords = await client.dns.retrieve('example.com');\nawait client.dns.create('example.com', {\n  type: 'A',\n  name: 'www',\n  content: '1.1.1.1'\n});\n\n// SSL operations\nconst sslBundle = await client.ssl.retrieve('example.com');\n```\n\n## API Documentation\n\n### Domain Module\n- `listAll(options?: DomainListOptions)`: List all domains\n- `getNameServers(domain: string)`: Get domain nameservers\n- `updateNameServers(domain: string, nameservers: string[])`: Update nameservers\n- `addUrlForward(domain: string, options: URLForwardingOptions)`: Add URL forwarding\n- `getUrlForwarding(domain: string)`: Get URL forwarding settings\n- `deleteUrlForward(domain: string, id: string)`: Delete URL forwarding\n- `ping()`: Test API connectivity\n\n### DNS Module\n- `create(domain: string, options: DNSCreateOptions)`: Create DNS record\n- `edit(domain: string, id: string, options: DNSEditOptions)`: Edit DNS record\n- `delete(domain: string, id: string)`: Delete DNS record\n- `retrieve(domain: string, id?: string)`: Get DNS records\n- `retrieveByNameType(domain: string, type: DNSRecordType, subdomain: string)`: Get records by type\n- `editByNameType(domain: string, type: DNSRecordType, subdomain: string, options: DNSEditOptions)`: Edit by type\n- `deleteByNameType(domain: string, type: DNSRecordType, subdomain: string)`: Delete by type\n\n### SSL Module\n- `retrieve(domain: string)`: Get SSL certificate bundle\n\n## License\n\nMIT\n\n## Contributing\n\nPRs welcome! Please read our contributing guidelines first.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcode-gio%2Fporkbun-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcode-gio%2Fporkbun-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcode-gio%2Fporkbun-js/lists"}