Welcome to the Eureqa Python API!

The Eureqa Python API provides a way to automate the entire Eureqa modeling process. Use it to:

  • Connect to a data platform
  • Automate model creation
  • Generate summary reports
  • Integrate with other modeling tools
  • Deploy production models
  • and much more!

The Python API integrates seamlessly with your Eureqa SaaS or Eureqa On Prem environment – access data, models, and analyses built via the API in the Eureqa UI and vice versa.

Installation

Prerequisites

Install or Verify Python

The Eureqa API requires Python 2.7. Before getting started, verify your Python version or install it if you do not have it.

To verify your Python version in your terminal:

python --version

If Python is not installed, you can download it here: https://www.python.org.downloads

Install or Verify Pip

The Eureqa Python API is installed using pip. If you don’t have pip, follow the installation instructions here: https://pip.pypa.io/en/stable/installing/

Eureqa API Installation

Installing the Eureqa API

To install the Eureqa API, use your terminal to run:

pip install eureqa[=version]

You can find the correct version by opening Eureqa and going to Settings > Eureqa API

Upgrading or Downgrading the Eureqa API

To upgrade or downgrade the API, install again with the version specified, e.g.:

pip install eureqa[=version]

Note: pip does have “-upgrade” flag which will upgrade to the latest version. We recommend not using this flag and instead using the command above to install the specific version that you need.

Uninstalling the Eureqa API

To uninstall the Eureqa API:

pip uninstall eureqa

Connecting to Eureqa

To get started with the API, connect to Eureqa as follows:

Eureqa SaaS:

from eureqa import Eureqa

e = Eureqa(url='Eureqa URL', user_name='user name', password='password')

Where:

  • ‘Eureqa URL’ is the base URL used to connect to Eureqa (e.g. “https://rds.nutonian.com”)
  • ‘user name’ is your Eureqa user name (e.g. ”bob@nutonian.com”)
  • ‘password’ is the password for the user name (e.g. ”MyFav0ritePassword!”)

Note The password field will be deprecated in a coming release in favor of an access key that is obtained from your application adminstrator

Next Steps

Now that you have the Eureqa API installed and have successfully connected to Eureqa, get started uploading data, building models, generating reports and more.

Check out the Examples for sample code and the Eureqa API Reference for details on specific classes and functions.