Skip to main content

Sexy Infusionsoft XML-RPC API client

Project description

A simple-to-use Infusionsoft XML-RPC API client, with included stubs for code sense. Python 3.5+ only (but pull requests welcome :smirk:).


pip install infusionsoft-client


First, initialize the client with your app name and API key:

import infusionsoft
infusionsoft.initialize('myapp', '098f6bcd4621d373cade4e832627b4f6')

And use the infusionsoft like a regular xmlrpc.client.ServerProxy:

import infusionsoft
contact_id = infusionsoft.ContactService.add({'FirstName': 'Johnny'})

Setting XML-RPC Client Options

Any extra kwargs passed to initialize() will be passed along to xmlrpc.client.ServerProxy.

import infusionsoft
infusionsoft.initialize('myapp', '098f6bcd4621d373cade4e832627b4f6', use_builtin_types=True)

Some kwargs of interest are:

  • use_builtin_types: whether to utilize native Python types, rather than wrappers such as xmlrpc.client.DateTime or xmlrpc.client.Binary. I recommend turning this on. It will be turned on by default in the next major/breaking release.
  • verbose: set to True to print out the request and response bodies for each RPC call.
  • allow_none: whether to allow None to be sent over the wire. Infusionsoft, in general, doesn’t allow None (which is nil in XML-RPC parlance). If a field in a response is null, Infusionsoft will simply not send it.
  • retries: number of times to retry failed requests. Requests are retried on connection/socket errors, and “InvalidConfig” faults (if you’ve never seen them, I envy you). Any other type of fault will still raise an exception.

See the docs for more info.

Usage with Django

infusionsoft-client includes a Django integration out of the box. Just add it to your INSTALLED_APPS:

    # ...

And add your app name and API key to your settings:

INFUSIONSOFT_API_KEY = '098f6bcd4621d373cade4e832627b4f6'

Pass extra configuration to the XML-RPC client with INFUSIONSOFT_CLIENT_OPTIONS:

    'use_builtin_types': True,

Getting All Rows of a Query

Some API calls are paginated, and require multiple calls to retrieve all results. This can be a pain, and you may find yourself writing the same code over and over. To this end, infusionsoft-client provides a consume() generator function, which will consume all pages of any query function.

To use it, create a lambda (or regular) function taking page and limit as arguments which performs your paginated API call, and pass it to consume():

import infusionsoft
from infusionsoft.query import consume

query_fn = lambda page, limit: (
    infusionsoft.DataService.query('mytable', limit, page, ['Id']))

# Use with a for-loop, to avoid storing all rows in memory:
for row in consume(query_fn):

# Or retrieve all rows at once
all_rows = list(consume(query_fn))

Generate Code Stubs

Shipped with infusionsoft-client is code to download the official Infusionsoft XML-RPC docs, parse them with BeautifulSoup, and generate Python 3.5-compatible stubs for all methods.

To generate these yourself, first install the extra requirements:

pip install -r stub-requirements.txt

Then run the generate_stubs() function, which will return a string:

from infusionsoft.gen_stubs import generate_stubs
source = generate_stubs()

Project details

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
infusionsoft-client-1.5.1.tar.gz (18.8 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page