Simulator

Get a simulation draft

Fetch a stored simulation draft by ID. The account and project in the URL are the caller's own (any project the caller can view); the draft's visibility determines access:

  • A project-scoped draft returns payload together with the origin account_id and project_id when the caller can view the draft's origin project.
  • A shared draft returns payload only, with no origin information.
  • An unknown ID, an expired draft, and a project-scoped draft the caller cannot access all return the same 404, so draft IDs cannot be probed.

Learn more about Simulator draft links, including how to obtain a payload for an advanced setup from a draft created in the dashboard.

get/v2/account/{accountSlug}/project/{projectSlug}/simulation-drafts/{draftId}

Path parameters

accountSlugstring required

Account slug of the user

projectSlugstring required

Project slug of the account

draftIdstring uuid required

ID of the simulation draft (the resource_id returned on creation, and the draftId in a dashboard draft link)

Response

The stored draft.

account_idstring uuid

ID of the account that owns the project the draft was created in. Present only for project-scoped drafts, when the caller can view that project. Absent for shared drafts.

project_idstring uuid

ID of the project the draft was created in. Present only for project-scoped drafts, when the caller can view that project. Absent for shared drafts.

Example response

{
  "payload": {
    "v": 2,
    "network": {
      "id": "1"
    },
    "rows": [
      {
        "contractAddress": "0xdac17f958d2ee523a2206206994597c13d831ec7",
        "inputDataType": "raw",
        "rawFunctionInput": "0xa9059cbb000000000000000000000000ab5801a7d398351b8be11c439e05c5b3259aec9b00000000000000000000000000000000000000000000000000000000000f4240",
        "contractFunction": {
          "name": "transfer",
          "selector": "0xa9059cbb",
          "signature": "transfer(address,uint256)"
        },
        "from": "0xab5801a7d398351b8be11c439e05c5b3259aec9b",
        "stateOverrides": [
          {
            "contractAddress": "0x6b175474e89094c44da98b954eedeac495271d0f"
          }
        ],
        "fundAddress": {
          "targetAddress": "0xab5801a7d398351b8be11c439e05c5b3259aec9b",
          "tokens": [
            {
              "tokenAddress": "0x0000000000000000000000000000000000000000",
              "amount": "1000000000000000000"
            }
          ]
        }
      }
    ]
  },
  "account_id": "fa4a29af-ad72-44ac-9261-4bf3a8af3a06",
  "project_id": "aaf3c9e1-9632-4e6e-a900-b704db935f74"
}

Changes

Changed in 1 of the 4 revisions of this API.1