Documentation

730 functions in 35 domains, each grouped by action verb. Open a domain to see its functions, or search them by name.

New here? Read how domains and verbs work, or filter everything in the API explorer.

Elements

13 domains · 259 functions

Node36 functionsThe most fundamental modeling primitive — beams, plates, and solids all connect to nodes and are defined from them. Loads on nodes live in Nodal Loads; node displacements are read here.Create 3 · Add 2 · Get 18 · Set/Assign 3 · Remove 2 · Delete 1 · Select 4 · Transform 2 · Is 1

Member35 functionsBar-type elements — STAAD.Pro calls them beams, but they model beams, columns, braces, and cables. Add, delete, split, renumber, and query incidences. Always analytical members; for physical members see Physical Member.Create 2 · Add 2 · Get 16 · Set/Assign 1 · Delete 1 · Select 5 · Transform 5 · Execute 1 · Is 2

Member Section & Material21 functionsLinks each member to a cross-section and a material, plus its beta angle — what the member is made of, not its shape in space. Sections are defined in the section domains; materials in Material.Create 4 · Get 13 · Set/Assign 2 · Remove 2

Member Specifications29 functionsMember behavior modifiers — end releases, offsets, and truss / tension-only / compression-only / cable / inactive specs. Changes how a member acts, not its geometry.Create 10 · Get 7 · Set/Assign 2 · Remove 8 · Delete 2

Member Fireproofing9 functionsFireproofing material and thickness on members — adds to self-weight for fire-rated assemblies; doesn’t change analytical stiffness.Create 1 · Get 7 · Remove 1

Create1

CreateMemberFireProofingSpec

Get7

Remove1

RemoveMemberFireProofingSpecFromBeam

Open the Member Fireproofing page

Member Attributes9 functionsUser-defined attributes and metadata attached to members for tagging and downstream workflows.Create 1 · Get 6 · Set/Assign 1 · Delete 1

Create1

CreateMemberAttribute

Get6

Set/Assign1

AssignMemberAttribute

Delete1

DeleteMemberAttribute

Open the Member Attributes page

Member Annotation7 functionsMember labels, highlighting, and annotation in the viewport. Visual only.Set/Assign 1 · View 6

Set/Assign1

SetBeamAnnotationMode

View6

Open the Member Annotation page

Plate30 functionsPlate/shell finite elements — add, delete, and query three- and four-node plate incidences. Thickness lives in Plate Thickness & Specifications; pressures in Plate Loads.Create 2 · Add 2 · Get 16 · Set/Assign 2 · Remove 2 · Delete 1 · Select 4 · View 1

Plate Thickness & Specifications17 functionsPlate thickness, material, and behavior specs (plane-stress, in-plane rotation, offsets) for shell elements.Create 5 · Get 7 · Set/Assign 2 · Remove 3

Create5

Get7

Set/Assign2

Remove3

Open the Plate Thickness & Specifications page

Plate Attributes5 functionsUser-defined attributes and metadata attached to plate elements.Create 1 · Get 2 · Set/Assign 1 · Delete 1

Create1

CreateElementAttribute

Get2

Set/Assign1

AssignElementAttribute

Delete1

DeleteElementAttribute

Open the Plate Attributes page

Solid (3D)27 functionsEight-node solid (brick) elements — geometry, material, and stress results. Loads on solids are applied through the load domains.Create 1 · Add 2 · Get 15 · Set/Assign 2 · Remove 1 · Delete 1 · Select 4 · View 1

Parametric Surface20 functionsParametric surfaces used to generate plate meshes — define, mesh, and query the surface, its regions, and density points.Create 2 · Add 5 · Get 8 · Set/Assign 3 · Remove 1 · View 1

Physical Member14 functionsGroups several analytical beams into one physical member, so a continuous column split by intermediate nodes is designed as a single unit.Create 1 · Get 8 · Set/Assign 1 · Delete 1 · Select 3

Create1

CreatePhysicalMember

Get8

Materials & sections

5 domains · 97 functions

Material20 functionsMaterial definitions (isotropic steel, concrete, aluminum, timber, or custom; 2D/3D orthotropic) — modulus, density, Poisson, thermal. Assigned to members, plates, and solids.Create 6 · Get 11 · Set/Assign 2 · Delete 1

Standard Table Sections27 functionsCross-sections from built-in country steel tables (AISC and others), plus tapered and profile properties. Assigned to members in Member Section & Material.Create 10 · Get 13 · Set/Assign 1 · Execute 2 · Is 1

Open the Standard Table Sections page

UPT Profiles20 functionsUser-Provided Table sections — custom cross-sections defined in a user table and referenced by members.Create 3 · Add 12 · Get 3 · Remove 2

Prismatic/General Sections8 functionsPrismatic/general sections defined by raw properties (area, Iy, Iz, J…) or simple shapes rather than a catalog profile.Create 5 · Get 3

Create5

Get3

Open the Prismatic/General Sections page

Section Query & Attributes22 functionsQuery section properties — area, moments of inertia, dimensions — for any assigned or table section.Get 17 · Set/Assign 3 · Remove 1 · Delete 1

Supports & groups

2 domains · 51 functions

Support41 functionsRestraints at nodes — fixed, pinned, roller, inclined, elastic, and mat supports — plus reading support reactions after analysis.Create 7 · Add 2 · Get 19 · Set/Assign 4 · Remove 7 · Delete 2

