---
title: "work: simulate market"
description: "Runs one systems model template over a market, with the interventions to try and the bounds of the run to The call returns the simulation as work, then the frame that holds what it reached"
section: reference
address: /reference/work/simulate_market
contract: 0476e35e6e275db5
---
# work: simulate market
Runs one systems model template over a market, with the interventions to try and the bounds of the run to The call returns the simulation as work, then the frame that holds what it reached
[figure: The caller sends MarketSimulationInput to /v1/work/simulate_market. The platform returns a card whose body is MarketSimulation.]
POST/v1/work/simulate_marketa task, 202
Simulate a market. The call needs the brand rung under a token with the work grant, and it is served by the platform.
The route takes [MarketSimulationInput](/concepts/marketsimulationinput) and returns a card whose body is [MarketSimulation](/concepts/marketsimulation).
## Request body
The request body is [MarketSimulationInput](/concepts/marketsimulationinput).
| field | type | required | note |
|---|---|---|---|
| `template` | [SystemsModelTemplate](/concepts/systemsmodeltemplate) | yes | |
| `vertical` | `id` | yes | |
| `segment` | `id` | no | |
| `brand` | `id` | no | |
| `interventions` | [Intervention](/concepts/intervention) | yes | |
| `horizon` | `duration` | no | the template's when absent |
| `samples` | `count` | no | the parameter's when absent |
| `seed` | `count` | no | |
## Response
The route returns a card whose body is [MarketSimulation](/concepts/marketsimulation). Every card ends with a foot that states the basis of each number, the scope of the call, and the time when the facts were true. This route runs as a long step and returns a task with status 202. `POST /v1/work/status` returns the task's progress, and `POST /v1/work/cancel` stops the task.
## Headers
| header | required | meaning |
|---|---|---|
| `Scale-Scope` | yes | the scope the call runs in: tenant/, then /brand/, then /strategy/ |
| `Scale-As-True-On` | no | the date the facts must have been true on; defaults to now |
| `Scale-As-Known-On` | no | the date the facts must have been known on; defaults to now |
| `Scale-Key` | no | for a change, the key made from the input; a repeat under the same key returns the unit held and writes nothing |
A caller needs the brand rung and a token with the work grant. The platform serves this route.
## Example
The example sends the smallest body that MarketSimulationInput allows. The build validates it against the schema of MarketSimulationInput.
Example
```sh
curl -X POST https://api.scaleintelligence.co/v1/work/simulate_market \
-H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/" \
-H "content-type: application/json" \
-d '{ "template": "…", "vertical": "…", "interventions": [] }'
```
```typescript
import { client } from "@scale/sdk";
const answer = await client.work.simulate_market({
"template": "…",
"vertical": "…",
"interventions": []
});
// answer.body is a MarketSimulation. answer.foot holds the basis, the scope and the time.
```
```python
import requests
answer = requests.post("https://api.scaleintelligence.co/v1/work/simulate_market",
headers={"Scale-Key": KEY, "Scale-Scope": "tenant/"},
json={
"template": "…",
"vertical": "…",
"interventions": []
}).json()
```
```rust
let answer: Card = client.post("https://api.scaleintelligence.co/v1/work/simulate_market")
.header("Scale-Key", key).header("Scale-Scope", "tenant/")
.json(&MarketSimulationInput { /* the fields of the page */ }).send().await?.json().await?;
```