standalone.baseplate
standalone.baseplate API input reference#
The standalone.baseplate namespace is used to run base plate design checks. The normal workflow is to start a session and then submit a design object to the check function.
See also the related standalone design modules: standalone.foundation, standalone.member, and standalone.loads.
Current implementation notes:
- Concentric column, base plate, and foundation layout is accepted at the moment.
- Symmetric anchor layout is accepted at the moment.
- Anchor layout is dependent on the available patterns supported for the selected column shape and design code.
Request workflow#
Top-level input object#
The main request body passed to standalone.baseplate.check is a design_obj object containing the full base plate model definition.
Common properties#
| Key | Type | Description |
|---|---|---|
design_code | string | Design code identifier. Example values: American, Australian, Canadian, Europe. |
support_type | string | Support condition for the column base. Typical values: fixed, pinned. |
units_data | object | Unit system and conversion factors. |
project_details | object | Project metadata such as name, company, designer, and notes. |
steel_parts | object | Column, base plate, and concrete foundation geometry and material data. |
anchors | object | Anchor bolt layout, dimensions, and material data. |
welds | object | Weld geometry and material data. |
loads | array | Load cases containing axial, shear, and moment values. |
factors | object | Resistance and reduction factors used by the selected design code. |
detailing | object | Optional detailing checks and requirements. |
design_settings | object | Design assumptions and analysis options. |
version | integer | Input schema version. Use 2. |
units_data#
| Key | Type | Description |
|---|---|---|
first_init | boolean | Indicates whether this is the first initialization of the model. |
units | string | Unit system. Options: metric, imperial. |
units_length | string | Length unit. Options: mm, in. |
axial_f_units | string | Axial force unit. Options: kN, kips. |
units_strength | string | Concrete strength unit. Options: MPa, psi. |
units_strength_steel | string | Steel strength unit. Options: MPa, ksi. |
bending_f_units | string | Bending unit. Options: kN-m, kip-ft. |
length_factor | number | Scale factor for length conversions. |
strength_factor | number | Scale factor for strength conversions. |
strength_factor_steel | number | Scale factor for steel strength conversions. |
to_mm | number | Conversion to millimetres. |
to_in | number | Conversion to inches. |
kNm_Kipft | number | Conversion factor for bending units. |
kN_Kip | number | Conversion factor for force units. |
project_details#
| Key | Type | Description |
|---|---|---|
project_units | string | Unit system used in the project. Options: metric, imperial. |
company | string | Company name. |
designer | string | Designer name. |
project_name | string | Project name. |
project_id | string | Project identifier. |
project_notes | string | Additional notes. |
client | string | Client name. |
steel_parts#
The steel_parts.data object contains the column, base plate, and foundation geometry.
| Key | Type | Description |
|---|---|---|
custom-column-fy | number | Custom value for the column yield strength. Used when Custom is selected as the column material. |
custom-column-fu | number | Custom value for the column ultimate strength. Used when Custom is selected as the column material. |
custom-bp-fy | number | Base plate yield strength. |
custom-bp-fu | number | Base plate ultimate strength. |
custom-conc-fc | number | Concrete compressive strength. |
use-cracked-concrete | boolean | Whether cracked concrete behavior is assumed. |
steel-column-shape | string | Shape of the column. Accepts i-shape, pipe, rectangular. |
steel-column-database | string | Section database name. Must match the database name displayed in SkyCiv Section Builder. In the Europe workflow, both European and British section databases can be used. |
steel-column-profile | string | Selected section/profile name. Must match the profile name displayed in SkyCiv Section Builder. |
steel-column-material | string | Column steel grade/material. |
steel-column-height | number | Column height used in the Europe workflow. |
steel-baseplate-width | number | Base plate width. |
steel-baseplate-height | number | Base plate height. |
steel-baseplate-thickness | number | Base plate thickness. |
steel-baseplate-material | string | Base plate material grade. |
steel-baseplate-grouting-thickness | number | Grout thickness. |
grout-material-selected | string | Grout material selector used in the Europe workflow. Accepted values: less-than-30 for grout strength below 30 MPa, and greater-than-30 for grout strength of at least 30 MPa. |
steel-foundation-material | string | Foundation/concrete material. |
steel-foundation-width | number | Foundation width. |
steel-foundation-height | number | Foundation height. |
steel-foundation-thickness | number | Foundation thickness. |
List of column materials per design code#
- American:
A36,A53 grB,A500 grB,A500 grC,A501 grA,A501 grB,A529 gr50,A529 gr55,A709 gr36,A1043 gr36,A1043 gr50,A1085 grA,A572 gr42,A572 gr50,A572 gr55,A572 gr60,A572 gr65,A618 grI,A618 grII,A618 grIII,A709 gr50,A709 gr50S,A709 gr50W,A913 gr50,A913 gr60,A913 gr65,A913 gr70,A992,A1065 gr50,A242 gr42,A242 gr46,A242 gr50,A588,A847,A1065 gr50W,Custom - Australian:
- I-shape columns/beams:
AS/NZS 3679.1 Gr. 350,AS/NZS 3679.1 Gr. 300,Custom - Welded columns/beams:
AS/NZS 3679.2 Gr. 400,AS/NZS 3679.2 Gr. 350,AS/NZS 3679.2 Gr. 300,Custom - HSS sections:
AS/NZS 1163 Gr. C450,AS/NZS 1163 Gr. C350,AS/NZS 1163 Gr. C250,Custom
- I-shape columns/beams:
- Europe:
S235,S275,S355,S460,S275N,S355N,S420N,S460N,S275M,S355M,S420M,S460M,Custom - Canadian:
230G,350G,400G,260W,300W,350W,380W,400W,480W,550W,260WT,300WT,350WT,380WT,400WT,480WT,550WT,350R,350A,400A,480A,550A,350AT,400AT,480AT,550AT,700Q,700QT,Custom
List of base plate materials per design code#
- American:
A36,A283 grC,A283 grD,A529 gr50,A529 gr55,A709 gr36,A572 gr42,A572 gr50,A572 gr55,A572 gr60,A572 gr65,A709 gr50,A1043 gr36,A1043 gr50,A1066 gr50,A1066 gr60,A1066 gr65,A1066 gr70,A1066 gr80,A242 gr42,A242 gr46,A242 gr50,A588 gr42,A588 gr46,A588 gr50,A514 gr90,A514 gr100,A709 gr50W,A709 grHPS 50W,A709 grHPS 70W,A709 grHPS 100W,A852,Custom - Australian:
AS/NZS 1594 Gr. HA400,AS/NZS 1594 Gr. HW350,AS/NZS 1594 Gr. HA350,AS/NZS 1594 Gr. HA300/1,AS/NZS 1594 Gr. HU300/1,AS/NZS 1594 Gr. HA300,AS/NZS 1594 Gr. HU300,AS/NZS 1594 Gr. HA250,AS/NZS 1594 Gr. HU250,AS/NZS 1594 Gr. HA200,AS/NZS 1594 Gr. XF500,AS/NZS 1594 Gr. XF400,AS/NZS 1594 Gr. XF300,AS/NZS 3678 Gr. 450,AS/NZS 3678 Gr. 400,AS/NZS 3678 Gr. 350,AS/NZS 3678 Gr. WR350,AS/NZS 3678 Gr. 300,AS/NZS 3678 Gr. 250,AS/NZS 3678 Gr. 200,AS/NZS 3597 Gr. 500,AS/NZS 3597 Gr. 600,AS/NZS 3597 Gr. 700,Custom - Europe:
S235,S275,S355,S460,S275N,S355N,S420N,S460N,S275M,S355M,S420M,S460M,Custom - Canadian:
230G,350G,400G,260W,300W,350W,380W,400W,480W,550W,260WT,300WT,350WT,380WT,400WT,480WT,550WT,350R,350A,400A,480A,550A,350AT,400AT,480AT,550AT,700Q,700QT,Custom
List of foundation materials per design code#
- American (metric):
20.68,27.68,31.03,34.47,41.36,Custom - American (imperial):
3000,4000,4500,5000,6000,Custom - Australian:
N20,N25,N32,N40,N50,N65,N80,N100,S28,S65,Custom - Europe:
C12/15,C16/20,C20/25,C25/30,C30/37,C35/45,C40/50,C45/55,C50/60,C60/75,C70/85,C80/95,C90/105,Custom - Canadian (metric):
20.68,27.68,31.03,34.47,41.36,Custom
anchors#
The anchors.data object contains the anchor bolt arrangement.
| Key | Type | Description |
|---|---|---|
custom-anchor-fy | number | Custom anchor yield strength. Used when the selected anchor material is Custom. |
custom-anchor-fu | number | Custom anchor ultimate strength. Used when the selected anchor material is Custom. |
anchor-pattern | string | Anchor layout pattern. |
anchor-prop-diam | string | Anchor diameter. |
anchor-prop-material | string | Anchor material grade. |
anchor-thread-included | string | Thread inclusion option. Primarily used for American and Canadian design workflows. |
anchor-web-bending | string | Web-bending assumption for I-section columns with anchors near the web. Accepted values are web-bending and flange-bending. Not used for Europe. |
use-welded-plate-washers | boolean | Whether welded plate washers are used. Applicable to American, Australian, and Canadian design workflows. |
anchor-plate-washer-thickness | number | Welded plate washer thickness. Applicable to American, Australian, and Canadian design workflows, and relevant when use-welded-plate-washers is enabled. |
anchor-prop-length | number | Anchor embedment length. |
anchor-hole-clearance | string | Hole-clearance compliance option for anchors in the Europe workflow. Accepted values: no-clearance for holes without clearance, compliant for hole clearance that complies with code, and large for hole clearance that does not comply with code. |
anchor-prop-ending | string | Anchor end geometry. |
anchor-prop-side-dim | number | Embedded plate side dimension or diameter. Used when rectangle or circular embedment geometry is selected. |
anchor-prop-thk-dim | number | Embedded plate thickness. Used when rectangle or circular embedment geometry is selected. |
hook-direction | string | Hook orientation, such as inward. Only relevant when anchor-prop-ending is hook. |
anchor-prop-hook-length | number | Hook extension length. Only relevant when anchor-prop-ending is hook. |
anchor-numbers | number | Number of anchors per side for the selected pattern. |
anchor-numbers-z | number | Number of anchors in the Z direction. Used for patterns such as All Sides. |
anchor-numbers-y | number | Number of anchors in the Y direction. Used for patterns such as All Sides. |
anchor-spacing-z | number | Anchor spacing in the Z direction. |
anchor-spacing-y | number | Anchor spacing in the Y direction. |
anchor-edge-distance-z | number | Anchor distance from the base plate edge in the Z direction. |
anchor-edge-distance-y | number | Anchor distance from the base plate edge in the Y direction. |
line-anchor-edge-distance-z | number | Edge distance for line anchors in the Z direction. Used for patterns such as All Sides. |
line-anchor-edge-distance-y | number | Edge distance for line anchors in the Y direction. Used for patterns such as All Sides. |
Available anchor layout patterns by column shape#
- I-shape:
Four Corners,Flange Only,Web Only - Rectangular:
Four Corners,Top/Bottom Only,Left/Right Only,All Sides - Pipe:
Four Corners
Available anchor diameters by design code#
- American: metric
10,12,16,20,22,24,27,30,33,36or imperial3/8,1/2,5/8,3/4,7/8,1,1-1/8,1-1/4,1-3/8,1-1/2 - Australian:
M10,M12,M16,M20,M22,M24,M27,M30,M36,M39,M42,M48,M52 - Europe:
M6,M8,M10,M12,M16,M20,M24,M27,M30,M36,M39,M42,M45,M52 - Canadian:
12,16,20,22,24,27,30,36(metric-style values)
Available anchor materials by design code#
- American:
A307,A325,A490,A36,A193 Gr.B7 (105),A193 Gr.B7 (95),A193 Gr.B7 (75),A354 Gr.BC (109),A354 Gr.BC (99),A354 Gr.BD (130),A354 Gr.BD (115),A449 Gr.92,A449 Gr.81,A449 Gr.58,A572 Gr.42,A572 Gr.50,A572 Gr.55,A572 Gr.60,A572 Gr.65,A588 Gr.50,A588 Gr.46,A588 Gr.42,F1554 Gr.36,F1554 Gr.55,F1554 Gr.105,Custom - Australian:
4.6,8.8,HR8.8,HR10.9,Custom - Europe:
4.6,4.8,5.6,6.8,8.8,10.8,12.9,Custom - Canadian:
ASTM F1554 G36,ASTM F1554 G55,ASTM F1554 G105,ASTM A193,Custom
Accepted anchor end types by design code#
- American:
straight,rectangle,circular,hook - Australian:
straight,rectangle,circular(hook is not available) - Europe:
straight,rectangle,circular(hook is not available) - Canadian:
straight,rectangle,circular,hook
welds#
The welds.data object contains the weld input data.
| Key | Type | Description |
|---|---|---|
box-weld-size | number | Weld size used for hollow-section column welds. |
input_table_col_weld_size | array | Weld size table for I-shaped sections. For American and Canadian workflows, the weld sizes are expected to be uniform across the listed elements. |
custom-weld-fexx | number | Custom weld electrode strength. Used when welds-column-mat is Custom. |
use_welds_for_comp | string | Compression-transfer option for the column-to-base-plate connection. Accepted values are true and false. When set to true, compression is transferred through the welds only rather than through direct bearing of the column section on the base plate. |
as-weld-category | string | Weld category used in the Australian workflow. Accepted values: sp for Structural Purpose and gp for General Purpose. Default value: sp. See AS 4100:2020 Clause 9.6.1.3 for weld quality requirements. |
weld-type | string | Weld type. Accepted values include fillet and cjp. |
weld-setback | number | Weld setback distance, used to allow clearance near the fillet radius of I-shaped sections. |
welds-column-mat | string | Weld material grade. Accepted values depend on the selected design code. |
input_table_col_weld_size array format#
Each item in input_table_col_weld_size is an array with the following structure:
| Index | Type | Description |
|---|---|---|
0 | number | Row identifier. |
1 | string | Connection element name, such as Top Flange, Bottom Flange, or Web. |
2 | string | Weld side selection. Use Both. |
3 | number | Weld size for that element. |
Example:
Available weld material grades by design code#
These are the API values used by welds-column-mat.
- American:
E60xx,E70xx,E80xx,E90xx,E100xx,E110xx,E120xx,Custom - Australian:
430,490,550,620,690,760,830,Custom - Europe:
E35,E38,E42,E46,E50,Custom - Canadian:
E43XX,E49XX(-X),E55XX-X,E62XX-X,E69XX-X,E76XX-X,E83XX-X,Custom
loads#
The loads array contains load cases. Each item typically includes:
| Key | Type | Description |
|---|---|---|
lc | string | Load case label. |
Mz | string | Moment about the Z-axis (strong-axis bending). Units follow bending_f_units, such as kN-m or kip-ft. |
My | string | Moment about the Y-axis (weak-axis bending). Units follow bending_f_units, such as kN-m or kip-ft. This input is reserved for future weak-axis moment design support and is not currently used in the standard workflow. |
Nx | string | Axial force. Positive values represent compression and negative values represent tension. Units follow axial_f_units such as kN or kips. |
Vz | string | Shear force in the Z direction (weak-axis shear). Units follow axial_f_units such as kN or kips. Use positive or negative values to control direction. |
Vy | string | Shear force in the Y direction (strong-axis shear). This is the strong-axis shear input. Units follow axial_f_units such as kN or kips. Use positive or negative values to control direction. |
moment_label | string | Calculation case to use, determined based on the given load values. Leave blank to allow the calculation case to be determined automatically. |
factors#
The factors object contains code-specific resistance, reduction, and analysis factors. The required keys depend on design_code.
American factor keys#
| Key | Type | Default | Reference | Description |
|---|---|---|---|---|
concrete_bearing_factor | number | 0.65 | AISC / LRFD | Resistance factor for concrete bearing strength. |
steel_bearing_factor | number | 0.75 | AISC / LRFD | Resistance factor for steel bearing strength. |
steel_flexure_factor | number | 0.90 | AISC / LRFD | Resistance factor for steel flexural strength in the base plate check. |
weld_factor | number | 0.75 | AISC / LRFD | Resistance factor for weld strength. |
steel_tension_factor | number | 0.90 | AISC / LRFD | Resistance factor for steel tension strength. |
steel_shear_rupture_factor | number | 0.75 | AISC / LRFD | Resistance factor for steel shear rupture strength. |
anchor_tension_factor | number | 0.75 | ACI | Resistance factor for anchor steel tension strength. |
anchor_shear_factor | number | 0.65 | ACI | Resistance factor for anchor steel shear strength. |
anchor_bolts_factor | number | 0.75 | AISC / LRFD | Resistance factor for anchor bolt strength checks. |
concrete_tension_factor | number | 0.7 | ACI | Resistance factor for concrete tension-related anchor checks. |
concrete_shear_factor | number | 0.65 | ACI | Resistance factor for concrete shear-related anchor checks. |
concrete_normal_weight_factor | number | 1 | ACI | Modification factor for normal-weight concrete behavior. |
Australian factor keys#
| Key | Type | Default | Reference | Description |
|---|---|---|---|---|
concrete_compression_factor | number | 0.60 | AS 3600:2018 | Reduction factor for concrete compression strength. |
steel_bending_factor | number | 0.90 | AS 4100:2020 | Reduction factor for steel bending strength. |
steel_tension_factor | number | 0.90 | AS 4100:2020 | Reduction factor for steel tension strength. |
steel_shear_factor | number | 0.90 | AS 4100:2020 | Reduction factor for steel shear strength. |
weld_factor | number | 0.80 | AS 4100:2020 | Reduction factor for weld strength. |
bolt_in_tension_factor | number | 0.80 | AS 5216:2021 | Reduction factor for bolts or anchors in tension. |
concrete_failure_factor | number | 0.6667 | AS 5216:2021 | Reduction factor for anchor-related concrete failure modes. |
prying_factor | number | 1 | AS 5216:2021 | Prying increase factor applied in the connection analysis. |
custom_lever_arm | number | 0 | AS 5216:2021 Clause 4.2.2.4 | User-defined lever arm value. Leave as 0 to use the automatic lever arm calculation. |
k7_factor | string | ductile | AS 5216:2021 Clause 7.2.2.2 | Ductility classification for anchor steel shear failure. Accepted values: ductile for $k_7 = 1.0$ and non-ductile for $k_7 = 0.8$. |
restraint_factor | string | no-restraint | AS 5216:2021 Clause 4.2.2.4 | Degree-of-restraint selection for fastener shear checks. Accepted values: no-restraint, full-restraint. |
Canadian factor keys#
| Key | Type | Default | Reference | Description |
|---|---|---|---|---|
concrete_factor | number | 0.65 | CSA A23.3:19 | Resistance factor for concrete strength. |
steel_factor | number | 0.90 | CSA S16:19 | Resistance factor for steel yielding strength. |
steel_ultimate_factor | number | 0.75 | CSA S16:19 | Resistance factor for steel ultimate strength. |
weld_factor | number | 0.67 | CSA S16:19 | Resistance factor for weld strength. |
anchor_rod_factor | number | 0.85 | CSA A23.3:19 | Resistance factor for anchor rod strength under CSA A23.3 checks. |
anchor_rod_s16_factor | number | 0.67 | CSA S16:19 | Resistance factor for anchor rod strength under CSA S16 checks. |
concrete_normal_weight_factor | number | 1 | CSA A23.3:19 | Modification factor for normal-weight concrete behavior. |
anchors_in_tension_factor | number | 0.8 | CSA A23.3:19 | Resistance factor for anchors in tension. This value is updated automatically when the steel-governed resistance-modification classification is changed, unless a custom value is provided. |
anchors_in_shear_factor | number | 0.75 | CSA A23.3:19 | Resistance factor for anchors in shear. This value is updated automatically when the steel-governed resistance-modification classification is changed, unless a custom value is provided. |
anchors_in_concrete_failures_factor_tension | number | 1 | CSA A23.3:19 | Resistance factor for anchor-related concrete failure modes in tension. This value is updated automatically when the concrete-governed resistance-modification classification is changed, unless a custom value is provided. |
anchors_in_concrete_failures_factor_shear | number | 1 | CSA A23.3:19 | Resistance factor for anchor-related concrete failure modes in shear. This value is updated automatically when the concrete-governed resistance-modification classification is changed, unless a custom value is provided. |
r_factor_steel | string | ductile | CSA S16:19 / CSA A23.3:19 | Steel-governed resistance-modification classification. Accepted values: ductile, brittle, custom. The default steel-governed anchor tension and shear factors are updated when this selection is changed. |
r_factor_concrete | string | condition_b | CSA A23.3:19 | Concrete-governed resistance-modification classification. Accepted values: condition_a, condition_b, custom. The default concrete-failure tension and shear factors are updated when this selection is changed. |
Europe factor keys#
| Key | Type | Default | Reference | Description |
|---|---|---|---|---|
concrete_factor | number | 1.5 | EN 1992-1-1:2004 Table 2.1N; EN 1992-4:2018 Table 4.1 | Partial safety factor for concrete. |
bending_factor | number | 1.0 | EN 1993-1-8:2005 Table 2.1; EN 1993-1-1:2005 Clause 6.1 | Partial safety factor for steel cross-section bending resistance. |
anchor_shear_factor | number | 1.5 | EN 1992-4:2018 Table 4.1 | Partial safety factor for anchor shear resistance when not computed directly. |
weld_factor | number | 1.25 | EN 1993-1-8:2005 Table 2.1 | Partial safety factor for weld resistance. |
custom_lever_arm | number | 0 | EN 1992-4:2018 Clause 6.2.2.3(3) | User-defined lever arm value. Leave as 0 to use the automatic lever arm calculation. |
concrete_alpha_factor | number | 1.5 | SCI P358, p. 241 | Default diffusion coefficient used when the concrete diffusion factor must be assumed. |
concrete_beta_factor | number | 0.66667 | EN 1993-1-8:2005 Clause 6.2.5(7) | Assumed foundation joint material coefficient beta. |
concrete_alpha_cc_factor | number | 1.0 | EN 1992-1-1:2004 Clause 3.1.6 | Assumed long-term effects coefficient alpha_cc for concrete compressive strength. |
concrete_theta_factor | number | 90 | User assumption | Assumed loaded sector angle theta for circular columns. Maximum value is $180^\circ$. |
exposure_class | string | xc4 | Eurocode durability checks | Eurocode exposure-class selection for durability checks. Accepted values: x0, xc1, xc2_xc3, xc4, xd1_xs1, xd2_xs2, xd3_xs3. |
structural_class | string | s4 | Eurocode durability checks | Eurocode structural-class selection for durability checks. Accepted values: s1, s2, s3, s4, s5, s6. |
countersunk | string | no | EN 1993-1-8:2005 Table 3.4 | Indicates whether countersunk anchors are assumed for anchor rod resistance. Accepted values: yes, no. |
cut_threads | string | no | EN 1993-1-8:2005 Clause 3.6.1(3) | Indicates whether anchor threads comply with EN 1090 requirements. Accepted values: yes, no. |
k7_factor | string | ductile | EN 1992-4:2018 Clause 7.2.2.3.1(2) | Ductility classification for anchor steel shear failure. Accepted values: ductile for $k_7 = 1.0$ and non-ductile for $k_7 = 0.8$. |
k8_factor | number | 2 | EN 1992-4:2018 Clause 7.2.2.4(2); ETAG-001 Annex C Clause 5.2.3.3 | Pryout factor k8 used in anchor shear pryout checks. |
restraint_factor | string | no-restraint | EN 1992-4:2018 Clause 6.2.2.3(3) | Degree-of-restraint selection for fastener shear checks. Accepted values: no-restraint, full-restraint. |
design_situation | string | permanent | Eurocode partial safety factors | Design-situation selection. Accepted values: permanent, accidental. Changing this selection updates the default concrete_factor. |
elastic_modulus_steel | number | 210000 | User input | Elastic modulus of steel, in MPa. |
elastic_modulus_concrete | number | 33000 | User input | Elastic modulus of concrete, in MPa. |
rotational_stiffness_lower | number | 2 | AISC 360-22 Commentary B3 Section 4 | Lower limit of rotational stiffness, expressed as a multiplier on $EI/L$. |
rotational_stiffness_upper | number | 30 | EN 1993-1-8:2005 Clause 5.2.2.5(2) | Upper limit of rotational stiffness, expressed as a multiplier on $EI/L$. |
detailing#
The detailing object contains boolean flags for optional detailing checks.
Detailing keys#
| Key | Type | Description |
|---|---|---|
weld_size | boolean | Enables the weld-size detailing check. The provided weld size is checked against the minimum and maximum values required by the selected design code. |
anchor_clearance | boolean | Enables the anchor-clearance detailing check. The anchor layout is checked for sufficient clearance to place washers and tighten nuts, considering nearby welds and adjacent geometry. |
bp_edge_distance | boolean | Enables the base-plate edge-distance detailing check. The minimum edge distance from the anchor to the base plate edge is checked against the selected design code. |
embed_plate | boolean | Enables the embedded-plate dimension check when anchor-prop-ending is rectangle or circular. The embedded plate width or diameter is checked against a suggested minimum of four times the anchor diameter. |
concrete_splitting | boolean | Enables the concrete-splitting detailing checks. Minimum anchor spacing and minimum concrete cover are checked to reduce the risk of concrete splitting. This check is not applied in the Australian workflow. |
min_anchors | boolean | Enables the minimum-anchor-count check. A total of at least four anchors is recommended. |
design_settings#
The design_settings object contains analysis assumptions and calculation options.
These settings can materially change the design results. They should only be changed with review and approval from a suitably qualified engineer.
Design setting keys#
| Key | Type | Description |
|---|---|---|
neglect_concrete_breakout_for_tension | boolean | When true, the concrete breakout check for anchor tension is neglected. This should only be used when steel reinforcement designed for adequate load transfer is present and that reinforcement is checked separately. |
neglect_concrete_breakout_for_shear | boolean | When true, the concrete breakout check for anchor shear is neglected. This should only be used when steel reinforcement designed for adequate load transfer is present and that reinforcement is checked separately. |
neglect_concrete_pryout | boolean | When true, the shear pryout check is neglected for slender anchors with $h_{ef} > 12d$. When false, the pryout check is performed regardless of anchor slenderness. |
distribute_shear_to_all | boolean | Controls how anchor shear is distributed. When true, shear is distributed to all anchors and the code-based distributed-shear cases are applied. When false, shear is distributed only to anchors closest to the edge, which is more conservative. Primarily used for American and Canadian workflows. |
simplified_approach_shear | boolean | Controls the anchor steel shear method. For American, enabling this uses the simplified ACI-based approach with grout-pad reduction where applicable; disabling it checks combined shear and axial stress. For Canadian, enabling this applies the CSA A23.3 method that ignores grout pad thickness in anchor-rod bending and applies a shear-strength reduction. |
consider_both_directions | boolean | When true, both the parallel and perpendicular directions to the applied moment are considered when checking base-plate flexural capacity against concrete bearing and anchor tension. When false, only the parallel direction is considered. Used in the Canadian workflow. |
include_embedded_head_radius | boolean | When true, the additional capacity from the embedded head or plate radius is included by projecting the concrete breakout surface beyond the effective perimeter. Used in Australian and Canadian workflows. |
use_sci_for_welds | boolean | When true, the SCI P398 approach is used for weld calculations involving moment loads. When false, the Eurocode 3 approach is used. Used in the Europe workflow. |
AISC example#
Australian example#
CSA example#
EN example#
Notes for implementation#
- Use the sample payloads as the starting point for each supported design code.
- Keep the same top-level structure for every request so the API integration remains consistent.
- The main differences between code-specific samples are in the
factors,design_settings, and the steel/anchor property values.