read: market twin.

Reads one market twin, and the date to read it as of to The answer gives the twin: the model family and template it was instanced from, the participants placed on the chain, the level of every stock as of the date, the simulations run on it in order, and the strategy whose armed plays are its interventions

Request body#

The request body is MarketTwinInput.

Response#

The route returns a card whose body is MarketTwin. 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#

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 MarketTwinInput allows. The build validates it against the schema of MarketTwinInput.

curl -X POST https://api.scaleintelligence.co/v1/read/market_twin \
  -H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
  -H "content-type: application/json" \
  -d '{ "twin": "…" }'

import { client } from "@scale/sdk";
const answer = await client.read.market_twin({
    "twin": "…"
  });
// answer.body is a MarketTwin. answer.foot holds the basis, the scope and the time.

import requests
answer = requests.post("https://api.scaleintelligence.co/v1/read/market_twin",
    headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
    json={
      "twin": "…"
    }).json()

let answer: Card = client.post("https://api.scaleintelligence.co/v1/read/market_twin")
    .header("Scale-Key", key).header("Scale-Scope", "tenant/<id>")
    .json(&MarketTwinInput { /* the fields of the page */ }).send().await?.json().await?;

MCP tool#

The MCP tool si.read.market_twin takes the same input and returns the same card. The tool only reads data. An MCP host that renders cards draws this card from ui://scale-intelligence/cards/MarketTwin. The tool’s page describes it.

POST /v1/read/market_twin
Scale-Scope: …
Scale-As-True-On: …
Scale-As-Known-On: …
Scale-Key: …
content-type: application/json

{
  "twin": "…"
}