🚀 Engineer the Future with the new SPACE GASS API (COMING SOON!)

Getting Started
Examples
Guides
API Reference

Authentication Service Automation File Handling Running Analysis Filtering & Querying Bulk Operations Error Handling API Versioning Licensing

powered by Zudoku

Guides

Filtering & Querying

Most API endpoints support query parameters for filtering, and all query result endpoints support pagination. This guide covers the common patterns.

Filtering Entities

Structure endpoints like nodes, members, and sections support query parameters to narrow down results.

Getting a Single Entity

Access any entity by its Id using the indexer (C#) or by_id (Python):

Querying Analysis Results

After running an analysis, query endpoints return results in a flat, efficient format. All query endpoints support optional filters for load case and entity key.

Node Reactions

Filtering by Load Case and Node

Filter values use SG list format — a string of comma-separated Ids and dash-separated ranges (e.g. "1,3-7,10"). Pass an empty string or omit the parameter to return all results.

Member Intermediate Forces

Grouped results like member forces use a columnar layout — the parent object contains the case and member keys, with force values as parallel arrays indexed by station.

Buckling Load Factors

Natural Frequencies

Steel Design Check Summary

Pagination

All query endpoints support offset and limit for pagination. By default all results are returned. Use pagination for large result sets.

Last modified on May 9, 2026

Running Analysis Bulk Operations

On this page

Filtering Entities
Getting a Single Entity
Querying Analysis Results
Pagination

// Get nodes within a coordinate range
var filtered = await client.Job.Structure.Nodes.GetAsync(
    config =>
    {
        config.QueryParameters.MinX = 0;
        config.QueryParameters.MaxX = 100;
        config.QueryParameters.Limit = 50;
    });

var node = await client.Job.Structure.Nodes[1].GetAsync();
Console.WriteLine($"Node {node.Id}: ({node.X}, {node.Y}, {node.Z})");

var result = await client.Job.Query.Analysis.Static.NodeReactions.GetAsync();

foreach (var r in result.Results)
{
    Console.WriteLine($"Case {r.Case}, Node {r.Node}: " +
        $"Fx={r.Fx}, Fy={r.Fy}, Fz={r.Fz}");
}

var result = await client.Job.Query.Analysis.Static.NodeDisplacements
    .GetAsync(config =>
    {
        config.QueryParameters.Cases = "1,3";
        config.QueryParameters.Nodes = "10-12";
    });

var result = await client.Job.Query.Analysis.Static.MemberIntermediateForces
    .GetAsync(config =>
    {
        config.QueryParameters.Members = "1";
    });

foreach (var m in result.Results)
{
    Console.WriteLine($"Case {m.Case}, Member {m.Member}:");
    for (int i = 0; i < m.Station.Length; i++)
    {
        Console.WriteLine($"  Station {m.Station[i]}: " +
            $"Fx={m.Fx[i]}, Fy={m.Fy[i]}, Mz={m.Mz[i]}");
    }
}

var result = await client.Job.Query.Analysis.Buckling.LoadFactors.GetAsync();

foreach (var b in result.Results)
{
    Console.WriteLine($"Case {b.Case}, Mode {b.Mode}: " +
        $"Factor={b.LoadFactor}, Tolerance={b.Tolerance}");
}

var result = await client.Job.Query.Analysis.Dynamic.NaturalFrequencies
    .GetAsync();

foreach (var f in result.Results)
{
    Console.WriteLine($"Case {f.Case}, Mode {f.Mode}: " +
        $"{f.NaturalFrequency} Hz (period {f.NaturalPeriod}s)");
}

var result = await client.Job.Query.Design.SteelMember.CheckSummary.GetAsync();

foreach (var s in result.Results)
{
    Console.WriteLine($"Member {s.Member}: {s.Section} — " +
        $"{s.Failure} (factor {s.LoadFactor}, case {s.CriticalCase})");
}

// Get the first 100 node displacements
var page1 = await client.Job.Query.Analysis.Static.NodeDisplacements
    .GetAsync(config =>
    {
        config.QueryParameters.Offset = 0;
        config.QueryParameters.Limit = 100;
    });

// Get the next 100
var page2 = await client.Job.Query.Analysis.Static.NodeDisplacements
    .GetAsync(config =>
    {
        config.QueryParameters.Offset = 100;
        config.QueryParameters.Limit = 100;
    });