Package: hubspot3
A python wrapper around HubSpot's APIs,for python 3.8+.Built initially around hapipy, but heavily modified.Check out thedocumentation
here! (thanks readthedocs)Quick startNote: I'd recommend that you consider using theofficial HubSpot Python API. I no longer work at a company that uses HubSpot, and this library is a few versions behind on many of their APIs. I will be open to small PRs and usability fixes, but there will likely not be any further significant work on this libraryInstallation# install hubspot3pipinstallhubspot3Basic Usagefromhubspot3importHubspot3API_KEY="your-api-key"client=Hubspot3(api_key=API_KEY)# all of the clients are accessible as attributes of the main Hubspot3 Clientcontact=client.contacts.get_contact_by_email('testingapis@hubspot.com')contact_id=contact['vid']all_companies=client.companies.get_all()# new usage limit functionality - keep track of your API callsclient.usage_limits# <Hubspot3UsageLimits: 28937/1000000 (0.028937%) [reset in 22157s, cached for 299s]>client.usage_limits.calls_remaining# 971063Individual Clientsfromhubspot3.companiesimportCompaniesClientAPI_KEY="your-api-key"client=CompaniesClient(api_key=API_KEY)forcompanyinclient.get_all():print(company)Passing Paramsimportjsonfromhubspot3.dealsimportDealsClientdeal_id="12345"API_KEY="your_api_key"deals_client=DealsClient(api_key=API_KEY)params={"includePropertyVersions":"true"}# Note values are camelCase as they appear in the Hubspot Documentation!deal_data=deals_client.get(deal_id,params=params)print(json.dumps(deal_data))Command-line interfaceThere is also a command-line tool available. Install the extra
requirement for that tool via:pipinstallhubspot3[cli]and you can use it as a command:hubspot3--helpSee the Sphinx documentation for more details and explanations.Rate LimitingBe aware that this uses the HubSpot API directly, so you are subject to
all of theguidelines that HubSpot has in
place.at the time of writing, HubSpot has the following limits in place for
API requests:Free & Starter:10 requests per second250,000 requests per day.Professional & Enterprise:10 requests per second500,000 requests per day.This daily limit resets at midnight based on the time zone setting of
the HubSpot account. There is also an additional addon you can purchase
for more requests.Retrying API CallsBy default, hubspot3 will attempt to retry all API calls up to 2 times
upon failure.If you'd like to override this behavior, you can add anumber_retrieskeyword argument to any Client constructor, or to individual API calls.Extending the BaseClient - thanks@Guysoft!Some of the APIs are not yet complete! If you'd like to use an API that
isn't yet in this repo, you can extend the BaseClient class!importjsonfromhubspot3.baseimportBaseClientPIPELINES_API_VERSION="1"classPipelineClient(BaseClient):"""Lets you extend to non-existing clients, this example extends pipelines"""def__init__(self,*args,**kwargs):super(PipelineClient,self).__init__(*args,**kwargs)defget_pipelines(self,**options):params={}returnself._call("pipelines",method="GET",params=params)def_get_path(self,subpath):returnf"deals/v{self.options.get('version')orPIPELINES_API_VERSION}/{subpath}"if__name__=="__main__":API_KEY="your_api_key"a=PipelineClient(api_key=API_KEY)print(json.dumps(a.get_pipelines()))Advanced oauth2 token storage - thanks@sangaline!This is an example of how you can use theoauth2_token_getterandoauth2_token_setterkwargs on the client to use custom storage (in this case redis) so that multiple clients can share the same access/refresh tokens generated by the oauth2 requests.importaioredisfromhubspot3importHubspot3redis_client=awaitaioredis.create_redis_pool(url,db=db,encoding='utf-8',timeout=10)defoauth2_token_getter(token_type:str,client_id:str)->str:loop=asyncio.get_event_loop()key=f'hubspot-oauth2-tokens:{token_type}:{client_id}'returnloop.run_until_complete(redis_client.get(key))defoauth2_token_setter(token_type:str,client_id:str,token:str)->None:loop=asyncio.get_event_loop()key=f'hubspot-oauth2-tokens:{token_type}:{client_id}'# Token expiration is six hours, so match that when we store the tokens.# See: https://developers.hubspot.com/docs/methods/oauth2/refresh-access-tokenexpire_in_seconds=6*60*60loop.run_until_complete(redis_client.set(key,token,expire=expire_in_seconds))# This client will share oauth2 credentials with other clients configured in the same way.hubspot3_client=Hubspot3(access_token=access_token,client_id=client_id,client_secret=client_secret,refresh_token=refresh_token,oauth2_token_getter=oauth2_token_getter,oauth2_token_setter=oauth2_token_setter,)TestingI'm currently working on rewriting many of the tests withpytestto work against the public
API and ensure that we get the correct type of mock data back. These
tests are currently in averyearly state - I'll be working soon to
get them all built out.# Install required test packagespipinstallpytestpytest-cov# orpipinstall-rrequirements-dev.txt# run testsmake# ormaketest_all