Skip to main content

Unofficial client for the Porkbun API

Project description


Unofficial client for the Porkbun API

PyPI PyPI - Python Version Downloads GitHub GitHub Workflow Status

Table of Contents

  1. About
  2. Installation
    1. With pip (recommend)
    2. From source
  3. Usage
  4. Third party notices
  5. License


pkb_client is an unofficial client for the Porkbun API. It supports the v3 of the API. You can find the official documentation of the Porkbun API here.


This project only works with Python 3, make sure you have at least Python 3.6 installed.

With pip (recommend)

Use the following command to install pkb_client with pip:

pip3 install pkb_client

You can also very easily update to a newer version:

pip3 install pkb_client -U

From source

git clone
cd pkb_client
pip install .


Each request must be made with the API key and secret. You can easily create them at Porkbun. Just follow the official instructions. Make sure that you explicitly activate the API usage for your domain at the end.

After installation pkb_client is available under the command pkb-client.

You have to specify your API key and secret each time as follows:

pkb-client -k <YOUR-API-KEY> -s <YOUR-API-SECRET> ping

If you don't want to specify the key and secret in the program call, because for example the command line calls are logged and you don't want to log the API access, then you can also omit both arguments and pkb-client asks for a user input.

You can see an overview of all usable API methods via the help:

pkb-client -h

If you need more help on a supported API method, you can use the following command, for example for the ping method:

pkb-client ping -h

Here are a few usage examples:

Create a new TXT record for the subdomain test of the domain with the value porkbun is cool and a TTL of 500:

pkb-client -k <YOUR-API-KEY> -s <YOUR-API-KEY-SECRET> dns-create TXT "porkbun is cool" --name test --ttl 500

The call returns the DNS record id. The record DNS ids are used to distinguish the DNS records and can be used for editing or deleting records. The ID is only a Porkbun internal identifier and is not publicly available.

Delete the DNS record with the ID 12345 of the domain

pkb-client -k <YOUR-API-KEY> -s <YOUR-API-SECRET> dns-delete 12345

Get all DNS records of the domain

pkb-client -k <YOUR-API-KEY> -s <YOUR-API-SECRET> dns-retrieve

Change the TXT DNS record content with the ID 456789 of the domain to the answer is 42:

pkb-client -k <YOUR-API-KEY> -s <YOUR-API-SECRET> dns-edit 456789 TXT "the answer is 42"

Exporting all current DNS records of the domain to the file dns_recods.json:

pkb-client -k <YOUR-API-KEY> -s <YOUR-API-SECRET> dns-export dns_recods.json

Remove all existing DNS records of the domain and restore the DNS records from the file dns_recods.json:

pkb-client -k <YOUR-API-KEY> -s <YOUR-API-SECRET> dns-import dns_recods.json clear

Note: The import function uses the record ID to distinguish DNS records.

Third party notices

All modules used by this project are listed below:

Name License
requests Apache 2.0
setuptools MIT

Furthermore, this readme file contains embeddings of and PePy. The tests use ipify.


MIT - Copyright (c) Marvin Heptner

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pkb_client-1.2.tar.gz (12.3 kB view hashes)

Uploaded source

Built Distribution

pkb_client-1.2-py3-none-any.whl (12.4 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page