---
title: "read: simulation frame"
description: "Reads the frame of one simulation to The answer gives the trajectory of every stock, the gain of every loop, the sensitivity to every intervention, and the set of options that compares strategies laid over the same template"
section: reference
address: /reference/read/simulation_frame
contract: 0476e35e6e275db5
---
# read: simulation frame
Reads the frame of one simulation to The answer gives the trajectory of every stock, the gain of every loop, the sensitivity to every intervention, and the set of options that compares strategies laid over the same template
[figure: The caller sends SimulationFrameInput to /v1/read/simulation_frame. The platform returns a card whose body is MarketSimulationFrame.]
POST/v1/read/simulation_frame
Read a simulation's frame. The call needs the brand rung under a token with the read grant, and it is served by either, by the size bound.
The route takes [SimulationFrameInput](/concepts/simulationframeinput) and returns a card whose body is [MarketSimulationFrame](/concepts/marketsimulationframe).
## Request body
The request body is [SimulationFrameInput](/concepts/simulationframeinput).
| field | type | required | note |
|---|---|---|---|
| `simulation` | `id` | yes | |
## Response
The route returns a card whose body is [MarketSimulationFrame](/concepts/marketsimulationframe). 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.
## 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 read grant. The platform or the desktop app serves this route.
## Example
The example sends the smallest body that SimulationFrameInput allows. The build validates it against the schema of SimulationFrameInput.
Example
```sh
curl -X POST https://api.scaleintelligence.co/v1/read/simulation_frame \
-H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/" \
-H "content-type: application/json" \
-d '{ "simulation": "…" }'
```
```typescript
import { client } from "@scale/sdk";
const answer = await client.read.simulation_frame({
"simulation": "…"
});
// answer.body is a MarketSimulationFrame. answer.foot holds the basis, the scope and the time.
```
```python
import requests
answer = requests.post("https://api.scaleintelligence.co/v1/read/simulation_frame",
headers={"Scale-Key": KEY, "Scale-Scope": "tenant/"},
json={
"simulation": "…"
}).json()
```
```rust
let answer: Card = client.post("https://api.scaleintelligence.co/v1/read/simulation_frame")
.header("Scale-Key", key).header("Scale-Scope", "tenant/")
.json(&SimulationFrameInput { /* the fields of the page */ }).send().await?.json().await?;
```