Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

Automatically download and upload data for the Numerai machine learning competition

Project description

Build Status codecov PyPI Docs

Numerai Python API

Automatically download and upload data for the Numerai machine learning competition.

This library is a Python client to the Numerai API. The interface is programmed in Python and allows downloading the training data, uploading predictions, and accessing user, submission and competitions information.

If you encounter a problem or have suggestions, feel free to open an issue.


pip install --upgrade numerapi


Some actions (like uploading predictions or staking) require a token to verify that it is really you interacting with Numerai’s API. These tokens consists of a public_id and secret_key. Both can be obtained by login in to and going to Account -> Custom API Keys.

# some API calls do not require logging in
napi = numerapi.NumerAPI(verbosity="info")
# download current dataset
# get competitions
all_competitions = napi.get_competitions()
# get leaderboard for the current round
leaderboard = napi.get_leaderboard()
# leaderboard for a historic round
leaderboard_67 = napi.get_leaderboard(round_num=67)
# check if a new round has started
if napi.check_new_round():
    print("new round has started wihtin the last 24hours!")
    print("no new round within the last 24 hours")

# provide api tokens
example_public_id = "somepublicid"
example_secret_key = "somesecretkey"
napi = NumerAPI(example_public_id, example_secret_key)

# upload predictions
submission_id = napi.upload_predictions("mypredictions.csv")
# check submission status

API Reference

Checkout the detailed API docs to learn about all available methods, parameters and returned values.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for numerapi, version 1.0.1
Filename, size File type Python version Upload date Hashes
Filename, size numerapi-1.0.1.tar.gz (10.8 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page