---
title: "economics: estimate"
description: "`EstimateReturnInput`: the buyer (an entity, a lead, a buyer profile or a session), the offering or tier, the stated numbers, and whether to simulate to a `Card` whose body is a `FrameOfASale`"
section: reference
address: /reference/economics/estimate
contract: 0476e35e6e275db5
---
# economics: estimate
`EstimateReturnInput`: the buyer (an entity, a lead, a buyer profile or a session), the offering or tier, the stated numbers, and whether to simulate to a `Card` whose body is a `FrameOfASale`
[figure: The caller sends EstimateReturnInput to /v1/economics/estimate. The platform returns a card whose body is SaleFrame.]
POST/v1/economics/estimate
Si.economics.estimate. The call needs the tenant rung under a token with the read grant, and it is served by either, by the size bound.
The route takes [EstimateReturnInput](/concepts/estimatereturninput) and returns a card whose body is [SaleFrame](/concepts/saleframe).
## Request body
The request body is [EstimateReturnInput](/concepts/estimatereturninput).
| field | type | required | note |
|---|---|---|---|
| `buyer` | [UnitRef](/concepts/unitref) | yes | |
| `offering` | `id` | no | |
| `tier` | `text` | no | |
| `stated` | `{text:json}` | no | driver name to value, each written as a stated number before the estimate reads it |
| `simulate` | `bool` | yes | |
## Response
The route returns a card whose body is [SaleFrame](/concepts/saleframe). 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 tenant 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 EstimateReturnInput allows. The build validates it against the schema of EstimateReturnInput.
Example
```sh
curl -X POST https://api.scaleintelligence.co/v1/economics/estimate \
-H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/" \
-H "content-type: application/json" \
-d '{ "buyer": { "id": "…", "kind": "…" }, "simulate": false }'
```
```typescript
import { client } from "@scale/sdk";
const answer = await client.economics.estimate({
"buyer": {
"id": "…",
"kind": "…"
},
"simulate": false
});
// answer.body is a SaleFrame. answer.foot holds the basis, the scope and the time.
```
```python
import requests
answer = requests.post("https://api.scaleintelligence.co/v1/economics/estimate",
headers={"Scale-Key": KEY, "Scale-Scope": "tenant/"},
json={
"buyer": {
"id": "…",
"kind": "…"
},
"simulate": false
}).json()
```
```rust
let answer: Card = client.post("https://api.scaleintelligence.co/v1/economics/estimate")
.header("Scale-Key", key).header("Scale-Scope", "tenant/")
.json(&EstimateReturnInput { /* the fields of the page */ }).send().await?.json().await?;
```