---
title: "Get Simulation Spatial Profile"
method: GET
path: "/simulations/{simulation_id}/spatial-profile"
tags: ["Simulations"]
---

# Get Simulation Spatial Profile

`GET /simulations/{simulation_id}/spatial-profile`

## Request

- Base URL: `https://api.ionworks.com`
- URL: `https://api.ionworks.com/simulations/{simulation_id}/spatial-profile`
- Auth: none declared

Evaluate a one-dimensional spatial field from stored solution chunks.

## Path parameters

- `simulation_id` string, uuid, required

## Query parameters

- `variable` string, required
- `max_time_points` integer

## Response `200`

Successful Response

- SpatialProfile: A time-dependent scalar field on a one-dimensional PyBaMM mesh.
  - `variable` string, required: Evaluated PyBaMM variable name.
  - `coordinate_name` string, required: Spatial coordinate used for the profile.
  - `coordinates` number[], required: One-dimensional mesh coordinates in metres.
  - `times` number[], required: Stored simulation times in seconds.
  - `values` array[], required: Field values indexed as values[time][position].
    - number[]
  - `domains` string[]: Ordered PyBaMM domains along the coordinate.
  - `domain_boundaries` number[]: Internal boundaries between adjacent domains in metres.

## Other responses

- `422`: Validation Error

## Changes

- **2026-09-30** `ea3d377fec1a`: 1 breaking
  - for the `path` request parameter `simulation_id`, the format changed from no format to `uuid`

[Operation history](https://skmtc.dev/ionworks/apis/ionworks-api/changes/simulations/:simulation_id/spatial-profile/get.md)

---

[API](https://skmtc.dev/ionworks/apis/ionworks-api.md) - [All operations](https://skmtc.dev/ionworks/apis/ionworks-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ionworks/apis/ionworks-api/revisions/abebbbc5f60a?raw)