Quickstart

Get up and running with Pulse in under 2 minutes.

This guide walks you through installing the SDK, authenticating, and making your first data request. All new accounts start on the Free tier, which gives you access to a set of pre-run cached simulations to explore straight away.

1. Create an account

Go to pulse.simudyne.com and create an account using email, GitHub, or Google.

2. Get an API key

After signing in, go to your Dashboard and click Create new key. Copy the key as it is only shown once.

Store your API key securely. You can create multiple keys and label them for different use cases (e.g. "research", "production").

3. Install the SDK

bash
pip install git+https://github.com/simudyne/pulse-api.git

Requires Python 3.10 or later.

4. Browse cached simulations

On the Free tier, you have access to pre-run baseline simulations for 700.HK (Tencent) and 9999.HK (NetEase) across two dates and two scenarios. Use list_cached() to see what's available.

python
from simudyne import PulseABM

client = PulseABM(api_key="pk_live_...")

# List all available cached simulations
cached = client.simulation.list_cached()
for sim in cached["simulations"]:
    print(f"{sim['symbol']} {sim['date']} {sim['scenario']}: {sim['n_runs']} runs")

5. Download simulation data

python
# Pick a cached simulation
cached = client.simulation.list_cached(symbol="700.HK", scenario="normal")
sim_id = cached["simulations"][0]["example_sim_id"]

# Download as a Polars DataFrame
df = client.simulation.get_sim_data(sim_id)
print(df.head())

# Download mid-price by minute
mid_df = client.simulation.get_sim_data(sim_id, "mid_price_by_min.parquet")

On the Pro tier, use client.simulation.run() to submit custom simulation jobs with your own symbols, scenarios, and execution algorithms. See Simulations for details.

Next steps

Installation→