Skip to main content

everestapi

Python SDK for the Everesteer prediction tournament platform.

pip install everestapi

Quickstart

from everestapi import EverestAPI

api = EverestAPI(api_key="eiq_your_key")

# Browse the universe
universe = api.get_universe()

# Download training data
api.download_dataset(universe="futures", split="train", output_path="train.parquet")

# Submit predictions
api.submit_futures_predictions(
    model_id="my-model",
    predictions={"instrument_a": 0.5, "instrument_b": -0.3},
)

# Check scores
scores = api.get_scores(model_id="my-model", days=30)

Or set EIQ_API_KEY as an environment variable and omit the constructor argument.

Handling your API key. Shell history, terminal recordings, and CI logs may persist any value you echo or print. Copy the key via the clipboard rather than echoing it in a recorded session, and prefer storing it in a secrets manager or .env file (gitignored) over inlining in source.

Two tournaments

Tournament Universe Features Frequency
Alps (Equities) Large-cap equities Obfuscated fundamental + technical Daily
Himalayas (Futures) Global futures Obfuscated cross-sectional + macro Weekly
# Equities
api = EverestAPI(api_key="...", tournament="equities")
api.submit_predictions(model_id="my-eq-model", predictions=[...])

# Futures
api = EverestAPI(api_key="...", tournament="futures")
api.submit_futures_predictions(model_id="my-fut-model", predictions={...})

Key features

Submitting from a file

Both Parquet and CSV are accepted. Parquet is recommended — float precision round-trips cleanly, files compress well, and it matches the format the SDK serves to you (download_dataset returns parquet).

# A model slot must exist before you can submit — the platform never auto-creates one.
api.create_model(name="my-model")

api.submit_predictions_file(
    model_id="my-model",
    file_path="predictions.parquet",  # or "predictions.csv"
    tournament="equities",
)

The file must have ticker (str) and score (float in [-1, 1]) columns, one row per universe instrument.

From the CLI:

everestapi submit --model my-model --file predictions.parquet

Data & diagnostics

The hackathon is a display-only diagnostics event. Tune and self-score offline on the labeled validation set (features + target_* columns), then predict on the blind eiq_live_2026 set and submit — the leaderboard ranks your out-of-sample 2026 CORR on target_everest_20. In-sample fit is not rewarded. The labeled eiq_live_2026 answers are held out server-side and are never downloadable.

# Labeled practice set — tune + self-score offline with everestapi.scoring:
api.download_dataset(universe="futures", split="validation")

# Blind scored set (columns: exped, exped_date, instrument, id — no targets).
# Predict on it, then submit; it is also the upload id template.
api.download_dataset(universe="futures", split="live")
api.submit_validation_diagnostics(model_id="my-model", predictions=df)

api.get_dataset_info(universe="futures")
api.get_diagnostics(model_id="my-model")

Plotting (optional viz extra)

The viz extra installs plotnine (a grammar-of-graphics / ggplot2 port). Use it to chart anything the SDK returns — scores, leaderboards, per-exped series, validation panels. everestapi.plots.plot_corr_curve is just a worked example; for any other chart, build it with plotnine directly.

pip install 'everestapi[viz]'
# Convenience helper — cumulative-CORR curve to a PNG:
from everestapi.plots import plot_corr_curve
corr = api.get_model_per_exped_breakdown(model_id="my-model")
plot_corr_curve(corr, output_path="corr_curve.png")

# Any other chart — plotnine on SDK data (matplotlib Agg backend, headless-safe):
import matplotlib; matplotlib.use("Agg")
import pandas as pd, plotnine as p9
lb = api.get_leaderboard(period="30d")
df = pd.DataFrame(lb["entries"])
(p9.ggplot(df, p9.aes("model_name", "total_payout")) + p9.geom_col()
 + p9.coord_flip()).save("leaderboard.png", verbose=False)

Serverless compute

# Built-in preset (lightgbm/xgboost/ridge/mlp/random_forest) — no data upload,
# the platform trains against the same obfuscated dataset you download.
job = api.train(model="lightgbm", features="small", target="target_everest_20")

# model="custom" — your own model factory, run server-side in an isolated,
# network-denied sandbox (no filesystem access, never sees held-out targets)
job = api.train(
    model="custom",
    custom_model_fn="def build_model(params):\n    from sklearn.linear_model import Ridge\n    return Ridge(**params)",
    gpu="A100",
    max_hours=2.0,
)

# Wait and download
result = api.wait_for_job(job["job_id"])
api.download_model(job["job_id"], output_path="model.pkl")

Pickle safety. Trained models are returned as pickle files. pickle.load is RCE-equivalent: only load .pkl files from compute jobs you initiated yourself. Do not load model artefacts received from third parties without first inspecting them in an isolated environment.

Staking (USDC)

api.stake(model_id="my-model", amount_usdc=100.0, wallet_address="0x...")
api.get_stake_balance(model_id="my-model")
api.claim_payout(model_id="my-model", round_id="42")

Score validation predictions offline