Create7

Add2

Get19

Set/Assign4

Remove7

Delete2

Open the Support page

Group10 functionsNamed collections of nodes, beams, plates, or solids for batch selection and assignment — an organizing tool, not a structural element.Create 2 · Get 5 · Set/Assign 1 · Delete 1 · Select 1

Create2

Get5

Set/Assign1

UpdateGroup

Delete1

DeleteGroup

Select1

SelectGroup

Open the Group page

Loads

7 domains · 129 functions

Load Cases39 functionsPrimary and reference load cases — the containers every applied load belongs to. Create and query cases before adding nodal, member, or plate loads.Create 4 · Add 2 · Get 24 · Set/Assign 5 · Remove 1 · Clear 2 · Is 1

Nodal Loads11 functionsLoads applied at nodes — joint forces and moments — plus the seismic definition and its joint, member, floor, and wall weights.Add 7 · Get 3 · Set/Assign 1

Add7

Get3

Set/Assign1

ModifySeismicDefinitionParams

Open the Nodal Loads page

Member Loads22 functionsLoads on members — uniform, concentrated, trapezoidal, linearly varying, fixed-end, area, and floor loads.Add 10 · Get 8 · Transform 2 · Execute 2

Plate Loads9 functionsPressure, trapezoidal, and hydrostatic loads on plates.Add 4 · Get 5

Add4

Get5

Open the Plate Loads page

Environmental Loads17 functionsWind, seismic, response-spectrum, notional, temperature, strain, and self-weight loads, with their definitions.Add 11 · Get 3 · Delete 1 · Execute 2

Add11

Get3

Delete1

DeleteWindDefinition

Execute2

Open the Environmental Loads page

Load Lists7 functionsThe active load list — which cases and combinations are active for the next command or query.Create 1 · Get 5 · Delete 1

Create1

CreateLoadList

Get5

Delete1

DeleteLoadList

Open the Load Lists page

Load Combinations24 functionsFactored combinations (e.g. 1.2D + 1.6L), automatic combinations, repeat loads, and min/max envelopes of load cases.Create 2 · Add 5 · Get 12 · Remove 1 · Delete 3 · Is 1

Analysis, results & design

5 domains · 76 functions

Analysis (Command)25 functionsRuns the solver — static, P-Delta, buckling, nonlinear, direct, and cable — and reports analysis status. Results are read in the results domains.Add 1 · Get 4 · Set/Assign 3 · Delete 6 · Execute 10 · Is 1

Member Results12 functionsPer-member results after analysis — end forces, intermediate forces and deflections, displacements, and max stresses. Read-only.Get 12

Get12

Open the Member Results page

Plate Results10 functionsPer-plate results after analysis — center and corner forces, moments, principal and von Mises stresses. Read-only.Get 10

Get10

Open the Plate Results page

Global Results11 functionsModel-wide results after analysis — mode frequencies, mass participation, buckling factors, and time-history response. Read-only.Get 9 · Is 2

Get9

Is2

Open the Global Results page

Design (Steel)18 functionsSteel code checks and design — assign design commands, groups, and parameters, then read design/check ratios. Runs after analysis.Create 2 · Get 11 · Set/Assign 4 · Is 1

Create2

Get11

Set/Assign4

Is1

IsMultipleMemberSteelDesignResultsAvailable

Open the Design (Steel) page

Interface & files

3 domains · 118 functions

View47 functionsDrives the STAAD.Pro viewport — views, zoom/pan/rotate, visibility, selection, and annotation. Visual only; it never changes the model.Create 2 · Get 7 · Set/Assign 12 · Select 3 · View 18 · Open 1 · Save 1 · Close 1 · Export 2

Table/Report28 functionsSTAAD.Pro report tables and sheets — create reports, read/write individual cells, and save them. Reporting output, not modeling.Create 1 · Add 1 · Get 7 · Set/Assign 14 · Delete 2 · Save 3

Session/File (Root)43 functionsThe STAAD.Pro session and file — create, open, save, and close .STD files, set active units, read job info, and trigger analysis from the top-level object.Get 26 · Set/Assign 9 · View 1 · Open 2 · Save 1 · Close 2 · Is 2

Open the Session/File (Root) page

Prefer a table?

The API explorer lists every function in one place, with filters by domain, verb and name, and the domain × verb matrix.

Explore the API

Documentation

Elements

Create3

Add2

Get18

Set/Assign3

Remove2

Delete1

Select4

Transform2

Is1

Create2

Add2

Get16

Set/Assign1

Delete1

Select5

Transform5

Execute1

Is2

Create4

Get13

Set/Assign2

Remove2

Create10

Get7

Set/Assign2

Remove8

Delete2

Create1

Get7

Remove1

Create1

Get6

Set/Assign1

Delete1

Set/Assign1

View6

Create2

Add2

Get16

Set/Assign2

Remove2

Delete1

Select4

View1

Create5

Get7

Set/Assign2

Remove3

Create1

Get2

Set/Assign1

Delete1

Create1

Add2

Get15

Set/Assign2

Remove1

Delete1

Select4

View1

Create2

Add5

Get8

Set/Assign3

Remove1

View1

Create1

Get8

Set/Assign1

Delete1

Select3

Materials & sections

Create6

Get11

Set/Assign2

Delete1

Create10

Get13