Skip to content

FlowKit for Analysts

It is recommended to use the FlowClient provided with FlowKit. Advanced users may want to create their own client interfacing to FlowAPI.


FlowClient is a client to FlowAPI written in Python for use with the JupyterLabs Notebook Python Data Science Stack. It can be installed using pip:

pip install flowclient

Example FlowClient usage

Documentation for FlowClient can be found here. Example usage of FlowClient to run daily location, modal location and flow queries is provided here, and worked examples are available here.


To connect FlowClient to FlowAPI, an access token must be generated using FlowAuth. Once an administrator has created a FlowAuth login for a user (see instructions here), that user can follow these steps to generate a token:

  1. Log into FlowAuth using the username and password created by the administrator.

  2. Optionally, click on the person icon (top right) and reset password.

  3. Select the server under "My Servers".

  4. Click the '+' icon to add a token, and give it a name (and optionally change the expiry and permissions). And Save.

  5. Click "COPY" to copy the token string, "DOWNLOAD" to download the token as a text file, or "VIEW" to display the token string.


AutoFlow is a tool to automate workflows consisting of Jupyter notebooks that interact with FlowKit. Use-cases include automatically producing a PDF report for each day of CDR data available in a FlowKit instance. Documentation for AutoFlow can be found here.


Advanced users may wish to write their own clients that interface directly to FlowAPI. This is discussed in more detail in the Developer section of these documents.