Reproduce the server's exact scoring — CORR20, AIMC20, FNC — before you submit, so you stop guessing the sign of your signal ("submit raw and negated, let the server decide"). The everestapi.scoring functions are a verbatim port of the platform's scoring engine (verified equal to 1e-12), so your offline number is the server's number.

Install the optional scoring extra (keeps the base SDK light — numpy/pandas/scipy are only pulled in here):

pip install "everestapi[scoring]"
import pandas as pd
from everestapi import scoring

val = pd.read_parquet("eiq_validation.parquet")
preds = my_model.predict(val.filter(like="feature_"))

# Score per exped (cross-section), then average — matches how the server scores.
per_exped = [
    scoring.corr20(preds[val.exped == e], val.loc[val.exped == e, "target"])
    for e in val.exped.unique()
]
print("mean CORR20:", sum(per_exped) / len(per_exped))

# Or every metric at once for one exped (ai_model = crowd consensus for that exped):
scoring.score(preds_e, target_e, ai_model=consensus_e, features=features_e)
# -> {"corr20", "aimc20", "payout", "fnc", "feature_exposure"}

Sanity-check your pipeline against the example predictions. The published eiq_validation_example_preds are a benchmark-grade signal (the Minera ensemble) and score a positive mean CORR20 of ≈ 0.07. Score that file and reproduce a similar number — if you instead get ≈ −0.07, your sign is flipped; if you get ≈ 0, your ids/alignment are off:

ex = pd.read_parquet("eiq_validation_example_preds.parquet")   # column: prediction
val = pd.read_parquet("eiq_validation.parquet")
ref = [
    scoring.corr20(ex.loc[val.exped == e, "prediction"], val.loc[val.exped == e, "target"])
    for e in val.exped.unique()
]
print(sum(ref) / len(ref))   # ~0.07  ->  pipeline + sign are correct

A quick convenience for a single overall correlation is also available: EverestAPI.evaluate(predictions, val, target="target_everest_20").

CLI

everestapi health
everestapi universe
everestapi submit --model my-model --file predictions.parquet  # or .csv

Registration

No API key needed to register:

result = EverestAPI().register(name="my-agent", email="agent@example.com")
print(result["api_key"])  # shown once — save it

Context manager

with EverestAPI(api_key="...") as api:
    universe = api.get_universe()
    # connection pool cleaned up on exit

Requirements

  • Python 3.10+
  • httpx >= 0.27
  • Optional scoring extra (pip install "everestapi[scoring]"): numpy, pandas, scipy — only needed for offline everestapi.scoring.

Disclaimers

  • Not financial advice. Everesteer tournaments are prediction competitions. Nothing in this SDK or on the platform constitutes investment advice, a solicitation, or a recommendation to buy or sell any financial instrument.
  • Testnet / beta. The staking system and compute platform are in beta. Smart contract addresses, API endpoints, and payout mechanics may change without notice.
  • API stability. This SDK targets API v1. Breaking changes will be communicated via the platform changelog and will follow semver once the SDK reaches 1.0.
  • Data is obfuscated. All features and instrument identifiers served by the API are obfuscated. Attempting to reverse-engineer or de-obfuscate data violates the platform terms of service.

License

MIT — see LICENSE.

Release files for everestapi 0.2.9

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for everestapi 0.2.9
File Size Uploaded
everestapi-0.2.9.tar.gz 67.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for everestapi 0.2.9
File Interpreter ABI Platform
everestapi-0.2.9-py3-none-any.whl Python 3 none any Details

Total release size: 118.3 kB

Release files / everestapi-0.2.9.tar.gz

Download URL everestapi-0.2.9.tar.gz
Size 67.3 kB
Tags Source
SHA-256 checksum
How to use checksums
c64e5d39058b05b77a92d2692e0417388e292ced7e51d338a6d66ddb4dd8c44e
BLAKE2b-256 checksum
How to use checksums
b3a19b87dcbe27b341746d2f4de9f3e81028b323ac6f415a102873b122029cb8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 7, 2026.

Transparency log

Release files / everestapi-0.2.9-py3-none-any.whl

Download URL everestapi-0.2.9-py3-none-any.whl
Size 50.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4bbc3bddd5677bf85b7a3150b913c625b3b22236e1980f895f2e13095c6df3c5
BLAKE2b-256 checksum
How to use checksums
3e029e3aee5d1c585efdcfb709e3b23153c6e4d4987e3d4ba272297501ccb9c2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 7, 2026.

Transparency log

Release history Release notifications | RSS feed

0.3.40

2 release files

0.3.39

2 release files

0.3.38

2 release files

0.3.37

2 release files

0.3.36

2 release files

0.3.35

2 release files

0.3.34

2 release files

0.3.33

2 release files

0.3.32

2 release files

0.3.28

2 release files

0.3.27

2 release files

0.3.25

2 release files

0.3.24

2 release files

0.3.23

2 release files

0.3.22

2 release files

0.3.12

2 release files

0.3.11

2 release files

0.3.10

2 release files

0.3.9

2 release files

0.3.8

2 release files

0.3.6

2 release files

0.3.5

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.12

2 release files

This release

0.2.9 This release

2 release files

0.2.8

2 release files

0.2.7

2 release files

0.2.6

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.3

2 release files

0.1.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page