Pulse Documentation
Everything you need to build with Pulse market simulations.
Pulse is a market simulation API built by Simudyne. It provides agent-based Monte Carlo simulations for market impact analysis, execution algorithm testing, and stress scenario modeling.
What you can do
- Run Monte Carlo market simulations with calibrated agent models
- Test execution algorithms (TWAP, VWAP, CSS) under various conditions
- Simulate stress scenarios (flash crash, buy panic, selloff)
- Retrieve simulation output data (prices, execution schedules) from completed runs
- Discover available symbols and calibration dates
- Manage API keys programmatically
Quick example
python
from simudyne import PulseABM
client = PulseABM(api_key="pk_live_...")
# Free tier: browse cached simulations and download data
cached = client.simulation.list_cached()
sim_id = cached["simulations"][0]["example_sim_id"]
df = client.simulation.get_sim_data(sim_id)
print(df.head())For a step-by-step walkthrough see the Quickstart.
Get started with the Quickstart guide, or jump straight to Installation if you already have an API key.
Resources
- Plans: Free vs Pro — what's available on each tier
- Quickstart: up and running in 2 minutes
- Authentication: API keys and environment setup
- Available symbols: discover symbols and dates
- Simulations: cached sims, custom jobs, scenarios, and execution algorithms
- API key management: create, list, and revoke keys
Simulation data is returned as polars.DataFrame objects. If you're new to Polars, see the Polars documentation.