Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

Client for DNSimple REST API

Project Description

Python DNSimple

## Introduction

This is a client for the DNSimple REST API. It currently allows you to fetch
existing domain info, as well as register new domains and manage domain

`dnsimple-python` works for both python 2 & 3.

### Getting started

You'll need the `json` module that is included with python version 2.6 and
later, or the `simplejson` module if you are using an earlier version.

`dnsimple-python` also depends on the `requests` library.

Import the module:

from dnsimple import DNSimple

You can provide your DNSimple credentials in one of two ways:

1. Provide username/password or email/api\_token credentials programmatically:

# Use username/password authentication: HTTP Basic
dns = DNSimple(username=YOUR_USERNAME, password=YOUR_PASSWORD)

# Use email/api_token credentials
dns = DNSimple(email=YOUR_EMAIL_ADDRESS, api_token=YOUR_API_TOKEN)

2. Store you username/password or email/api\_token credentials in a file called
`.dnsimple` in the current directory with the following data:

password: yourpassword


api_token: yourapitoken

Or (assuming `$DNSIMPLE_EMAIL` and `$DNSIMPLE_TOKEN` are environment variables):

api_token: %(DNSIMPLE_TOKEN)s

You then need not provide any credentials when constructing `DNSimple`:

dns = DNSimple()

## Domain Operations

### Check out your existing domains:

Just run:

domains =

Results appear as a Python dict:

{'domain': {'created_at': '2010-10-14T09:45:32Z',
'expires_at': '10/14/2011 5:45:00 AM',
'id': 999,
'last_enom_order_id': None,
'name': '',
'name_server_status': 'active',
'registrant_id': 99,
'registration_status': 'registered',
'updated_at': '2010-10-14T10:00:14Z',
'user_id': 99}},
{'domain': {'created_at': '2010-10-15T16:02:34Z',
'expires_at': '10/15/2011 12:02:00 PM',
'id': 999,
'last_enom_order_id': None,
'name': '',
'name_server_status': 'active',
'registrant_id': 99,
'registration_status': 'registered',
'updated_at': '2010-10-15T16:30:16Z',
'user_id': 99}}]

### Get details for a specific domain


Results are the same as `domains()` above, but only show the domain specified.

### Check whether a domain is available


# Hmm, looks like I'm too late to get that one...
{u'currency': u'USD',
u'currency_symbol': u'$',
u'minimum_number_of_years': 1,
u'name': u'',
u'price': u'14.00',
u'status': u'unavailable'}

### Register a new domain


This will register '', automatically picking the registrant\_id
from your first domain. To specify a particularly `registrant_id`, just run:

dns.register('', 99)

Responses will be in a dictionary describing the newly created domain, same as
the `domain()` call above.

### Delete a domain

Careful with this one!


## Record operations

All operations on domain records are now supported:

* List records: `records(id_or_domainname)`
* Get record details: `record(id_or_domainname, record_id)`
* Add record: `add_record(id_or_domainname, data)`
* Update record: `update_record(id_or_domainname, record_id, data)`
* Delete record: `delete_record(id_or_domainname, record_id)`

### License

Licensed under the [MIT license](

Release History

This version
History Node


History Node


Download Files

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

File Name & Hash SHA256 Hash Help Version File Type Upload Date
(5.7 kB) Copy SHA256 Hash SHA256
Source Sep 1, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting