Skip to content

Latest commit

 

History

History
22 lines (16 loc) · 594 Bytes

client.rst

File metadata and controls

22 lines (16 loc) · 594 Bytes
Raw

API Client

:class:`~civis.APIClient` is a class for handling requests to the Civis API. An instantiated :class:`~civis.APIClient` contains a set of resources (listed below) where each resource is an object with methods. By convention, an instantiated :class:`~civis.APIClient` object is named client and API requests are made with the following syntax:

client = civis.APIClient()
response = client.resource.method(params)
.. currentmodule:: civis


.. autoclass:: civis.APIClient
   :inherited-members:


.. toctree::
   responses
   api_resources