hubspot-api-python

Python HubSpot API v3 SDK(Client) files and sample apps

Sample Applications can be found in sample-apps folder

Documentation

See the API docs.

Installation

If you just want to use the package, run:

pip install --upgrade hubspot-api-client

Requirements

Make sure you have Python 3.4+ and pip installed.

Quickstart

Configuring HubSpot client

import hubspot

client = hubspot.Client.create()
# or with api_key
client = hubspot.Client.create(api_key='your_api_key')
# or with access_token
client = hubspot.Client.create()
client.access_token = 'your_access_token'

Requesting API endpoints

Obtain OAuth2 access token:

from hubspot.auth.oauth import ApiException

oauth_client = client.auth.oauth

try:
    tokens = oauth_client.default_api.create_token(
        grant_type="authorization_code",
        redirect_uri='http://localhost',
        client_id='client_id',
        client_secret='client_secret',
        code='code'
    )
except ApiException as e:
    print("Exception when calling create_token method: %s\n" % e)

Get contact by id:

from hubspot.crm.contacts import ApiException

contacts_client = client.crm.contacts

try:
    contact_fetched = contacts_client.basic_api.get_by_id('contact_id')
except ApiException as e:
    print("Exception when requesting contact by id: %s\n" % e)

Get all:

get_all method is available for all major objects and works like

all_contacts = contacts_client = client.crm.contacts.get_all()

Please note that pagination is used under the hood to get all results.

Using utils

from hubspot.utils.oauth import get_auth_url

auth_url = get_auth_url(
    scopes=('contacts',),
    client_id='client_id',
    redirect_uri='http://localhost'
)

Retry middleware

You can pass an instance of urllib3.util.retry.Retry class to configure http client retries. With internal error retry middleware:

import hubspot
from urllib3.util.retry import Retry

retry = Retry(
    total=3,
    backoff_factor=0.3,
    status_forcelist=(500, 502, 504),
)
client = hubspot.Client.create(retry=retry)

Or with rate limit retry middleware:

import hubspot
from urllib3.util.retry import Retry

retries = Retry(
    total=5,
    status_forcelist=(429,),
)
client = hubspot.Client.create(retries=retries)

Contributing

Install the package locally:

pip install -e .

Set up the development virtualenv:

make

Run tests:

make test